Overview
Prev	Solar_Sql_Model_Params_Eager	Next

Overview

A value-object to represent the various parameters available when eager- fetching related records in a model fetch() call.

Package

This class is part of the Solar_Sql_Model package.

Inheritance:

Solar_Base
- Solar_Struct
  - Solar_Sql_Model_Params
    - Solar_Sql_Model_Params_Eager

Configuration Keys

data: Key-value pairs.

Constants

None.

Public Properties

The Solar_Sql_Model_Params_Eager 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_Eager 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.
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.

Prev	Up	Next
Solar_Sql_Model_Params_Eager	Home	Configuration