Overview
Prev	Solar_Sql_Model_Params_Fetch	Next

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:

Solar_Base
- Solar_Struct
  - Solar_Sql_Model_Params
    - Solar_Sql_Model_Params_Fetch

Configuration Keys

data: Key-value pairs.

Constants

None.

Public Properties

The Solar_Sql_Model_Params_Fetch 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_Fetch 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.
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.

Prev	Up	Next
Solar_Sql_Model_Params_Fetch	Home	Configuration