| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.5 | |
| 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 $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@access public |
| 82 | */ |
| 83 | function __construct($params) { |
| 84 | if ($params['status'] === NULL) { |
| 85 | $params['status'] = ts('Contacts %%StatusMessage%%'); |
| 86 | } |
| 87 | |
| 88 | $this->initialize($params); |
| 89 | |
| 90 | $this->Pager_Sliding($params); |
| 91 | |
| 92 | list($offset, $limit) = $this->getOffsetAndRowCount(); |
| 93 | $start = $offset + 1; |
| 94 | $end = $offset + $limit; |
| 95 | if ($end > $params['total']) { |
| 96 | $end = $params['total']; |
| 97 | } |
| 98 | |
| 99 | if ($params['total'] == 0) { |
| 100 | $statusMessage = ''; |
| 101 | } |
| 102 | else { |
| 103 | $statusMessage = ts('%1 - %2 of %3', array(1 => $start, 2 => $end, 3 => $params['total'])); |
| 104 | } |
| 105 | $params['status'] = str_replace('%%StatusMessage%%', $statusMessage, $params['status']); |
| 106 | |
| 107 | $this->_response = array( |
| 108 | 'first' => $this->getFirstPageLink(), |
| 109 | 'back' => $this->getBackPageLink(), |
| 110 | 'next' => $this->getNextPageLink(), |
| 111 | 'last' => $this->getLastPageLink(), |
| 112 | 'currentPage' => $this->getCurrentPageID(), |
| 113 | 'numPages' => $this->numPages(), |
| 114 | 'csvString' => CRM_Utils_Array::value('csvString', $params), |
| 115 | 'status' => CRM_Utils_Array::value('status', $params), |
| 116 | 'buttonTop' => CRM_Utils_Array::value('buttonTop', $params), |
| 117 | 'buttonBottom' => CRM_Utils_Array::value('buttonBottom', $params), |
| 118 | 'currentLocation' => $this->getCurrentLocation(), |
| 119 | ); |
| 120 | |
| 121 | /** |
| 122 | * A page cannot have two variables with the same form name. Hence in the |
| 123 | * pager display, we have a form submission at the top with the normal |
| 124 | * page variable, but a different form element for one at the bottom |
| 125 | * |
| 126 | */ |
| 127 | $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'])); |
| 128 | $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'])); |
| 129 | } |
| 130 | |
| 131 | /** |
| 132 | * helper function to assign remaining pager options as good default |
| 133 | * values |
| 134 | * |
| 135 | * @param array $params the set of options needed to initialize the parent |
| 136 | * constructor |
| 137 | * |
| 138 | * @access public |
| 139 | * |
| 140 | * @return void |
| 141 | * |
| 142 | */ |
| 143 | function initialize(&$params) { |
| 144 | /* set the mode for the pager to Sliding */ |
| 145 | |
| 146 | $params['mode'] = 'Sliding'; |
| 147 | |
| 148 | /* also set the urlVar to be a crm specific get variable */ |
| 149 | |
| 150 | $params['urlVar'] = self::PAGE_ID; |
| 151 | |
| 152 | /* set this to a small value, since we dont use this functionality */ |
| 153 | |
| 154 | $params['delta'] = 1; |
| 155 | |
| 156 | $params['totalItems'] = $params['total']; |
| 157 | $params['append'] = TRUE; |
| 158 | $params['separator'] = ''; |
| 159 | $params['spacesBeforeSeparator'] = 1; |
| 160 | $params['spacesAfterSeparator'] = 1; |
| 161 | $params['extraVars'] = array('force' => 1); |
| 162 | $params['excludeVars'] = array('reset', 'snippet', 'section'); |
| 163 | |
| 164 | // set previous and next text labels |
| 165 | $params['prevImg'] = ' ' . ts('< Previous'); |
| 166 | $params['nextImg'] = ts('Next >') . ' '; |
| 167 | |
| 168 | |
| 169 | // set first and last text fragments |
| 170 | $params['firstPagePre'] = ''; |
| 171 | $params['firstPageText'] = ' ' . ts('<< First'); |
| 172 | $params['firstPagePost'] = ''; |
| 173 | |
| 174 | $params['lastPagePre'] = ''; |
| 175 | $params['lastPageText'] = ts('Last >>') . ' '; |
| 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 defaultPageId current pageId |
| 194 | * |
| 195 | * @param $params |
| 196 | * |
| 197 | * @return int new pageId to display to the user |
| 198 | * @access public |
| 199 | */ |
| 200 | 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 the default value if not set |
| 228 | * |
| 229 | * @return int the rowCount value to use |
| 230 | * @access public |
| 231 | * |
| 232 | */ |
| 233 | 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 | * @access public |
| 255 | * |
| 256 | */ |
| 257 | function getOffsetAndRowCount() { |
| 258 | $pageId = $this->getCurrentPageID(); |
| 259 | if (!$pageId) { |
| 260 | $pageId = 1; |
| 261 | } |
| 262 | |
| 263 | $offset = ($pageId - 1) * $this->_perPage; |
| 264 | |
| 265 | return array($offset, $this->_perPage); |
| 266 | } |
| 267 | |
| 268 | /** |
| 269 | * @return string |
| 270 | */ |
| 271 | function getCurrentLocation() { |
| 272 | $config = CRM_Core_Config::singleton(); |
| 273 | $path = CRM_Utils_Array::value($config->userFrameworkURLVar, $_GET); |
| 274 | return CRM_Utils_System::url($path, CRM_Utils_System::getLinksUrl(self::PAGE_ID, FALSE, TRUE), FALSE, NULL, FALSE) . $this->getCurrentPageID(); |
| 275 | } |
| 276 | |
| 277 | /** |
| 278 | * @return string |
| 279 | */ |
| 280 | function getFirstPageLink() { |
| 281 | if ($this->isFirstPage()) { |
| 282 | return ''; |
| 283 | } |
| 284 | |
| 285 | $href = $this->makeURL(self::PAGE_ID, 1); |
| 286 | return sprintf('<a class="crm-pager-link" href="%s" title="%s">%s</a>', |
| 287 | $href, |
| 288 | str_replace('%d', 1, $this->_altFirst), |
| 289 | $this->_firstPagePre . $this->_firstPageText . $this->_firstPagePost |
| 290 | ) . $this->_spacesBefore . $this->_spacesAfter; |
| 291 | } |
| 292 | |
| 293 | /** |
| 294 | * @return string |
| 295 | */ |
| 296 | function getLastPageLink() { |
| 297 | if ($this->isLastPage()) { |
| 298 | return ''; |
| 299 | } |
| 300 | |
| 301 | $href = $this->makeURL(self::PAGE_ID, $this->_totalPages); |
| 302 | return sprintf('<a class="crm-pager-link" href="%s" title="%s">%s</a>', |
| 303 | $href, |
| 304 | str_replace('%d', $this->_totalPages, $this->_altLast), |
| 305 | $this->_lastPagePre . $this->_lastPageText . $this->_lastPagePost |
| 306 | ); |
| 307 | } |
| 308 | |
| 309 | /** |
| 310 | * @return string |
| 311 | */ |
| 312 | function getBackPageLink() { |
| 313 | if ($this->_currentPage > 1) { |
| 314 | $href = $this->makeURL(self::PAGE_ID, $this->getPreviousPageID()); |
| 315 | return sprintf('<a class="crm-pager-link" href="%s" title="%s">%s</a>', |
| 316 | $href, |
| 317 | $this->_altPrev, $this->_prevImg |
| 318 | ) . $this->_spacesBefore . $this->_spacesAfter; |
| 319 | } |
| 320 | return ''; |
| 321 | } |
| 322 | |
| 323 | /** |
| 324 | * @return string |
| 325 | */ |
| 326 | function getNextPageLink() { |
| 327 | if ($this->_currentPage < $this->_totalPages) { |
| 328 | $href = $this->makeURL(self::PAGE_ID, $this->getNextPageID()); |
| 329 | return $this->_spacesAfter . sprintf('<a class="crm-pager-link" href="%s" title="%s">%s</a>', |
| 330 | $href, |
| 331 | $this->_altNext, $this->_nextImg |
| 332 | ) . $this->_spacesBefore . $this->_spacesAfter; |
| 333 | } |
| 334 | return ''; |
| 335 | } |
| 336 | |
| 337 | /** |
| 338 | * Build a url for pager links |
| 339 | */ |
| 340 | function makeURL($key, $value) { |
| 341 | $href = CRM_Utils_System::makeURL($key); |
| 342 | // CRM-12212 Remove alpha sort param |
| 343 | if (strpos($href, '&sortByCharacter=')) { |
| 344 | $href = preg_replace('#(.*)\&sortByCharacter=[^&]*(.*)#', '\1\2', $href); |
| 345 | } |
| 346 | return $href . $value; |
| 347 | } |
| 348 | } |
| 349 | |