GeneralPagingFeature.inc.php

<?php
 
import('lib.pkp.classes.controllers.grid.feature.GridFeature');
 
class GeneralPagingFeature extends GridFeature {
 
   private $_itemIterator;
 
   private $_itemsPerPage;
 
   function __construct($id, $itemsPerPage = null) {
      $this->_itemsPerPage = $itemsPerPage;
      parent::__construct($id);
   }
 
 
   //
   // Getters and setters.
   //
   function getItemIterator() {
      return $this->_itemIterator;
   }
 
 
   //
   // Extended GridFeature methods.
   //
   function setOptions($request, $grid) {
      // Get the default items per page setting value.
      $rangeInfo = PKPHandler::getRangeInfo($request, $grid->getId());
      $iterator = $this->getItemIterator();
      $defaultItemsPerPage = $rangeInfo->getCount();
 
      // Check for a component level items per page setting.
      $componentItemsPerPage = $request->getUserVar($this->_getItemsPerPageParamName($grid->getId()));
      if (!$componentItemsPerPage) $componentItemsPerPage = $this->_itemsPerPage;
 
      if ($componentItemsPerPage) {
         $currentItemsPerPage = $componentItemsPerPage;
      } else {
         $currentItemsPerPage = $defaultItemsPerPage;
      }
 
      $options = array(
         'itemsPerPageParamName' => $this->_getItemsPerPageParamName($grid->getId()),
         'defaultItemsPerPage' => $defaultItemsPerPage,
         'currentItemsPerPage' => $currentItemsPerPage,
         'itemsTotal' => $iterator->getCount(),
         'pageParamName' => PKPHandler::getPageParamName($grid->getId()),
         'currentPage' => $iterator->getPage()
      );
 
      $this->addOptions($options);
 
      parent::setOptions($request, $grid);
   }
 
 
   //
   // Hooks implementation.
   //
   /*
    * @copydoc GridFeature::gridInitialize()
    * The feature will know about the current filter
    * value so it can request grid refreshes keeping
    * the filter.
    */
   function getGridDataElements($args) {
      $filter = $args['filter'];
 
      if (is_array($filter) && !empty($filter)) {
         $this->addOptions(array('filter' => json_encode($filter)));
      }
   }
 
 
   function setGridDataElements($args) {
      $grid =& $args['grid'];
      $data =& $args['data'];
 
      if (is_array($data)) {
         import('lib.pkp.classes.core.ArrayItemIterator');
         $request = Application::get()->getRequest();
         $rangeInfo = $grid->getGridRangeInfo($request, $grid->getId());
         $itemIterator = new ArrayItemIterator($data, $rangeInfo->getPage(), $rangeInfo->getCount());
         $this->_itemIterator = $itemIterator;
         $data = $itemIterator->toArray();
      } elseif (is_a($data, 'ItemIterator')) {
         $this->_itemIterator = $data;
      }
   }
 
   function getRequestArgs($args) {
      $grid = $args['grid'];
      $requestArgs =& $args['requestArgs'];
 
      // Add paging info so grid actions will not loose paging context.
      // Only works if grid link actions use the getRequestArgs
      // returned content.
      $request = Application::get()->getRequest();
      $rangeInfo = $grid->getGridRangeInfo($request, $grid->getId());
      $requestArgs[GridHandler::getPageParamName($grid->getId())] = $rangeInfo->getPage();
      $requestArgs[$this->_getItemsPerPageParamName($grid->getId())] = $rangeInfo->getCount();
   }
 
   function getGridRangeInfo($args) {
      $request = $args['request'];
      $grid = $args['grid'];
      $rangeInfo = $args['rangeInfo'];
 
      // Add grid level items per page setting, if any.
      $itemsPerPage = $request->getUserVar($this->_getItemsPerPageParamName($grid->getId()));
      if ($this->_itemsPerPage) $itemsPerPage = $this->_itemsPerPage; // Feature config overrides. 
      if ($itemsPerPage) {
         $rangeInfo->setCount($itemsPerPage);
      }
   }
 
 
   //
   // Private helper methods.
   //
   private function _getItemsPerPageParamName($rangeName) {
      return $rangeName . 'ItemsPerPage';
   }
}