phpcs fix
[civicrm-core.git] / CRM / Utils / Pager.php
index d69f822d461d5bccdb22e2f890a54ba736baa81f..873392017bb401cf66edc8bcee765d59c09b6c39 100644 (file)
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  */
@@ -70,16 +70,7 @@ class CRM_Utils_Pager extends Pager_Sliding {
    *
    * @param array $params
    *
-   * @internal param \total $int the total count of items to be displayed
-   * @internal param \currentPage $int the page currently being displayed
-   * @internal param \status $string the status message to be displayed. It embeds a token
-   *                             %%statusMessage%% that will be replaced with which items
-   *                             are currently being displayed
-   * @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
    */
   public function __construct($params) {
     if ($params['status'] === NULL) {
@@ -127,17 +118,17 @@ class CRM_Utils_Pager extends Pager_Sliding {
      */
     $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']
+        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']
+        2 => $this->_response['numPages'],
       ));
   }
 
   /**
    * Helper function to assign remaining pager options as good default
-   * values
+   * values.
    *
    * @param array $params
    *   The set of options needed to initialize the parent.
@@ -251,9 +242,7 @@ class CRM_Utils_Pager extends Pager_Sliding {
   }
 
   /**
-   * Use the pager class to get the pageId and Offset
-   *
-   * @param void
+   * Use the pager class to get the pageId and Offset.
    *
    * @return array
    *   an array of the pageID and offset
@@ -326,7 +315,7 @@ class CRM_Utils_Pager extends Pager_Sliding {
   }
 
   /**
-   * Build a url for pager links
+   * Build a url for pager links.
    */
   public function makeURL($key, $value) {
     $href = CRM_Utils_System::makeURL($key, TRUE);
@@ -338,7 +327,7 @@ class CRM_Utils_Pager extends Pager_Sliding {
   }
 
   /**
-   * Output the html pager link
+   * Output the html pager link.
    * @param string $href
    * @param string $title
    * @param string $image
@@ -347,4 +336,5 @@ class CRM_Utils_Pager extends Pager_Sliding {
   private function formatLink($href, $title, $image) {
     return sprintf('<a class="crm-pager-link action-item crm-hover-button" href="%s" title="%s">%s</a>', $href, $title, $image);
   }
+
 }