3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
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
46 require_once 'Pager/Sliding.php';
49 * Class CRM_Utils_Pager
51 class CRM_Utils_Pager
extends Pager_Sliding
{
54 * constants for static parameters of the pager
56 CONST ROWCOUNT
= 50, PAGE_ID
= 'crmPID', PAGE_ID_TOP
= 'crmPID', PAGE_ID_BOTTOM
= 'crmPID_B', PAGE_ROWCOUNT
= 'crmRowCount';
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
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
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
81 * @return \CRM_Utils_Pager the newly created and initialized pager object@access public
83 function __construct($params) {
84 if ($params['status'] === NULL) {
85 $params['status'] = ts('Contacts %%StatusMessage%%');
88 $this->initialize($params);
90 $this->Pager_Sliding($params);
92 list($offset, $limit) = $this->getOffsetAndRowCount();
94 $end = $offset +
$limit;
95 if ($end > $params['total']) {
96 $end = $params['total'];
99 if ($params['total'] == 0) {
103 $statusMessage = ts('%1 - %2 of %3', array(1 => $start, 2 => $end, 3 => $params['total']));
105 $params['status'] = str_replace('%%StatusMessage%%', $statusMessage, $params['status']);
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(),
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
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']));
132 * helper function to assign remaining pager options as good default
135 * @param array $params the set of options needed to initialize the parent
143 function initialize(&$params) {
144 /* set the mode for the pager to Sliding */
146 $params['mode'] = 'Sliding';
148 /* also set the urlVar to be a crm specific get variable */
150 $params['urlVar'] = self
::PAGE_ID
;
152 /* set this to a small value, since we dont use this functionality */
154 $params['delta'] = 1;
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');
164 // set previous and next text labels
165 $params['prevImg'] = ' ' . ts('< Previous');
166 $params['nextImg'] = ts('Next >') . ' ';
169 // set first and last text fragments
170 $params['firstPagePre'] = '';
171 $params['firstPageText'] = ' ' . ts('<< First');
172 $params['firstPagePost'] = '';
174 $params['lastPagePre'] = '';
175 $params['lastPageText'] = ts('Last >>') . ' ';
176 $params['lastPagePost'] = '';
178 if (isset($params['pageID'])) {
179 $params['currentPage'] = $this->getPageID($params['pageID'], $params);
182 $params['perPage'] = $this->getPageRowCount($params['rowCount']);
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)
193 * @param int $defaultPageId defaultPageId current pageId
197 * @return int new pageId to display to the user
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);
208 elseif (isset($_POST[$params['buttonBottom']]) && isset($_POST[self
::PAGE_ID_BOTTOM
])) {
209 $currentPage = max((int )@$_POST[self
::PAGE_ID_BOTTOM
], 1);
211 elseif (isset($_POST[self
::PAGE_ID
])) {
212 $currentPage = max((int )@$_POST[self
::PAGE_ID
], 1);
214 elseif (isset($_POST[self
::PAGE_ID_BOTTOM
])) {
215 $currentPage = max((int )@$_POST[self
::PAGE_ID_BOTTOM
]);
218 elseif (isset($_GET[self
::PAGE_ID
])) {
219 $currentPage = max((int )@$_GET[self
::PAGE_ID
], 1);
225 * Get the number of rows to display from either a GET / POST variable
227 * @param int $defaultPageRowCount the default value if not set
229 * @return int the rowCount value to use
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);
238 elseif (isset($_GET[self
::PAGE_ROWCOUNT
])) {
239 $rowCount = max((int )@$_GET[self
::PAGE_ROWCOUNT
], 1);
242 $rowCount = $defaultPageRowCount;
248 * Use the pager class to get the pageId and Offset
252 * @return array: an array of the pageID and offset
257 function getOffsetAndRowCount() {
258 $pageId = $this->getCurrentPageID();
263 $offset = ($pageId - 1) * $this->_perPage
;
265 return array($offset, $this->_perPage
);
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();
280 function getFirstPageLink() {
281 if ($this->isFirstPage()) {
284 $href = $this->makeURL(self
::PAGE_ID
, 1);
285 return $this->formatLink($href, str_replace('%d', 1, $this->_altFirst
), $this->_firstPagePre
. $this->_firstPageText
. $this->_firstPagePost
) .
286 $this->_spacesBefore
. $this->_spacesAfter
;
292 function getLastPageLink() {
293 if ($this->isLastPage()) {
296 $href = $this->makeURL(self
::PAGE_ID
, $this->_totalPages
);
297 return $this->formatLink($href, str_replace('%d', $this->_totalPages
, $this->_altLast
), $this->_lastPagePre
. $this->_lastPageText
. $this->_lastPagePost
);
303 function getBackPageLink() {
304 if ($this->_currentPage
> 1) {
305 $href = $this->makeURL(self
::PAGE_ID
, $this->getPreviousPageID());
306 return $this->formatLink($href, $this->_altPrev
, $this->_prevImg
) . $this->_spacesBefore
. $this->_spacesAfter
;
314 function getNextPageLink() {
315 if ($this->_currentPage
< $this->_totalPages
) {
316 $href = $this->makeURL(self
::PAGE_ID
, $this->getNextPageID());
317 return $this->_spacesAfter
.
318 $this->formatLink($href, $this->_altNext
, $this->_nextImg
) .
319 $this->_spacesBefore
. $this->_spacesAfter
;
325 * Build a url for pager links
327 function makeURL($key, $value) {
328 $href = CRM_Utils_System
::makeURL($key, TRUE);
329 // CRM-12212 Remove alpha sort param
330 if (strpos($href, '&sortByCharacter=')) {
331 $href = preg_replace('#(.*)\&sortByCharacter=[^&]*(.*)#', '\1\2', $href);
333 return $href . $value;
337 * Output the html pager link
338 * @param string $href
339 * @param string $title
340 * @param string $image
343 private function formatLink($href, $title, $image) {
344 return sprintf('<a class="crm-pager-link action-item crm-hover-button" href="%s" title="%s">%s</a>', $href, $title, $image);