X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FUtils%2FPager.php;h=d69f822d461d5bccdb22e2f890a54ba736baa81f;hb=353ffa53c335f7b94ebaddc701e46f2bb30c7048;hp=aa184a1469bdbed757b65ea5a2431f1b7288cb63;hpb=1219e6af26646ad548b2d7e97a7f345af4655c21;p=civicrm-core.git diff --git a/CRM/Utils/Pager.php b/CRM/Utils/Pager.php index aa184a1469..d69f822d46 100644 --- a/CRM/Utils/Pager.php +++ b/CRM/Utils/Pager.php @@ -78,7 +78,8 @@ class CRM_Utils_Pager extends Pager_Sliding { * @internal param \csvString $string the title of the link to be displayed for the export * @internal param \perPage $int the number of items displayed per page * - * @return \CRM_Utils_Pager the newly created and initialized pager object@access public + * @return \CRM_Utils_Pager the newly created and initialized pager object + * @access public */ public function __construct($params) { if ($params['status'] === NULL) { @@ -124,20 +125,26 @@ class CRM_Utils_Pager extends Pager_Sliding { * page variable, but a different form element for one at the bottom * */ - $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'])); + $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 * 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 * * * @return void - * */ public function initialize(&$params) { /* set the mode for the pager to Sliding */ @@ -164,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'); @@ -189,11 +195,13 @@ 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 array $params * - * @return int new pageId to display to the user + * @return int + * new pageId to display to the user */ public function getPageID($defaultPageId = 1, &$params) { // POST has higher priority than GET vars @@ -201,20 +209,20 @@ class CRM_Utils_Pager extends Pager_Sliding { $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; } @@ -222,18 +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 + * @param int $defaultPageRowCount + * The default value if not set. * + * @return int + * the rowCount value to use */ 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; @@ -246,9 +255,8 @@ class CRM_Utils_Pager extends Pager_Sliding { * * @param void * - * @return array: an array of the pageID and offset - * - * + * @return array + * an array of the pageID and offset */ public function getOffsetAndRowCount() { $pageId = $this->getCurrentPageID(); @@ -279,7 +287,7 @@ class CRM_Utils_Pager extends Pager_Sliding { } $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; } /** @@ -311,8 +319,8 @@ class CRM_Utils_Pager extends Pager_Sliding { 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 ''; }