Doctrine_manual-1-2-en

Chapter 26: Utilities 344
Listing
26-11
Listing
26-12
// Retrieves the range around the current page
// In our example, we are using sliding style and we are at page 1
$pages = $pager_range->rangeAroundPage();
// Outputs: [1][2][3][4][5]
echo '['. implode('][', $pages) .']';
If you build your Doctrine_Pager inside the range object, the API gives you enough power
to retrieve information related to Doctrine_Pager_Range subclass instance:
// Return the Pager associated to this Pager_Range
$pager_range->getPager();
// Defines a new Doctrine_Pager (automatically call _initialize protected
method)
$pager_range->setPager($pager);
// Return the options assigned to the current Pager_Range
$pager_range->getOptions();
// Returns the custom Doctrine_Pager_Range implementation offset option
$pager_range->getOption($option);
// Check if a given page is in the range
$pager_range->isInRange($page);
// Return the range around the current page (obtained from Doctrine_Pager
// associated to the $pager_range instance)
$pager_range->rangeAroundPage();
Advanced layouts with pager
Until now, we learned how to create paginations and how to retrieve ranges around the
current page. To abstract the business logic involving the page links generation, there is a
powerful component called Doctrine_Pager_Layout. The main idea of this component is to
abstract php logic and only leave HTML to be defined by Doctrine developer.
Doctrine_Pager_Layout accepts 3 obrigatory arguments: a Doctrine_Pager instance, a
Doctrine_Pager_Range subclass instance and a string which is the URL to be assigned as
{%url} mask in templates. As you may see, there are two types of "variables" in
Doctrine_Pager_Layout:
Mask
A piece of string that is defined inside template as replacements. They are defined as
{%mask_name} and are replaced by what you define in options or what is defined internally
by Doctrine_Pager_Layout component. Currently, these are the internal masks available:
• {%page} Holds the page number, exactly as page_number, but can be overwritable
by addMaskReplacement() to behavior like another mask or value
• {%page_number} Stores the current page number, but cannot be overwritable
• {%url} Available only in setTemplate() and setSelectedTemplate() methods.
Holds the processed URL, which was defined in constructor
----------------- Brought to you by