X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FUtils%2FPager.php;h=d69f822d461d5bccdb22e2f890a54ba736baa81f;hb=353ffa53c335f7b94ebaddc701e46f2bb30c7048;hp=9615cccdcca9f94a5893c51d96d9aa11c0ea0527;hpb=845bc17a66f2ef2ca7c819fbe99ec646f0d42634;p=civicrm-core.git
diff --git a/CRM/Utils/Pager.php b/CRM/Utils/Pager.php
index 9615cccdcc..d69f822d46 100644
--- a/CRM/Utils/Pager.php
+++ b/CRM/Utils/Pager.php
@@ -1,7 +1,7 @@
_response['titleTop'] = ts('Page %1 of %2', array(1 => '', 2 => $this->_response['numPages']));
- $this->_response['titleBottom'] = ts('Page %1 of %2', array(1 => '', 2 => $this->_response['numPages']));
+ $this->_response['titleTop'] = ts('Page %1 of %2', array(
+ 1 => '',
+ 2 => $this->_response['numPages']
+ ));
+ $this->_response['titleBottom'] = ts('Page %1 of %2', array(
+ 1 => '',
+ 2 => $this->_response['numPages']
+ ));
}
/**
- * helper function to assign remaining pager options as good default
+ * Helper function to assign remaining pager options as good default
* values
*
- * @param array $params the set of options needed to initialize the parent
+ * @param array $params
+ * The set of options needed to initialize the parent.
* constructor
*
- * @access public
*
* @return void
- *
*/
- function initialize(&$params) {
+ public function initialize(&$params) {
/* set the mode for the pager to Sliding */
$params['mode'] = 'Sliding';
@@ -165,7 +171,6 @@ class CRM_Utils_Pager extends Pager_Sliding {
$params['prevImg'] = ' ' . ts('< Previous');
$params['nextImg'] = ts('Next >') . ' ';
-
// set first and last text fragments
$params['firstPagePre'] = '';
$params['firstPageText'] = ' ' . ts('<< First');
@@ -190,33 +195,34 @@ class CRM_Utils_Pager extends Pager_Sliding {
* POST over-rides a GET, a POST at the top overrides
* a POST at the bottom (of the page)
*
- * @param int $defaultPageId defaultPageId current pageId
+ * @param int $defaultPageId
+ * DefaultPageId current pageId.
*
- * @param $params
+ * @param array $params
*
- * @return int new pageId to display to the user
- * @access public
+ * @return int
+ * new pageId to display to the user
*/
- function getPageID($defaultPageId = 1, &$params) {
+ public function getPageID($defaultPageId = 1, &$params) {
// POST has higher priority than GET vars
// else if a value is set that has higher priority and finally the GET var
$currentPage = $defaultPageId;
if (!empty($_POST)) {
if (isset($_POST[CRM_Utils_Array::value('buttonTop', $params)]) && isset($_POST[self::PAGE_ID])) {
- $currentPage = max((int )@$_POST[self::PAGE_ID], 1);
+ $currentPage = max((int ) @$_POST[self::PAGE_ID], 1);
}
elseif (isset($_POST[$params['buttonBottom']]) && isset($_POST[self::PAGE_ID_BOTTOM])) {
- $currentPage = max((int )@$_POST[self::PAGE_ID_BOTTOM], 1);
+ $currentPage = max((int ) @$_POST[self::PAGE_ID_BOTTOM], 1);
}
elseif (isset($_POST[self::PAGE_ID])) {
- $currentPage = max((int )@$_POST[self::PAGE_ID], 1);
+ $currentPage = max((int ) @$_POST[self::PAGE_ID], 1);
}
elseif (isset($_POST[self::PAGE_ID_BOTTOM])) {
- $currentPage = max((int )@$_POST[self::PAGE_ID_BOTTOM]);
+ $currentPage = max((int ) @$_POST[self::PAGE_ID_BOTTOM]);
}
}
elseif (isset($_GET[self::PAGE_ID])) {
- $currentPage = max((int )@$_GET[self::PAGE_ID], 1);
+ $currentPage = max((int ) @$_GET[self::PAGE_ID], 1);
}
return $currentPage;
}
@@ -224,19 +230,19 @@ class CRM_Utils_Pager extends Pager_Sliding {
/**
* Get the number of rows to display from either a GET / POST variable
*
- * @param int $defaultPageRowCount the default value if not set
- *
- * @return int the rowCount value to use
- * @access public
+ * @param int $defaultPageRowCount
+ * The default value if not set.
*
+ * @return int
+ * the rowCount value to use
*/
- function getPageRowCount($defaultPageRowCount = self::ROWCOUNT) {
+ public function getPageRowCount($defaultPageRowCount = self::ROWCOUNT) {
// POST has higher priority than GET vars
if (isset($_POST[self::PAGE_ROWCOUNT])) {
- $rowCount = max((int )@$_POST[self::PAGE_ROWCOUNT], 1);
+ $rowCount = max((int ) @$_POST[self::PAGE_ROWCOUNT], 1);
}
elseif (isset($_GET[self::PAGE_ROWCOUNT])) {
- $rowCount = max((int )@$_GET[self::PAGE_ROWCOUNT], 1);
+ $rowCount = max((int ) @$_GET[self::PAGE_ROWCOUNT], 1);
}
else {
$rowCount = $defaultPageRowCount;
@@ -249,12 +255,10 @@ class CRM_Utils_Pager extends Pager_Sliding {
*
* @param void
*
- * @return array: an array of the pageID and offset
- *
- * @access public
- *
+ * @return array
+ * an array of the pageID and offset
*/
- function getOffsetAndRowCount() {
+ public function getOffsetAndRowCount() {
$pageId = $this->getCurrentPageID();
if (!$pageId) {
$pageId = 1;
@@ -268,7 +272,7 @@ class CRM_Utils_Pager extends Pager_Sliding {
/**
* @return string
*/
- function getCurrentLocation() {
+ public function getCurrentLocation() {
$config = CRM_Core_Config::singleton();
$path = CRM_Utils_Array::value($config->userFrameworkURLVar, $_GET);
return CRM_Utils_System::url($path, CRM_Utils_System::getLinksUrl(self::PAGE_ID, FALSE, TRUE), FALSE, NULL, FALSE) . $this->getCurrentPageID();
@@ -277,19 +281,19 @@ class CRM_Utils_Pager extends Pager_Sliding {
/**
* @return string
*/
- function getFirstPageLink() {
+ public function getFirstPageLink() {
if ($this->isFirstPage()) {
return '';
}
$href = $this->makeURL(self::PAGE_ID, 1);
return $this->formatLink($href, str_replace('%d', 1, $this->_altFirst), $this->_firstPagePre . $this->_firstPageText . $this->_firstPagePost) .
- $this->_spacesBefore . $this->_spacesAfter;
+ $this->_spacesBefore . $this->_spacesAfter;
}
/**
* @return string
*/
- function getLastPageLink() {
+ public function getLastPageLink() {
if ($this->isLastPage()) {
return '';
}
@@ -300,7 +304,7 @@ class CRM_Utils_Pager extends Pager_Sliding {
/**
* @return string
*/
- function getBackPageLink() {
+ public function getBackPageLink() {
if ($this->_currentPage > 1) {
$href = $this->makeURL(self::PAGE_ID, $this->getPreviousPageID());
return $this->formatLink($href, $this->_altPrev, $this->_prevImg) . $this->_spacesBefore . $this->_spacesAfter;
@@ -311,12 +315,12 @@ class CRM_Utils_Pager extends Pager_Sliding {
/**
* @return string
*/
- function getNextPageLink() {
+ public function getNextPageLink() {
if ($this->_currentPage < $this->_totalPages) {
$href = $this->makeURL(self::PAGE_ID, $this->getNextPageID());
return $this->_spacesAfter .
- $this->formatLink($href, $this->_altNext, $this->_nextImg) .
- $this->_spacesBefore . $this->_spacesAfter;
+ $this->formatLink($href, $this->_altNext, $this->_nextImg) .
+ $this->_spacesBefore . $this->_spacesAfter;
}
return '';
}
@@ -324,7 +328,7 @@ class CRM_Utils_Pager extends Pager_Sliding {
/**
* Build a url for pager links
*/
- function makeURL($key, $value) {
+ public function makeURL($key, $value) {
$href = CRM_Utils_System::makeURL($key, TRUE);
// CRM-12212 Remove alpha sort param
if (strpos($href, '&sortByCharacter=')) {
@@ -344,4 +348,3 @@ class CRM_Utils_Pager extends Pager_Sliding {
return sprintf('', $href, $title, $image);
}
}
-