dmBridge PHP API
DMQuery Interface Reference

A generic query interface that all queries should implement. More...

Inheritance diagram for DMQuery:

Public Member Functions


Detailed Description

A generic query interface that all queries should implement.

A query may query CONTENTdm(R), the dmBridge data store, or something else. An abstract implementation of this interface is provided in DMAbstractQuery.

Author:
Alex Dolski <alex.dolski@unlv.edu> http://www.opensource.org/licenses/mit-license.php

Definition at line 17 of file DMQuery.php.


Member Function Documentation

DMQuery::getNumPages ( )
Returns:
int The number of pages of results. Available only after the query has finished executing.
DMQuery::getNumResults ( )
Returns:
int The number of results.
DMQuery::getPage ( )
Returns:
int

Referenced by DMTagQuery::getURI().

DMQuery::getSearchResults ( )

Executes the query and returns the result set.

Returns:
array Array of unspecified types

Implemented in UNLVSpatialQuery, DMCommentQuery, DMFavoriteQuery, DMObjectQuery, and DMTagQuery.

DMQuery::getStart ( )
Returns:
int The starting index of the current page of the result set, derived from the current page and the number of results per page.

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

DMQuery::setNumResultsPerPage ( int)
Parameters:
intint The number of results to be retrieved per page.

Implemented in DMObjectQuery.

DMQuery::setPage ( page)
Parameters:
intpage

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