Using Pagination with Symfony and Doctrine 2

When I blogged Using Pagination with Symfony and Doctrine I had being trying to understand the inner working of the Symfony's Admin Generator. At the time it seem a good solution. But, when I started implementing the idea, I realized that I had to repeat very similar code on each of the of the actions of the modules I was working.
So I decided to try a different aproach. I put all de code I was using in the actions in a utility class, created a widget to render the header and added a partial to render how many items in the table and the total number of pages. The final goal was to create my first Symfony plugin, but I'm not quite there yet, so I decided to blog first this improvement.
The Pagination Control
Since it's the same control I proposed in my previous blog Using Pagination with Symfony and Doctrine I will not repeat the code. You still need to get the images for buttons and place them in your web\images folder.
The Pagination Info Control
Create a file named /myproject/apps/myapplication/templates/_pagination_info.php and copy the following code on it. Then save it.

<div class="pagination_info">
<?php echo format_number_choice('[0] no result|[1] 1 result|(1,+Inf] %1% results',
array('%1%' => $pager->getNbResults()), $pager->getNbResults(), 'sf_admin') ?>
<?php if ($pager->haveToPaginate()): ?>
<?php echo __('(page %%page%%/%%nb_pages%%)', array('%%page%%' => $pager->getPage(),
'%%nb_pages%%' => $pager->getLastPage()), 'sf_admin') ?>
<?php endif; ?>
</div>

Creating the Paging Utility
Create a file named /myproject/lib/model/PagingUtility.class.php and copy the following code on it. Then save it.
This class will take care of all the code previously had to copy into the actions.

class PagingUtility {
private $modelname;
private $sortkey;
private $user;
private $modulename;

public function  __construct($modelname, $user) {
$this->modelname=$modelname;
$this->user =$user;
$this->sortkey =strtolower($this->modelname).".sort";
$this->modulename = strtolower($this->modelname) . "_module";
}

public function buildPager($request, $items_x_page,$query=NULL){
 if ($request->getParameter('sort') && $this->isValidSortColumn(
                $request->getParameter('sort'))) {
    $this->setSort(array($request->getParameter('sort'),
        $request->getParameter('sort_type')));
}

//        $items_x_page = sfConfig::get('app_max_items_x_page');
$pager = new sfDoctrinePager($this->modelname, $items_x_page);
//$device = is_null($coffeeMaker) ? "hands" : $coffeeMaker;
$query = is_null($query) ? $this->buildQuery() : $query;
$pager->setQuery($query);
$pager->setPage($request->getParameter('page', 1));
$pager->init();
return $pager;
//        $this->sort = $this->getSort();
}
protected function buildQuery() {
$et = Doctrine_Core::getTable($this->modelname);

$query = $et->createQuery();

$this->addSortQuery($query);

return $query;
}

protected function addSortQuery($query) {
if (array(null, null) == ($sort = $this->getSort())) {
    return;
}

if (!in_array(strtolower($sort[1]), array('asc', 'desc'))) {
    $sort[1] = 'asc';
}
$query->addOrderBy($sort[0] . ' ' . $sort[1]);
}

public  function getSort() {
if (null !== $sort = $this->user->getAttribute($this->sortkey,
                null, $this->modulename)) {
    return $sort;
}

$this->setSort(array(null, null));

return $this->user->getAttribute($this->sortkey,
                null, $this->modulename);
}

protected function setSort(array $sort) {
if (null !== $sort[0] && null === $sort[1]) {
    $sort[1] = 'asc';
}
$this->user->setAttribute($this->sortkey, $sort, $this->modulename);
}

protected function isValidSortColumn($column) {
return Doctrine::getTable($this->modelname)->hasColumn($column);
}
}

Creating the Sortable Header Widget
I'm not sure if creating a widget for this purpose would be the best approach, but I wanted to make my own widget a see how it worked. The code is an adaption of the code from a previous blog entry Sorting Lists in Symfony.
Create a file named /myproject/lib/widget/maSortableHeader.php and copy the following code on it. Then save it.

class maSortableHeader extends sfWidgetForm {

protected function configure($options = array(), $attributes = array()) {
  $this->addOption('fieldname');
  $this->addOption('fieldlabel');
  $this->addOption('routename');
  $this->addOption('sort');
}

public function render($name, $value = null, $attributes = array(), $errors = array()) {
  $sort = $this->getOption('sort');

  if ($this->getOption('fieldname') == $sort[0]) {
      $config = array('query_string' => 'sort=' . $this->getOption('fieldname') . '&sort_type=' .
          ($sort[1] == 'asc' ? 'desc' : 'asc'));
      $uri = link_to($this->getOption('fieldlabel'), $this->getOption('routename'),
                      $config);
      $uri .= image_tag('/images/' .
                      $sort[1] . '.png', array('alt' => $sort[1],
                  'title' => $sort[1]));
  } else {
      $uri = link_to($this->getOption('fieldlabel'), $this->getOption('routename'),
                      array('query_string' => 'sort=' . $this->getOption('fieldname') . '&sort_type=asc'));
  }

  return $uri;
//optional - for easy css styling
}

}

Editing the Action


On our action we're going to implement our PagingUtiliy and add widets for two columns (Code and Name). Our executeIndex function looks like this:

public function executeIndex(sfWebRequest $request)
{
   $pu = new PagingUtility("Category", $this->getUser());
   $items_x_page = sfConfig::get('app_max_items_x_page');
   $this->pager = $pu->buildPager($request, $items_x_page);

   $this->sort = $pu->getSort();

   //Adding SortableHeaders
   $this->form = new sfForm();
   $this->form->setWidget('code_sorted',
            new maSortableHeader(array('fieldname'=>'code',
       'fieldlabel'=>'Code', 'routename'=>'@category','sort'=>$pu->getSort())));
   $this->form->setWidget('name_sorted',
            new maSortableHeader(array('fieldname'=>'Name',
       'fieldlabel'=>'Name', 'routename'=>'@category','sort'=>$pu->getSort())));

}

You still need to get the asc.png and desc.png into your web/images folder for the widget to show icon besides the header.

Editing the indexSuccess.php
What we need to do now is show the Sortable Headers, change the default loop to use the pager, add the pagination control and the pagination info partials.

<thead>
  <tr>   
    <th><?php echo $form['code_sorted']; ?></th>
    <th><?php echo $form['name_sorted']; ?></th>
    <th>Description</th>
    <th>Created at</th>
    <th>Updated at</th>
    <th>Created by</th>
    <th>Updated by</th>
  </tr>
</thead>
<tbody>
  <?php foreach ($pager->getResults() as $i => $category): ?>
  <tr>
    <td><a href="<?php echo url_for('category/edit?id='.$category->getId()) ?>"><?php echo  $category->getCode() ?></a></td>
    <td><?php echo $category->getName() ?></td>
    <td><?php echo $category->getDescription() ?></td>
    <td><?php echo $category->getCreatedAt() ?></td>
    <td><?php echo $category->getUpdatedAt() ?></td>
    <td><?php echo $category->getCreator() ?></td>
    <td><?php echo $category->getUpdator() ?></td>
  </tr>
  <?php endforeach; ?>
</tbody>
<tfoot>
    <tr>
        <td colspan="7">
  <?php include_partial('global/pagination_info', array('pager' => $pager)) ?>
  <?php include_partial('global/pagination_control', array('pager' => $pager, 'module' => 'category')) ?>
        </td>
    </tr>

Editing the Routing.yml
This is the step I always forget. Mainly because I don't quite undertand what it does. I will look into it an post my findings. For now it will not work unless you add the follwing code to your routing.yml.

category:
 class: sfDoctrineRouteCollection
 options:
   model:                Category
   module:               category
   prefix_path:          /category
   column:               id
   with_wildcard_routes: true