3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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
71 * @param array $params
73 * @return \CRM_Utils_Pager the newly created and initialized pager object
75 public function __construct($params) {
76 if ($params['status'] === NULL) {
77 $params['status'] = ts('Contacts %%StatusMessage%%');
80 $this->initialize($params);
82 $this->Pager_Sliding($params);
84 list($offset, $limit) = $this->getOffsetAndRowCount();
86 $end = $offset +
$limit;
87 if ($end > $params['total']) {
88 $end = $params['total'];
91 if ($params['total'] == 0) {
95 $statusMessage = ts('%1 - %2 of %3', array(1 => $start, 2 => $end, 3 => $params['total']));
97 $params['status'] = str_replace('%%StatusMessage%%', $statusMessage, $params['status']);
99 $this->_response
= array(
100 'first' => $this->getFirstPageLink(),
101 'back' => $this->getBackPageLink(),
102 'next' => $this->getNextPageLink(),
103 'last' => $this->getLastPageLink(),
104 'currentPage' => $this->getCurrentPageID(),
105 'numPages' => $this->numPages(),
106 'csvString' => CRM_Utils_Array
::value('csvString', $params),
107 'status' => CRM_Utils_Array
::value('status', $params),
108 'buttonTop' => CRM_Utils_Array
::value('buttonTop', $params),
109 'buttonBottom' => CRM_Utils_Array
::value('buttonBottom', $params),
110 'currentLocation' => $this->getCurrentLocation(),
114 * A page cannot have two variables with the same form name. Hence in the
115 * pager display, we have a form submission at the top with the normal
116 * page variable, but a different form element for one at the bottom
119 $this->_response
['titleTop'] = ts('Page %1 of %2', array(
120 1 => '<input size="2" maxlength="3" name="' . self
::PAGE_ID
. '" type="text" value="' . $this->_response
['currentPage'] . '" />',
121 2 => $this->_response
['numPages'],
123 $this->_response
['titleBottom'] = ts('Page %1 of %2', array(
124 1 => '<input size="2" maxlength="3" name="' . self
::PAGE_ID_BOTTOM
. '" type="text" value="' . $this->_response
['currentPage'] . '" />',
125 2 => $this->_response
['numPages'],
130 * Helper function to assign remaining pager options as good default
133 * @param array $params
134 * The set of options needed to initialize the parent.
140 public 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 >') . ' ';
165 // set first and last text fragments
166 $params['firstPagePre'] = '';
167 $params['firstPageText'] = ' ' . ts('<< First');
168 $params['firstPagePost'] = '';
170 $params['lastPagePre'] = '';
171 $params['lastPageText'] = ts('Last >>') . ' ';
172 $params['lastPagePost'] = '';
174 if (isset($params['pageID'])) {
175 $params['currentPage'] = $this->getPageID($params['pageID'], $params);
178 $params['perPage'] = $this->getPageRowCount($params['rowCount']);
184 * Figure out the current page number based on value of
185 * GET / POST variables. Hierarchy rules are followed,
186 * POST over-rides a GET, a POST at the top overrides
187 * a POST at the bottom (of the page)
189 * @param int $defaultPageId
190 * DefaultPageId current pageId.
192 * @param array $params
195 * new pageId to display to the user
197 public function getPageID($defaultPageId = 1, &$params) {
198 // POST has higher priority than GET vars
199 // else if a value is set that has higher priority and finally the GET var
200 $currentPage = $defaultPageId;
201 if (!empty($_POST)) {
202 if (isset($_POST[CRM_Utils_Array
::value('buttonTop', $params)]) && isset($_POST[self
::PAGE_ID
])) {
203 $currentPage = max((int ) @$_POST[self
::PAGE_ID
], 1);
205 elseif (isset($_POST[$params['buttonBottom']]) && isset($_POST[self
::PAGE_ID_BOTTOM
])) {
206 $currentPage = max((int ) @$_POST[self
::PAGE_ID_BOTTOM
], 1);
208 elseif (isset($_POST[self
::PAGE_ID
])) {
209 $currentPage = max((int ) @$_POST[self
::PAGE_ID
], 1);
211 elseif (isset($_POST[self
::PAGE_ID_BOTTOM
])) {
212 $currentPage = max((int ) @$_POST[self
::PAGE_ID_BOTTOM
]);
215 elseif (isset($_GET[self
::PAGE_ID
])) {
216 $currentPage = max((int ) @$_GET[self
::PAGE_ID
], 1);
222 * Get the number of rows to display from either a GET / POST variable
224 * @param int $defaultPageRowCount
225 * The default value if not set.
228 * the rowCount value to use
230 public function getPageRowCount($defaultPageRowCount = self
::ROWCOUNT
) {
231 // POST has higher priority than GET vars
232 if (isset($_POST[self
::PAGE_ROWCOUNT
])) {
233 $rowCount = max((int ) @$_POST[self
::PAGE_ROWCOUNT
], 1);
235 elseif (isset($_GET[self
::PAGE_ROWCOUNT
])) {
236 $rowCount = max((int ) @$_GET[self
::PAGE_ROWCOUNT
], 1);
239 $rowCount = $defaultPageRowCount;
245 * Use the pager class to get the pageId and Offset.
248 * an array of the pageID and offset
250 public function getOffsetAndRowCount() {
251 $pageId = $this->getCurrentPageID();
256 $offset = ($pageId - 1) * $this->_perPage
;
258 return array($offset, $this->_perPage
);
264 public 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();
273 public function getFirstPageLink() {
274 if ($this->isFirstPage()) {
277 $href = $this->makeURL(self
::PAGE_ID
, 1);
278 return $this->formatLink($href, str_replace('%d', 1, $this->_altFirst
), $this->_firstPagePre
. $this->_firstPageText
. $this->_firstPagePost
) .
279 $this->_spacesBefore
. $this->_spacesAfter
;
285 public function getLastPageLink() {
286 if ($this->isLastPage()) {
289 $href = $this->makeURL(self
::PAGE_ID
, $this->_totalPages
);
290 return $this->formatLink($href, str_replace('%d', $this->_totalPages
, $this->_altLast
), $this->_lastPagePre
. $this->_lastPageText
. $this->_lastPagePost
);
296 public function getBackPageLink() {
297 if ($this->_currentPage
> 1) {
298 $href = $this->makeURL(self
::PAGE_ID
, $this->getPreviousPageID());
299 return $this->formatLink($href, $this->_altPrev
, $this->_prevImg
) . $this->_spacesBefore
. $this->_spacesAfter
;
307 public function getNextPageLink() {
308 if ($this->_currentPage
< $this->_totalPages
) {
309 $href = $this->makeURL(self
::PAGE_ID
, $this->getNextPageID());
310 return $this->_spacesAfter
.
311 $this->formatLink($href, $this->_altNext
, $this->_nextImg
) .
312 $this->_spacesBefore
. $this->_spacesAfter
;
318 * Build a url for pager links.
320 public function makeURL($key, $value) {
321 $href = CRM_Utils_System
::makeURL($key, TRUE);
322 // CRM-12212 Remove alpha sort param
323 if (strpos($href, '&sortByCharacter=')) {
324 $href = preg_replace('#(.*)\&sortByCharacter=[^&]*(.*)#', '\1\2', $href);
326 return $href . $value;
330 * Output the html pager link.
331 * @param string $href
332 * @param string $title
333 * @param string $image
336 private function formatLink($href, $title, $image) {
337 return sprintf('<a class="crm-pager-link action-item crm-hover-button" href="%s" title="%s">%s</a>', $href, $title, $image);