X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FUtils%2FPagerAToZ.php;h=655a47ac04146d11c704268a72b1821b23703734;hb=1578e7cf94a9d31c7ef3a853f2a092bcd22c8012;hp=c103086edebc8dcfb5a5bc954297a75eb86d6deb;hpb=11df99209d13885aaf45a5c94612bdc65eb490ff;p=civicrm-core.git diff --git a/CRM/Utils/PagerAToZ.php b/CRM/Utils/PagerAToZ.php index c103086ede..655a47ac04 100644 --- 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,45 +40,71 @@ 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 - * @access public - * @static + * @return string + * The html formatted string */ - static function getAToZBar(&$query, $sortByCharacter, $isDAO = FALSE) { + public static function getAToZBar(&$query, $sortByCharacter, $isDAO = FALSE) { $AToZBar = self::createLinks($query, $sortByCharacter, $isDAO); return $AToZBar; } /** - * Return the all the static characters + * Return the all the static characters. * - * @return array $staticAlphabets is a array of static characters - * @access private - * @static + * @return array + * is a array of static characters */ - 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'); + 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', + ); 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 - * @access private - * @static + * @return array + * is a array of dynamic characters */ - static function getDynamicCharacters(&$query, $isDAO) { + public static function getDynamicCharacters(&$query, $isDAO) { if ($isDAO) { $result = $query; } @@ -97,18 +123,19 @@ 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 - * @access private - * @static + * @return array + * with links */ - static function createLinks(&$query, $sortByCharacter, $isDAO) { + public static function createLinks(&$query, $sortByCharacter, $isDAO) { $AToZBar = self::getStaticCharacters(); $dynamicAlphabets = self::getDynamicCharacters($query, $isDAO); @@ -123,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); } @@ -171,5 +198,5 @@ class CRM_Utils_PagerAToZ { $aToZBar[] = array('item' => $url); return $aToZBar; } -} +}