CRM_Utils_Pager

class CRM_Utils_Pager extends Pager_Sliding

Class CRM_Utils_Pager

Constants

ROWCOUNT

Constants for static parameters of the pager
PAGE_ID

Constants for static parameters of the pager
PAGE_ID_TOP

Constants for static parameters of the pager
PAGE_ID_BOTTOM

Constants for static parameters of the pager
PAGE_ROWCOUNT

Constants for static parameters of the pager

Properties

array $_response The output of the pager. This is a name/value array with various keys that an application could use to display the pager

Methods

CRM_Utils_Pager
__construct(array $params)

The pager constructor. Takes a few values, and then assigns a lot of defaults to the PEAR pager class We have embedded some html in this class. Need to figure out how to export this to the top level at some point in time

array
initialize(array $params)

Helper function to assign remaining pager options as good default values.

int
getPageID(int $defaultPageId = 1, array $params)

Figure out the current page number based on value of GET / POST variables. Hierarchy rules are followed, POST over-rides a GET, a POST at the top overrides a POST at the bottom (of the page)

int
getPageRowCount(int $defaultPageRowCount = self::ROWCOUNT)

Get the number of rows to display from either a GET / POST variable

array
getOffsetAndRowCount()

Use the pager class to get the pageId and Offset.

string
getCurrentLocation()

No description

string
getFirstPageLink()

No description

string
getLastPageLink()

No description

string
getBackPageLink()

No description

string
getNextPageLink()

No description

string
makeURL(string $key, string $value)

Build a url for pager links.

Details

at line 71
CRM_Utils_Pager __construct(array $params)

The pager constructor. Takes a few values, and then assigns a lot of defaults to the PEAR pager class We have embedded some html in this class. Need to figure out how to export this to the top level at some point in time

Parameters

array $params

Return Value

CRM_Utils_Pager the newly created and initialized pager object

at line 133
array initialize(array $params)

Helper function to assign remaining pager options as good default values.

Parameters

array $params The set of options needed to initialize the parent constructor.

Return Value

array

at line 190
int getPageID(int $defaultPageId = 1, array $params)

Figure out the current page number based on value of GET / POST variables. Hierarchy rules are followed, POST over-rides a GET, a POST at the top overrides a POST at the bottom (of the page)

Parameters

int $defaultPageId DefaultPageId current pageId.
array $params

Return Value

int new pageId to display to the user

at line 223
int getPageRowCount(int $defaultPageRowCount = self::ROWCOUNT)

Get the number of rows to display from either a GET / POST variable

Parameters

int $defaultPageRowCount The default value if not set.

Return Value

int the rowCount value to use

at line 243
array getOffsetAndRowCount()

Use the pager class to get the pageId and Offset.

Return Value

array an array of the pageID and offset

at line 257
string getCurrentLocation()

Return Value

string

Return Value

string

Return Value

string

Return Value

string

Return Value

string

at line 318
string makeURL(string $key, string $value)

Build a url for pager links.

Parameters

string $key
string $value

Return Value

string