claro_array_pager Class Reference
Public Member Functions | |
| claro_array_pager ($array, $offset=0, $step=20) | |
| set_sort_key_call_param_name ($paramName) | |
| set_sort_dir_call_param_name ($paramName) | |
| get_result_list () | |
| compare_array_rows ($row1, $row2) | |
| set_sort_key ($key, $direction) | |
| set_multiple_sort_keys ($keyList) | |
| add_sort_key ($key, $direction) | |
| get_sort_url_list ($url, $defaultArrayKeyList=array(), $context=null) | |
| disp_pager_tool_bar ($url, $linkMax=10) | |
Data Fields | |
| $sortKeyList = array() | |
| $totalItemCount = null | |
| $offsetCount = null | |
| $resultList = null | |
Detailed Description
Pager class allowing to manage a paging system from a an array containing all the concerned items
Definition at line 619 of file pager.lib.php.
Member Function Documentation
| add_sort_key | ( | $ | key, | |
| $ | direction | |||
| ) |
Definition at line 720 of file pager.lib.php.
| claro_array_pager | ( | $ | array, | |
| $ | offset = 0, |
|||
| $ | step = 20 | |||
| ) |
constructor
Definition at line 629 of file pager.lib.php.
| compare_array_rows | ( | $ | row1, | |
| $ | row2 | |||
| ) |
This method is dedicated to the usort() process into get_result_list() method private
Definition at line 680 of file pager.lib.php.
| disp_pager_tool_bar | ( | $ | url, | |
| $ | linkMax = 10 | |||
| ) |
Display a standart pager tool bar
- Parameters:
-
string $url - where the pager tool bar commands need to point to int $linkMax - (optionnal) maximum of page links in the pager tool bar
- Returns:
- string
Reimplemented from claro_pager.
Definition at line 779 of file pager.lib.php.
| get_result_list | ( | ) |
Definition at line 659 of file pager.lib.php.
| get_sort_url_list | ( | $ | url, | |
| $ | defaultArrayKeyList = array(), |
|||
| $ | context = null | |||
| ) |
Definition at line 734 of file pager.lib.php.
| set_multiple_sort_keys | ( | $ | keyList | ) |
Set multiple sorting for the result returned by the query.
- Parameters:
-
array $keyList - each array key are the sort keys it has to be something understable by the SQL parser. while each array values are sort direction of the concerned key
Definition at line 714 of file pager.lib.php.
| set_sort_dir_call_param_name | ( | $ | paramName | ) |
Allows to change the parameter name in the url for sort direction request. By default, this parameter name is 'dir'.
- Parameters:
-
string paramName
Definition at line 654 of file pager.lib.php.
| set_sort_key | ( | $ | key, | |
| $ | direction | |||
| ) |
Set a specificic sorting for the result returned by the query.
- Parameters:
-
string $key - has to be something understable by the SQL parser. string $direction use PHP constants SORT_ASC and SORT_DESC
Definition at line 701 of file pager.lib.php.
| set_sort_key_call_param_name | ( | $ | paramName | ) |
Allows to change the parameter name in the url for sort key request. By default, this parameter name is 'sort'.
- Parameters:
-
string paramName
Definition at line 643 of file pager.lib.php.
Field Documentation
| $offsetCount = null |
Reimplemented from claro_pager.
Definition at line 622 of file pager.lib.php.
| $resultList = null |
Definition at line 623 of file pager.lib.php.
| $sortKeyList = array() |
Definition at line 621 of file pager.lib.php.
| $totalItemCount = null |
Definition at line 622 of file pager.lib.php.
The documentation for this class was generated from the following file:
- claroline/claroline/inc/lib/pager.lib.php
