dmBridge PHP API
DMAbstractQuery Class Reference
Inheritance diagram for DMAbstractQuery:

Public Member Functions

Protected Member Functions

Protected Attributes


Detailed Description


Member Function Documentation

DMAbstractQuery::addCollection ( DMCollection collection)
Parameters:
DMCollectioncollection DMCollection to which the search should be limited. This will be overridden if an object is specified with setObject().

Definition at line 52 of file DMAbstractQuery.php.

DMAbstractQuery::addObject ( DMObject obj)
Parameters:
DMObjectobj An object to which the search should be limited. This will override any collections to which the search should be limited.

Definition at line 155 of file DMAbstractQuery.php.

DMAbstractQuery::addPredicate ( DMQueryPredicate predicate)
Parameters:
DMQueryPredicatepredicate

Definition at line 187 of file DMAbstractQuery.php.

Referenced by setPredicates().

DMAbstractQuery::getCollections ( )
Returns:
array Array of DMCollection objects to which the search should be limited. This will be overridden if an object is specified with setObject().

Definition at line 43 of file DMAbstractQuery.php.

Referenced by DMPDODataStore::getCommentsForQuery(), DMPDODataStore::getTagsForQueryAsCounts(), DMPDODataStore::getTagsForQueryAsObjects(), UNLVSpatialQuery::getURI(), DMTagQuery::getURI(), DMObjectQuery::getURI(), and DMCommentQuery::getURI().

DMAbstractQuery::getLimit ( )

Alias of getNumResultsPerPage().

Returns:
int

Definition at line 92 of file DMAbstractQuery.php.

Referenced by getNumResultsPerPage(), and DMTagQuery::getURI().

DMAbstractQuery::getObjects ( )
Returns:
array Array of DMObjects to which the search should be limited. This will override any collections to which the search should be limited.

Definition at line 163 of file DMAbstractQuery.php.

Referenced by DMPDODataStore::getCommentsForQuery(), DMPDODataStore::getTagsForQueryAsCounts(), DMPDODataStore::getTagsForQueryAsObjects(), DMTagQuery::getURI(), and DMCommentQuery::getURI().

DMAbstractQuery::getPredicates ( index = null)
DMAbstractQuery::getSortFields ( )
Returns:
Associative array of field-direction pairs, e.g. "title" => "asc" or "descri" => "desc"

Definition at line 229 of file DMAbstractQuery.php.

Referenced by DMPDODataStore::getCommentsForQuery(), DMPDODataStore::getTagsForQueryAsCounts(), and DMPDODataStore::getTagsForQueryAsObjects().

DMAbstractQuery::getStart ( )
Returns:
int

Definition at line 244 of file DMAbstractQuery.php.

DMAbstractQuery::onlyCount ( )
Returns:
boolean Whether the query should retrieve only the count of results

Definition at line 83 of file DMAbstractQuery.php.

DMAbstractQuery::setCollections ( array $  collections)
Parameters:
arraycollections Array of DMCollection objects to which the search should be limited. This will be overridden if an object is specified with setObject().
Exceptions:
DMIllegalArgumentException

Definition at line 62 of file DMAbstractQuery.php.

DMAbstractQuery::setLimit ( limit)
Parameters:
intlimit

Definition at line 99 of file DMAbstractQuery.php.

Referenced by setNumResultsPerPage().

DMAbstractQuery::setNumResults ( int) [protected]
Parameters:
intint Total number of results in the result set

Definition at line 131 of file DMAbstractQuery.php.

Referenced by DMFavoriteQuery::__construct(), DMCommentQuery::getSearchResults(), DMTagQuery::getSearchResultsAsCounts(), and DMTagQuery::getSearchResultsAsObjects().

DMAbstractQuery::setNumResultsPerPage ( rpp)
Parameters:
intrpp Results per page
Deprecated:
Use setLimit() instead.

Reimplemented in DMObjectQuery.

Definition at line 147 of file DMAbstractQuery.php.

DMAbstractQuery::setOnlyCount ( bool)
Parameters:
boolbool Whether the query should retrieve only the count of results

Definition at line 107 of file DMAbstractQuery.php.

DMAbstractQuery::setPage ( int)
Parameters:
intint

Definition at line 177 of file DMAbstractQuery.php.

DMAbstractQuery::setPredicates ( array $  predicates)
Parameters:
arraypredicates Array of DMQueryPredicate objects
Exceptions:
DMIllegalArgumentException

Definition at line 207 of file DMAbstractQuery.php.

DMAbstractQuery::setSortFields ( array $  fields)
Parameters:
arrayfields Associative array of field-direction pairs, e.g. "title" => "asc" or "descri" => "desc"

Reimplemented in DMObjectQuery.

Definition at line 237 of file DMAbstractQuery.php.

DMAbstractQuery::unsetCollections ( )
Returns:
void

Definition at line 75 of file DMAbstractQuery.php.

DMAbstractQuery::unsetPredicates ( )
Returns:
void

Definition at line 221 of file DMAbstractQuery.php.

Referenced by setPredicates().


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables