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';
47 class CRM_Utils_Pager
extends Pager_Sliding
{
50 * constants for static parameters of the pager
52 CONST ROWCOUNT
= 50, PAGE_ID
= 'crmPID', PAGE_ID_TOP
= 'crmPID', PAGE_ID_BOTTOM
= 'crmPID_B', PAGE_ROWCOUNT
= 'crmRowCount';
55 * the output of the pager. This is a name/value array with various keys
56 * that an application could use to display the pager
62 * The pager constructor. Takes a few values, and then assigns a lot of defaults
63 * to the PEAR pager class
64 * We have embedded some html in this class. Need to figure out how to export this
65 * to the top level at some point in time
67 * @param int total the total count of items to be displayed
68 * @param int currentPage the page currently being displayed
69 * @param string status the status message to be displayed. It embeds a token
70 * %%statusMessage%% that will be replaced with which items
71 * are currently being displayed
72 * @param string csvString the title of the link to be displayed for the export
73 * @param int perPage the number of items displayed per page
75 * @return object the newly created and initialized pager object
80 function __construct($params) {
81 if ($params['status'] === NULL) {
82 $params['status'] = ts('Contacts %%StatusMessage%%');
85 $this->initialize($params);
87 $this->Pager_Sliding($params);
89 list($offset, $limit) = $this->getOffsetAndRowCount();
91 $end = $offset +
$limit;
92 if ($end > $params['total']) {
93 $end = $params['total'];
96 if ($params['total'] == 0) {
100 $statusMessage = ts('%1 - %2 of %3', array(1 => $start, 2 => $end, 3 => $params['total']));
102 $params['status'] = str_replace('%%StatusMessage%%', $statusMessage, $params['status']);
104 $this->_response
= array(
105 'first' => $this->getFirstPageLink(),
106 'back' => $this->getBackPageLink(),
107 'next' => $this->getNextPageLink(),
108 'last' => $this->getLastPageLink(),
109 'currentPage' => $this->getCurrentPageID(),
110 'numPages' => $this->numPages(),
111 'csvString' => CRM_Utils_Array
::value('csvString', $params),
112 'status' => CRM_Utils_Array
::value('status', $params),
113 'buttonTop' => CRM_Utils_Array
::value('buttonTop', $params),
114 'buttonBottom' => CRM_Utils_Array
::value('buttonBottom', $params),
115 'currentLocation' => $this->getCurrentLocation(),
119 * A page cannot have two variables with the same form name. Hence in the
120 * pager display, we have a form submission at the top with the normal
121 * page variable, but a different form element for one at the bottom
124 $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']));
125 $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 * helper function to assign remaining pager options as good default
132 * @param array $params the set of options needed to initialize the parent
140 function initialize(&$params) {
141 /* set the mode for the pager to Sliding */
143 $params['mode'] = 'Sliding';
145 /* also set the urlVar to be a crm specific get variable */
147 $params['urlVar'] = self
::PAGE_ID
;
149 /* set this to a small value, since we dont use this functionality */
151 $params['delta'] = 1;
153 $params['totalItems'] = $params['total'];
154 $params['append'] = TRUE;
155 $params['separator'] = '';
156 $params['spacesBeforeSeparator'] = 1;
157 $params['spacesAfterSeparator'] = 1;
158 $params['extraVars'] = array('force' => 1);
159 $params['excludeVars'] = array('reset', 'snippet', 'section');
161 // set previous and next text labels
162 $params['prevImg'] = ' ' . ts('< Previous');
163 $params['nextImg'] = ts('Next >') . ' ';
166 // set first and last text fragments
167 $params['firstPagePre'] = '';
168 $params['firstPageText'] = ' ' . ts('<< First');
169 $params['firstPagePost'] = '';
171 $params['lastPagePre'] = '';
172 $params['lastPageText'] = ts('Last >>') . ' ';
173 $params['lastPagePost'] = '';
175 if (isset($params['pageID'])) {
176 $params['currentPage'] = $this->getPageID($params['pageID'], $params);
179 $params['perPage'] = $this->getPageRowCount($params['rowCount']);
185 * Figure out the current page number based on value of
186 * GET / POST variables. Hierarchy rules are followed,
187 * POST over-rides a GET, a POST at the top overrides
188 * a POST at the bottom (of the page)
190 * @param int defaultPageId current pageId
192 * @return int new pageId to display to the user
196 function getPageID($defaultPageId = 1, &$params) {
197 // POST has higher priority than GET vars
198 // else if a value is set that has higher priority and finally the GET var
199 $currentPage = $defaultPageId;
200 if (!empty($_POST)) {
201 if (isset($_POST[CRM_Utils_Array
::value('buttonTop', $params)]) && isset($_POST[self
::PAGE_ID
])) {
202 $currentPage = max((int )@$_POST[self
::PAGE_ID
], 1);
204 elseif (isset($_POST[$params['buttonBottom']]) && isset($_POST[self
::PAGE_ID_BOTTOM
])) {
205 $currentPage = max((int )@$_POST[self
::PAGE_ID_BOTTOM
], 1);
207 elseif (isset($_POST[self
::PAGE_ID
])) {
208 $currentPage = max((int )@$_POST[self
::PAGE_ID
], 1);
210 elseif (isset($_POST[self
::PAGE_ID_BOTTOM
])) {
211 $currentPage = max((int )@$_POST[self
::PAGE_ID_BOTTOM
]);
214 elseif (isset($_GET[self
::PAGE_ID
])) {
215 $currentPage = max((int )@$_GET[self
::PAGE_ID
], 1);
221 * Get the number of rows to display from either a GET / POST variable
223 * @param int $defaultPageRowCount the default value if not set
225 * @return int the rowCount value to use
229 function getPageRowCount($defaultPageRowCount = self
::ROWCOUNT
) {
230 // POST has higher priority than GET vars
231 if (isset($_POST[self
::PAGE_ROWCOUNT
])) {
232 $rowCount = max((int )@$_POST[self
::PAGE_ROWCOUNT
], 1);
234 elseif (isset($_GET[self
::PAGE_ROWCOUNT
])) {
235 $rowCount = max((int )@$_GET[self
::PAGE_ROWCOUNT
], 1);
238 $rowCount = $defaultPageRowCount;
244 * Use the pager class to get the pageId and Offset
248 * @return array: an array of the pageID and offset
253 function getOffsetAndRowCount() {
254 $pageId = $this->getCurrentPageID();
259 $offset = ($pageId - 1) * $this->_perPage
;
261 return array($offset, $this->_perPage
);
264 function getCurrentLocation() {
265 $config = CRM_Core_Config
::singleton();
266 $path = CRM_Utils_Array
::value($config->userFrameworkURLVar
, $_GET);
267 return CRM_Utils_System
::url($path, CRM_Utils_System
::getLinksUrl(self
::PAGE_ID
, FALSE, TRUE), FALSE, NULL, FALSE) . $this->getCurrentPageID();
270 function getFirstPageLink() {
271 if ($this->isFirstPage()) {
275 $href = $this->makeURL(self
::PAGE_ID
, 1);
276 return sprintf('<a class="crm-pager-link" href="%s" title="%s">%s</a>',
278 str_replace('%d', 1, $this->_altFirst
),
279 $this->_firstPagePre
. $this->_firstPageText
. $this->_firstPagePost
280 ) . $this->_spacesBefore
. $this->_spacesAfter
;
283 function getLastPageLink() {
284 if ($this->isLastPage()) {
288 $href = $this->makeURL(self
::PAGE_ID
, $this->_totalPages
);
289 return sprintf('<a class="crm-pager-link" href="%s" title="%s">%s</a>',
291 str_replace('%d', $this->_totalPages
, $this->_altLast
),
292 $this->_lastPagePre
. $this->_lastPageText
. $this->_lastPagePost
296 function getBackPageLink() {
297 if ($this->_currentPage
> 1) {
298 $href = $this->makeURL(self
::PAGE_ID
, $this->getPreviousPageID());
299 return sprintf('<a class="crm-pager-link" href="%s" title="%s">%s</a>',
301 $this->_altPrev
, $this->_prevImg
302 ) . $this->_spacesBefore
. $this->_spacesAfter
;
307 function getNextPageLink() {
308 if ($this->_currentPage
< $this->_totalPages
) {
309 $href = $this->makeURL(self
::PAGE_ID
, $this->getNextPageID());
310 return $this->_spacesAfter
. sprintf('<a class="crm-pager-link" href="%s" title="%s">%s</a>',
312 $this->_altNext
, $this->_nextImg
313 ) . $this->_spacesBefore
. $this->_spacesAfter
;
319 * Build a url for pager links
321 function makeURL($key, $value) {
322 $href = CRM_Utils_System
::makeURL($key);
323 // CRM-12212 Remove alpha sort param
324 if (strpos($href, '&sortByCharacter=')) {
325 $href = preg_replace('#(.*)\&sortByCharacter=[^&]*(.*)#', '\1\2', $href);
327 return $href . $value;