Overview

A value-object to represent the various parameters for specifying a model fetch() call.

Package

This class is part of the Solar_Sql_Model package.

Inheritance:

Configuration Keys

  • data: Key-value pairs.

Constants

None.

Public Properties

The Solar_Sql_Model_Params class has no public properties; try the list of all properties.

Public Methods

These are all the public methods in the Solar_Sql_Model_Params class.

You can also view the list of all public, protected, and private methods.

__clone()

Performs a "deep" clone of objects in the data.

__construct()

Constructor.

__destruct()

Default destructor; does nothing other than provide a safe fallback for calls to parent::__destruct().

__get()

Gets a data value.

__isset()

Does a certain key exist in the data?

__set()

Sets a key value and marks the struct as "dirty".

__toString()

Returns a string representation of the object.

__unset()

Sets a key in the data to null.

alias()

Sets the alias to use for this eager or fetch.

cols()

Adds new columns to the existing list of columns.

count()

Countable: how many keys are there?

dump()

Convenience method for getting a dump the whole object, or one of its properties, or an external variable.

eager()

Adds a new related eager-fetch (with options) to the params.

free()

Frees memory used by this struct.

getIterator()

IteratorAggregate: returns an external iterator for this struct.

getKeys()

Returns all the keys for this struct.

isDirty()

Is the struct dirty?

load()

Loads this params object with an array or struct.

locale()

Looks up class-specific locale strings based on a key.

offsetExists()

ArrayAccess: does the requested key exist?

offsetGet()

ArrayAccess: get a key value.

offsetSet()

ArrayAccess: set a key value.

offsetUnset()

ArrayAccess: unset a key.

toArray()

Returns a copy of the struct as an array, recursively descending to convert child structs into arrays as well.

toString()

Returns a string representation of the struct.



Local