CRM/Utils/Pager.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  *
  38  * This class extends the PEAR pager object by substituting standard default pager arguments
  39  * We also extract the pageId from either the GET variables or the POST variable (since we
  40  * use a POST to jump to a specific page). At some point we should evaluate if we want
  41  * to use Pager_Jumping instead. We've changed the format to allow navigation by jumping
  42  * to a page and also First, Prev CURRENT Next Last
  43  *
  44  */
  45
  46 require_once 'Pager/Sliding.php';
  47
  48 /**
  49  * Class CRM_Utils_Pager
  50  */
  51 class CRM_Utils_Pager extends Pager_Sliding {
  52
  53   /**
  54    * Constants for static parameters of the pager
  55    */
  56   const ROWCOUNT = 50, PAGE_ID = 'crmPID', PAGE_ID_TOP = 'crmPID', PAGE_ID_BOTTOM = 'crmPID_B', PAGE_ROWCOUNT = 'crmRowCount';
  57
  58   /**
  59    * The output of the pager. This is a name/value array with various keys
  60    * that an application could use to display the pager
  61    * @var array
  62    */
  63   public $_response;
  64
  65   /**
  66    * The pager constructor. Takes a few values, and then assigns a lot of defaults
  67    * to the PEAR pager class
  68    * We have embedded some html in this class. Need to figure out how to export this
  69    * to the top level at some point in time
  70    *
  71    * @param array $params
  72    *
  73    * @internal param \total $int the total count of items to be displayed
  74    * @internal param \currentPage $int the page currently being displayed
  75    * @internal param \status $string the status message to be displayed. It embeds a token
  76    *                             %%statusMessage%% that will be replaced with which items
  77    *                             are currently being displayed
  78    * @internal param \csvString $string the title of the link to be displayed for the export
  79    * @internal param \perPage $int the number of items displayed per page
  80    *
  81    * @return \CRM_Utils_Pager the newly created and initialized pager object
  82    * @access public
  83    */
  84   public function __construct($params) {
  85     if ($params['status'] === NULL) {
  86       $params['status'] = ts('Contacts %%StatusMessage%%');
  87     }
  88
  89     $this->initialize($params);
  90
  91     $this->Pager_Sliding($params);
  92
  93     list($offset, $limit) = $this->getOffsetAndRowCount();
  94     $start = $offset + 1;
  95     $end = $offset + $limit;
  96     if ($end > $params['total']) {
  97       $end = $params['total'];
  98     }
  99
 100     if ($params['total'] == 0) {
 101       $statusMessage = '';
 102     }
 103     else {
 104       $statusMessage = ts('%1 - %2 of %3', array(1 => $start, 2 => $end, 3 => $params['total']));
 105     }
 106     $params['status'] = str_replace('%%StatusMessage%%', $statusMessage, $params['status']);
 107
 108     $this->_response = array(
 109       'first' => $this->getFirstPageLink(),
 110       'back' => $this->getBackPageLink(),
 111       'next' => $this->getNextPageLink(),
 112       'last' => $this->getLastPageLink(),
 113       'currentPage' => $this->getCurrentPageID(),
 114       'numPages' => $this->numPages(),
 115       'csvString' => CRM_Utils_Array::value('csvString', $params),
 116       'status' => CRM_Utils_Array::value('status', $params),
 117       'buttonTop' => CRM_Utils_Array::value('buttonTop', $params),
 118       'buttonBottom' => CRM_Utils_Array::value('buttonBottom', $params),
 119       'currentLocation' => $this->getCurrentLocation(),
 120     );
 121
 122     /**
 123      * A page cannot have two variables with the same form name. Hence in the
 124      * pager display, we have a form submission at the top with the normal
 125      * page variable, but a different form element for one at the bottom
 126      *
 127      */
 128     $this->_response['titleTop'] = ts('Page %1 of %2', array(1 => '<input size="2" maxlength="3" name="' . self::PAGE_ID . '" type="text" value="' . $this->_response['currentPage'] . '" />', 2 => $this->_response['numPages']));
 129     $this->_response['titleBottom'] = ts('Page %1 of %2', array(1 => '<input size="2" maxlength="3" name="' . self::PAGE_ID_BOTTOM . '" type="text" value="' . $this->_response['currentPage'] . '" />', 2 => $this->_response['numPages']));
 130   }
 131
 132   /**
 133    * Helper function to assign remaining pager options as good default
 134    * values
 135    *
 136    * @param array $params
 137    *   The set of options needed to initialize the parent.
 138    *                             constructor
 139    *
 140    *
 141    * @return void
 142    *
 143    */
 144   public function initialize(&$params) {
 145     /* set the mode for the pager to Sliding */
 146
 147     $params['mode'] = 'Sliding';
 148
 149     /* also set the urlVar to be a crm specific get variable */
 150
 151     $params['urlVar'] = self::PAGE_ID;
 152
 153     /* set this to a small value, since we dont use this functionality */
 154
 155     $params['delta'] = 1;
 156
 157     $params['totalItems'] = $params['total'];
 158     $params['append'] = TRUE;
 159     $params['separator'] = '';
 160     $params['spacesBeforeSeparator'] = 1;
 161     $params['spacesAfterSeparator'] = 1;
 162     $params['extraVars'] = array('force' => 1);
 163     $params['excludeVars'] = array('reset', 'snippet', 'section');
 164
 165     // set previous and next text labels
 166     $params['prevImg'] = ' ' . ts('&lt; Previous');
 167     $params['nextImg'] = ts('Next &gt;') . ' ';
 168
 169     // set first and last text fragments
 170     $params['firstPagePre'] = '';
 171     $params['firstPageText'] = ' ' . ts('&lt;&lt; First');
 172     $params['firstPagePost'] = '';
 173
 174     $params['lastPagePre'] = '';
 175     $params['lastPageText'] = ts('Last &gt;&gt;') . ' ';
 176     $params['lastPagePost'] = '';
 177
 178     if (isset($params['pageID'])) {
 179       $params['currentPage'] = $this->getPageID($params['pageID'], $params);
 180     }
 181
 182     $params['perPage'] = $this->getPageRowCount($params['rowCount']);
 183
 184     return $params;
 185   }
 186
 187   /**
 188    * Figure out the current page number based on value of
 189    * GET / POST variables. Hierarchy rules are followed,
 190    * POST over-rides a GET, a POST at the top overrides
 191    * a POST at the bottom (of the page)
 192    *
 193    * @param int $defaultPageId
 194    *   DefaultPageId current pageId.
 195    *
 196    * @param array $params
 197    *
 198    * @return int                new pageId to display to the user
 199    */
 200   public function getPageID($defaultPageId = 1, &$params) {
 201     // POST has higher priority than GET vars
 202     // else if a value is set that has higher priority and finally the GET var
 203     $currentPage = $defaultPageId;
 204     if (!empty($_POST)) {
 205       if (isset($_POST[CRM_Utils_Array::value('buttonTop', $params)]) && isset($_POST[self::PAGE_ID])) {
 206         $currentPage = max((int ) @$_POST[self::PAGE_ID], 1);
 207       }
 208       elseif (isset($_POST[$params['buttonBottom']]) && isset($_POST[self::PAGE_ID_BOTTOM])) {
 209         $currentPage = max((int ) @$_POST[self::PAGE_ID_BOTTOM], 1);
 210       }
 211       elseif (isset($_POST[self::PAGE_ID])) {
 212         $currentPage = max((int ) @$_POST[self::PAGE_ID], 1);
 213       }
 214       elseif (isset($_POST[self::PAGE_ID_BOTTOM])) {
 215         $currentPage = max((int ) @$_POST[self::PAGE_ID_BOTTOM]);
 216       }
 217     }
 218     elseif (isset($_GET[self::PAGE_ID])) {
 219       $currentPage = max((int ) @$_GET[self::PAGE_ID], 1);
 220     }
 221     return $currentPage;
 222   }
 223
 224   /**
 225    * Get the number of rows to display from either a GET / POST variable
 226    *
 227    * @param int $defaultPageRowCount
 228    *   The default value if not set.
 229    *
 230    * @return int                     the rowCount value to use
 231    *
 232    */
 233   public function getPageRowCount($defaultPageRowCount = self::ROWCOUNT) {
 234     // POST has higher priority than GET vars
 235     if (isset($_POST[self::PAGE_ROWCOUNT])) {
 236       $rowCount = max((int ) @$_POST[self::PAGE_ROWCOUNT], 1);
 237     }
 238     elseif (isset($_GET[self::PAGE_ROWCOUNT])) {
 239       $rowCount = max((int ) @$_GET[self::PAGE_ROWCOUNT], 1);
 240     }
 241     else {
 242       $rowCount = $defaultPageRowCount;
 243     }
 244     return $rowCount;
 245   }
 246
 247   /**
 248    * Use the pager class to get the pageId and Offset
 249    *
 250    * @param void
 251    *
 252    * @return array: an array of the pageID and offset
 253    *
 254    *
 255    */
 256   public function getOffsetAndRowCount() {
 257     $pageId = $this->getCurrentPageID();
 258     if (!$pageId) {
 259       $pageId = 1;
 260     }
 261
 262     $offset = ($pageId - 1) * $this->_perPage;
 263
 264     return array($offset, $this->_perPage);
 265   }
 266
 267   /**
 268    * @return string
 269    */
 270   public function getCurrentLocation() {
 271     $config = CRM_Core_Config::singleton();
 272     $path = CRM_Utils_Array::value($config->userFrameworkURLVar, $_GET);
 273     return CRM_Utils_System::url($path, CRM_Utils_System::getLinksUrl(self::PAGE_ID, FALSE, TRUE), FALSE, NULL, FALSE) . $this->getCurrentPageID();
 274   }
 275
 276   /**
 277    * @return string
 278    */
 279   public function getFirstPageLink() {
 280     if ($this->isFirstPage()) {
 281       return '';
 282     }
 283     $href = $this->makeURL(self::PAGE_ID, 1);
 284     return $this->formatLink($href, str_replace('%d', 1, $this->_altFirst), $this->_firstPagePre . $this->_firstPageText . $this->_firstPagePost) .
 285       $this->_spacesBefore . $this->_spacesAfter;
 286   }
 287
 288   /**
 289    * @return string
 290    */
 291   public function getLastPageLink() {
 292     if ($this->isLastPage()) {
 293       return '';
 294     }
 295     $href = $this->makeURL(self::PAGE_ID, $this->_totalPages);
 296     return $this->formatLink($href, str_replace('%d', $this->_totalPages, $this->_altLast), $this->_lastPagePre . $this->_lastPageText . $this->_lastPagePost);
 297   }
 298
 299   /**
 300    * @return string
 301    */
 302   public function getBackPageLink() {
 303     if ($this->_currentPage > 1) {
 304       $href = $this->makeURL(self::PAGE_ID, $this->getPreviousPageID());
 305       return $this->formatLink($href, $this->_altPrev, $this->_prevImg) . $this->_spacesBefore . $this->_spacesAfter;
 306     }
 307     return '';
 308   }
 309
 310   /**
 311    * @return string
 312    */
 313   public function getNextPageLink() {
 314     if ($this->_currentPage < $this->_totalPages) {
 315       $href = $this->makeURL(self::PAGE_ID, $this->getNextPageID());
 316       return $this->_spacesAfter .
 317         $this->formatLink($href, $this->_altNext, $this->_nextImg) .
 318         $this->_spacesBefore . $this->_spacesAfter;
 319     }
 320     return '';
 321   }
 322
 323   /**
 324    * Build a url for pager links
 325    */
 326   public function makeURL($key, $value) {
 327     $href = CRM_Utils_System::makeURL($key, TRUE);
 328     // CRM-12212 Remove alpha sort param
 329     if (strpos($href, '&amp;sortByCharacter=')) {
 330       $href = preg_replace('#(.*)\&amp;sortByCharacter=[^&]*(.*)#', '\1\2', $href);
 331     }
 332     return $href . $value;
 333   }
 334
 335   /**
 336    * Output the html pager link
 337    * @param string $href
 338    * @param string $title
 339    * @param string $image
 340    * @return string
 341    */
 342   private function formatLink($href, $title, $image) {
 343     return sprintf('<a class="crm-pager-link action-item crm-hover-button" href="%s" title="%s">%s</a>', $href, $title, $image);
 344   }
 345 }