Merge pull request #5292 from jitendrapurohit/CRM-15933

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

diff --git a/CRM/Utils/PagerAToZ.php b/CRM/Utils/PagerAToZ.php
index 73a355a14eb887b43e5e089341735578708249ab..655a47ac04146d11c704268a72b1821b23703734 100644 (file)
--- a/CRM/Utils/PagerAToZ.php
+++ b/CRM/Utils/PagerAToZ.php
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -40,15 +40,17 @@
 class CRM_Utils_PagerAToZ {
 
   /**
-   * Returns the alphabetic array for sorting by character
+   * Returns the alphabetic array for sorting by character.
    *
-   * @param array $query The query object
-   * @param string $sortByCharacter The character that we are potentially sorting on
+   * @param array $query
+   *   The query object.
+   * @param string $sortByCharacter
+   *   The character that we are potentially sorting on.
    *
    * @param bool $isDAO
    *
-   * @return string                 The html formatted string
-   * @static
+   * @return string
+   *   The html formatted string
    */
   public static function getAToZBar(&$query, $sortByCharacter, $isDAO = FALSE) {
     $AToZBar = self::createLinks($query, $sortByCharacter, $isDAO);
@@ -56,24 +58,51 @@ class CRM_Utils_PagerAToZ {
   }
 
   /**
-   * Return the all the static characters
+   * Return the all the static characters.
    *
-   * @return array $staticAlphabets is a array of static characters
-   * @static
+   * @return array
+   *   is a array of static characters
    */
   public static function getStaticCharacters() {
-    $staticAlphabets = array('A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z');
+    $staticAlphabets = array(
+      'A',
+      'B',
+      'C',
+      'D',
+      'E',
+      'F',
+      'G',
+      'H',
+      'I',
+      'J',
+      'K',
+      'L',
+      'M',
+      'N',
+      'O',
+      'P',
+      'Q',
+      'R',
+      'S',
+      'T',
+      'U',
+      'V',
+      'W',
+      'X',
+      'Y',
+      'Z',
+    );
     return $staticAlphabets;
   }
 
   /**
-   * Return the all the dynamic characters
+   * Return the all the dynamic characters.
    *
    * @param $query
    * @param $isDAO
    *
-   * @return array $dynamicAlphabets is a array of dynamic characters
-   * @static
+   * @return array
+   *   is a array of dynamic characters
    */
   public static function getDynamicCharacters(&$query, $isDAO) {
     if ($isDAO) {
@@ -94,15 +123,17 @@ class CRM_Utils_PagerAToZ {
   }
 
   /**
-   * Create the links
+   * Create the links.
    *
-   * @param array $query The form values for search
-   * @param string $sortByCharacter The character that we are potentially sorting on
+   * @param array $query
+   *   The form values for search.
+   * @param string $sortByCharacter
+   *   The character that we are potentially sorting on.
    *
    * @param $isDAO
    *
-   * @return array with links
-   * @static
+   * @return array
+   *   with links
    */
   public static function createLinks(&$query, $sortByCharacter, $isDAO) {
     $AToZBar = self::getStaticCharacters();
@@ -119,7 +150,7 @@ class CRM_Utils_PagerAToZ {
     //get the current path
     $path = CRM_Utils_System::currentPath();
 
-    $qfKey = null;
+    $qfKey = NULL;
     if (isset($query->_formValues)) {
       $qfKey = CRM_Utils_Array::value('qfKey', $query->_formValues);
     }
@@ -167,4 +198,5 @@ class CRM_Utils_PagerAToZ {
     $aToZBar[] = array('item' => $url);
     return $aToZBar;
   }
+
 }