INFRA-132 - Fix comment spacing

[civicrm-core.git] / CRM / Utils / Pager.php

diff --git a/CRM/Utils/Pager.php b/CRM/Utils/Pager.php
index 9615cccdcca9f94a5893c51d96d9aa11c0ea0527..6a469c5c09bd71f875b2e010e5ff021a6f4f948a 100644 (file)
--- a/CRM/Utils/Pager.php
+++ b/CRM/Utils/Pager.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -51,12 +51,12 @@ require_once 'Pager/Sliding.php';
 class CRM_Utils_Pager extends Pager_Sliding {
 
   /**
-   * constants for static parameters of the pager
+   * Constants for static parameters of the pager
    */
-  CONST ROWCOUNT = 50, PAGE_ID = 'crmPID', PAGE_ID_TOP = 'crmPID', PAGE_ID_BOTTOM = 'crmPID_B', PAGE_ROWCOUNT = 'crmRowCount';
+  const ROWCOUNT = 50, PAGE_ID = 'crmPID', PAGE_ID_TOP = 'crmPID', PAGE_ID_BOTTOM = 'crmPID_B', PAGE_ROWCOUNT = 'crmRowCount';
 
   /**
-   * the output of the pager. This is a name/value array with various keys
+   * The output of the pager. This is a name/value array with various keys
    * that an application could use to display the pager
    * @var array
    */
@@ -68,7 +68,7 @@ class CRM_Utils_Pager extends Pager_Sliding {
    * We have embedded some html in this class. Need to figure out how to export this
    * to the top level at some point in time
    *
-   * @param $params
+   * @param array $params
    *
    * @internal param \total $int the total count of items to be displayed
    * @internal param \currentPage $int the page currently being displayed
@@ -80,7 +80,7 @@ class CRM_Utils_Pager extends Pager_Sliding {
    *
    * @return \CRM_Utils_Pager the newly created and initialized pager object@access public
    */
-  function __construct($params) {
+  public function __construct($params) {
     if ($params['status'] === NULL) {
       $params['status'] = ts('Contacts %%StatusMessage%%');
     }
@@ -129,18 +129,18 @@ class CRM_Utils_Pager extends Pager_Sliding {
   }
 
   /**
-   * 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 +165,6 @@ class CRM_Utils_Pager extends Pager_Sliding {
     $params['prevImg'] = ' ' . ts('&lt; Previous');
     $params['nextImg'] = ts('Next &gt;') . ' ';
 
-
     // set first and last text fragments
     $params['firstPagePre'] = '';
     $params['firstPageText'] = ' ' . ts('&lt;&lt; First');
@@ -190,33 +189,33 @@ 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
    */
-  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 +223,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
+   * @param int $defaultPageRowCount
+   *   The default value if not set.
    *
    * @return int                     the rowCount value to use
-   * @access public
    *
    */
-  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;
@@ -251,10 +250,9 @@ class CRM_Utils_Pager extends Pager_Sliding {
    *
    * @return array: an array of the pageID and offset
    *
-   * @access public
    *
    */
-  function getOffsetAndRowCount() {
+  public function getOffsetAndRowCount() {
     $pageId = $this->getCurrentPageID();
     if (!$pageId) {
       $pageId = 1;
@@ -268,7 +266,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,7 +275,7 @@ class CRM_Utils_Pager extends Pager_Sliding {
   /**
    * @return string
    */
-  function getFirstPageLink() {
+  public function getFirstPageLink() {
     if ($this->isFirstPage()) {
       return '';
     }
@@ -289,7 +287,7 @@ class CRM_Utils_Pager extends Pager_Sliding {
   /**
    * @return string
    */
-  function getLastPageLink() {
+  public function getLastPageLink() {
     if ($this->isLastPage()) {
       return '';
     }
@@ -300,7 +298,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,7 +309,7 @@ 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 .
@@ -324,7 +322,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, '&amp;sortByCharacter=')) {
@@ -344,4 +342,3 @@ class CRM_Utils_Pager extends Pager_Sliding {
     return sprintf('<a class="crm-pager-link action-item crm-hover-button" href="%s" title="%s">%s</a>', $href, $title, $image);
   }
 }
-