claro_pager Class Reference
Public Member Functions | |
| claro_pager ($totalItemCount, $offset=0, $step=20) | |
| set_pager_call_param_name ($paramName) | |
| get_total_item_count () | |
| get_offset_count () | |
| get_previous_offset () | |
| get_next_offset () | |
| get_first_offset () | |
| get_last_offset () | |
| get_offset_list () | |
| disp_pager_tool_bar ($url, $linkMax=10) | |
Data Fields | |
| $offsetCount = null | |
Detailed Description
Definition at line 25 of file pager.lib.php.
Member Function Documentation
| claro_pager | ( | $ | totalItemCount, | |
| $ | offset = 0, |
|||
| $ | step = 20 | |||
| ) |
Constructor
- Parameters:
-
string $sql current SQL query int $offset requested offset int $step current step paging
- Returns:
- void
- Since:
Definition at line 39 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 in claro_sql_pager, and claro_array_pager.
Definition at line 168 of file pager.lib.php.
| get_first_offset | ( | ) |
return the offset needed to get the first page
- Returns:
- int
Definition at line 120 of file pager.lib.php.
| get_last_offset | ( | ) |
return the offset needed to get the last page
- Returns:
- int
Definition at line 131 of file pager.lib.php.
| get_next_offset | ( | ) |
return the offset needed to get the next page
- Returns:
- int
Definition at line 106 of file pager.lib.php.
| get_offset_count | ( | ) |
get the number of offsets needed to build a complete pager
- Returns:
- int
Definition at line 76 of file pager.lib.php.
| get_offset_list | ( | ) |
return the offsets list needed for each page
- Returns:
- array of int
Definition at line 142 of file pager.lib.php.
| get_previous_offset | ( | ) |
return the offset needed to get the previous page
- Returns:
- int
Definition at line 92 of file pager.lib.php.
| get_total_item_count | ( | ) |
get the total number of the complete the results
- Returns:
- int
- Since:
Reimplemented in claro_sql_pager.
Definition at line 66 of file pager.lib.php.
| set_pager_call_param_name | ( | $ | paramName | ) |
Allows to change the parameter name in the url for page change request. By default, this parameter name is 'offset'.
- Parameters:
-
string paramName
- Returns:
- null
- Since:
Definition at line 55 of file pager.lib.php.
Field Documentation
| $offsetCount = null |
Reimplemented in claro_sql_pager, and claro_array_pager.
Definition at line 27 of file pager.lib.php.
The documentation for this class was generated from the following file:
- claroline/claroline/inc/lib/pager.lib.php
