Doctrine_manual-1-2-en

Chapter 26: Utilities 340
Chapter 26
Utilities
Listing
26-1
Pagination
Introduction
In real world applications, display content from database tables is a commom task. Also,
imagine that this content is a search result containing thousands of items. Undoubtely, it will
be a huge listing, memory expensive and hard for users to find the right item. That is where
some organization of this content display is needed and pagination comes in rescue.
Doctrine implements a highly flexible pager package, allowing you to not only split listing in
pages, but also enabling you to control the layout of page links. In this chapter, we'll learn
how to create pager objects, control pager styles and at the end, overview the pager layout
object - a powerful page links displayer of Doctrine.
Working with Pager
Paginating queries is as simple as effectively do the queries itself. Doctrine_Pager is the
responsible to process queries and paginate them. Check out this small piece of code:
// Defining initial variables
$currentPage = 1;
$resultsPerPage = 50;
// Creating pager object
$pager = new Doctrine_Pager(
Doctrine_Query::create()
->from( 'User u' )
->leftJoin( 'u.Group g' )
->orderby( 'u.username ASC' ),
$currentPage, // Current page of request
$resultsPerPage // (Optional) Number of results per page. Default is
25
);
Until this place, the source you have is the same as the old Doctrine_Query object. The only
difference is that now you have 2 new arguments. Your old query object plus these 2
arguments are now encapsulated by the Doctrine_Pager object. At this stage,
Doctrine_Pager defines the basic data needed to control pagination. If you want to know
that actual status of the pager, all you have to do is to check if it's already executed:
----------------- Brought to you by