| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
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;
}
}
/**
- * 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);
//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);
}
$aToZBar[] = array('item' => $url);
return $aToZBar;
}
-}
+}