Doctrine_manual-1-2-en

Chapter 26: Utilities 342
$pager->getPage();
// Defines a new current page (need to call execute again to adjust
offsets and values)
$pager->setPage($page);
// Return the next page
$pager->getNextPage();
// Return the previous page
$pager->getPreviousPage();
// Return the first indice of current page
$pager->getFirstIndice();
// Return the last indice of current page
$pager->getLastIndice();
// Return true if it's necessary to paginate or false if not
$pager->haveToPaginate();
// Return the maximum number of records per page
$pager->getMaxPerPage();
// Defined a new maximum number of records per page (need to call execute
again to adjust offset and values)
$pager->setMaxPerPage($maxPerPage);
// Returns the number of itens in current page
$pager->getResultsInPage();
// Returns the Doctrine_Query object that is used to make the count
results to pager
$pager->getCountQuery();
// Defines the counter query to be used by pager
$pager->setCountQuery($query, $params = null);
// Returns the params to be used by counter Doctrine_Query (return
$defaultParams if no param is defined)
$pager->getCountQueryParams($defaultParams = array());
// Defines the params to be used by counter Doctrine_Query
$pager->setCountQueryParams($params = array(), $append = false);
// Return the Doctrine_Query object
$pager->getQuery();
// Return an associated Doctrine_Pager_Range_* instance
$pager->getRange($rangeStyle, $options = array());
Controlling Range Styles
There are some cases where simple paginations are not enough. One example situation is
when you want to write page links listings. To enable a more powerful control over pager,
there is a small subset of pager package that allows you to create ranges.
----------------- Brought to you by