Methods

Public

__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.

addCondition()

Sets the join condition to use; note that this overrides the existing join condition.

alias()

Sets the alias to use for this eager or fetch.

cols()

Adds new columns to the existing list of columns.

colsPrefix()

Sets the column-prefix to use when selecting 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?

joinFlag()

Sets the join flag; i.e., whether or not this eager should be used to control which parent records are selected.

joinOnly()

Whether or not this is a "join-only"; in a join-only, the eager is joined, but no rows are selected.

joinType()

Sets the join type to use (null, 'left', or 'inner').

load()

Loads this params object with an array or struct.

locale()

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

merge()

Sets the merge type to use ('client' or 'server').

nativeBy()

Should native records be selected by "WHERE IN (...)" a list of IDs, or by a sub-SELECT?

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.

whereinMax()

When automatically choosing a "native-by" strategy, the maximum number of records to use a "WHERE IN (...)" for; past this amount, use a sub- SELECT.

Protected

_buildConfig()

Builds and returns the default config for a class, including all configs inherited from its parents.

_exception()

Convenience method for returning exceptions with localized text.

_free()

Recursively descends and calls free() on child structs.

_load()

Loads this params object with an array of data using support methods.

_loadOne()

Calls one-argment methods to load $data elements.

_loadTwo()

Calls two-argment methods to load $data elements.

_postConfig()

A hook that activates after _buildConfig() in the constructor.

_postConstruct()

Post-construction tasks to complete object construction.

_preConfig()

A hook that activates before _buildConfig() in the constructor.

_setIsDirty()

Marks the struct as dirty.

_toArray()

Support method for toArray().

Private

None.