CRM_Utils_PagerAToZ
in package
This class is for displaying alphabetical bar
Table of Contents
Methods
- createLinks() : array<string|int, mixed>
- Create the links.
- getAToZBar() : string
- Returns the alphabetic array for sorting by character.
- getDynamicCharacters() : array<string|int, mixed>
- Return the all the dynamic characters.
- getStaticCharacters() : array<string|int, mixed>
- Return the all the static characters.
Methods
createLinks()
Create the links.
public
static createLinks(array<string|int, mixed> &$query, string $sortByCharacter, mixed $isDAO) : array<string|int, mixed>
Parameters
- $query : array<string|int, mixed>
-
The form values for search.
- $sortByCharacter : string
-
The character that we are potentially sorting on.
- $isDAO : mixed
Tags
Return values
array<string|int, mixed> —with links
getAToZBar()
Returns the alphabetic array for sorting by character.
public
static getAToZBar(array<string|int, mixed> &$query, string $sortByCharacter[, bool $isDAO = FALSE ]) : string
Parameters
- $query : array<string|int, mixed>
-
The query object.
- $sortByCharacter : string
-
The character that we are potentially sorting on.
- $isDAO : bool = FALSE
Return values
string —The html formatted string
getDynamicCharacters()
Return the all the dynamic characters.
public
static getDynamicCharacters(mixed &$query, mixed $isDAO) : array<string|int, mixed>
Parameters
- $query : mixed
- $isDAO : mixed
Return values
array<string|int, mixed> —is an array of dynamic characters
getStaticCharacters()
Return the all the static characters.
public
static getStaticCharacters() : array<string|int, mixed>
Return values
array<string|int, mixed> —is an array of static characters