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.

alias()

Sets the alias to use for this eager or fetch.

bind()

Adds named-placeholder values to bind to the resulting fetch query.

cache()

Should the fetch attempt use cached results when available?

cacheKey()

When fetching from and saving to the cache, what key should be used?

cloneForKeeps()

Returns a clone with only the joins we keep for native selects (i.e., for page counts and for the native-by-select strategy in relateds).

cols()

Adds new columns to the existing list of columns.

count()

Countable: how many keys are there?

countPages()

Should the fetch issue a followup query to count the total number of records and pages?

distinct()

Should the fetch use a SELECT DISTINCT?

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.

getCacheKey()

Returns the cache key being used for this fetch.

getCacheKeyForCount()

Returns the cache key being used for "count pages" on this fetch.

getIterator()

IteratorAggregate: returns an external iterator for this struct.

getKeys()

Returns all the keys for this struct.

group()

Adds GROUP BY columns to the fetch.

having()

Adds a HAVING condition to the fetch, optionally with a value to bind to the condition.

isDirty()

Is the struct dirty?

join()

Adds a single arbitrary JOIN to the fetch.

limit()

Sets a LIMIT COUNT and OFFSET on the fetch.

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.

order()

Adds ORDER BY columns to the fetch.

page()

Sets which page number of records the fetch should return.

paging()

Sets the number of rows-per-page on the fetch.

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.

where()

Adds a WHERE condition to the fetch, optionally with a value to bind to the condition.

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.