class CRM_Utils_PagerAToZ

This class is for displaying alphabetical bar

Methods

static string
getAToZBar(array $query, string $sortByCharacter, bool $isDAO = FALSE)

Returns the alphabetic array for sorting by character.

static array
getStaticCharacters()

Return the all the static characters.

static array
getDynamicCharacters($query, $isDAO)

Return the all the dynamic characters.

static array
createLinks(array $query, string $sortByCharacter, $isDAO)

Create the links.

Details

at line 51
static string getAToZBar(array $query, string $sortByCharacter, bool $isDAO = FALSE)

Returns the alphabetic array for sorting by character.

Parameters

array $query The query object.
string $sortByCharacter The character that we are potentially sorting on.
bool $isDAO

Return Value

string The html formatted string

at line 62
static array getStaticCharacters()

Return the all the static characters.

Return Value

array is an array of static characters

at line 103
static array getDynamicCharacters($query, $isDAO)

Return the all the dynamic characters.

Parameters

$query
$isDAO

Return Value

array is an array of dynamic characters

Create the links.

Parameters

array $query The form values for search.
string $sortByCharacter The character that we are potentially sorting on.
$isDAO

Return Value

array with links