* @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) {
* page variable, but a different form element for one at the bottom
*
*/
- $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']));
- $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']));
+ $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']
+ ));
+ $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']
+ ));
}
/**
* 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 */
$params['prevImg'] = ' ' . ts('< Previous');
$params['nextImg'] = ts('Next >') . ' ';
-
// set first and last text fragments
$params['firstPagePre'] = '';
$params['firstPageText'] = ' ' . ts('<< First');
* 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
$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;
}
/**
* 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;
*
* @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();
}
$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;
}
/**
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 '';
}