Joomla CMS
3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
|
Fonctions membres publiques | |
__construct ($total, $limitstart, $limit, $prefix='', CMSApplication $app=null) | |
setAdditionalUrlParam ($key, $value) | |
getAdditionalUrlParam ($key) | |
getRowOffset ($index) | |
getData () | |
getPagesCounter () | |
getResultsCounter () | |
getPagesLinks () | |
getPaginationLinks ($layoutId='joomla.pagination.links', $options=array()) | |
getPaginationPages () | |
getListFooter () | |
getLimitBox () | |
orderUpIcon ($i, $condition=true, $task='orderup', $alt='JLIB_HTML_MOVE_UP', $enabled=true, $checkbox='cb') | |
orderDownIcon ($i, $n, $condition=true, $task='orderdown', $alt='JLIB_HTML_MOVE_DOWN', $enabled=true, $checkbox='cb') | |
set ($property, $value=null) | |
get ($property, $default=null) | |
Champs de données | |
$limitstart = null | |
$limit = null | |
$total = null | |
$prefix = null | |
$pagesStart | |
$pagesStop | |
$pagesCurrent | |
$pagesTotal | |
$hideEmptyLimitstart = false | |
Fonctions membres protégées | |
_list_footer ($list) | |
_list_render ($list) | |
_item_active (PaginationObject $item) | |
_item_inactive (PaginationObject $item) | |
_buildDataObject () | |
Attributs protégés | |
$viewall = false | |
$additionalUrlParams = array() | |
$app = null | |
$data | |
Pagination Class. Provides a common interface for content pagination for the Joomla! CMS.
__construct | ( | $total, | |
$limitstart, | |||
$limit, | |||
$prefix = '' , |
|||
CMSApplication | $app = null |
||
) |
Constructor.
integer | $total | The total number of items. |
integer | $limitstart | The offset of the item to start at. |
integer | $limit | The number of items to display per page. |
string | $prefix | The prefix used for request variables. |
CMSApplication | $app | The application object |
Références $app, $limit, $pagesTotal, $prefix, $total, et prefix.
|
protected |
|
protected |
Method to create an active pagination link to the item
PaginationObject | $item | The object with which to make an active link. |
|
protected |
Method to create an inactive pagination string
PaginationObject | $item | The item to be processed |
Références $item.
|
protected |
Create the HTML for a list footer
array | $list | Pagination list data structure. |
|
protected |
Create the html for a list footer
array | $list | Pagination list data structure. |
Références $list.
get | ( | $property, | |
$default = null |
|||
) |
getAdditionalUrlParam | ( | $key | ) |
getData | ( | ) |
Return the pagination data object, only creating it if it doesn't already exist.
Références $data.
getLimitBox | ( | ) |
getListFooter | ( | ) |
Return the pagination footer.
Références $list, JPATH_THEMES, pagination_list_footer(), et prefix.
getPagesCounter | ( | ) |
Create and return the pagination pages counter string, ie. Page 2 of 4.
getPagesLinks | ( | ) |
Create and return the pagination page list string, ie. Previous, Next, 1 2 3 ... x.
Références $data, $i, $list, $prefix, JPATH_THEMES, null, pagination_item_active(), pagination_item_inactive(), et pagination_list_render().
getPaginationLinks | ( | $layoutId = 'joomla.pagination.links' , |
|
$options = array() |
|||
) |
getPaginationPages | ( | ) |
Create and return the pagination pages list, ie. Previous, Next, 1 2 3 ... x.
getResultsCounter | ( | ) |
Create and return the pagination result set counter string, e.g. Results 1-10 of 42
getRowOffset | ( | $index | ) |
Return the rationalised offset for a row with a given index.
integer | $index | The row index |
orderDownIcon | ( | $i, | |
$n, | |||
$condition = true , |
|||
$task = 'orderdown' , |
|||
$alt = 'JLIB_HTML_MOVE_DOWN' , |
|||
$enabled = true , |
|||
$checkbox = 'cb' |
|||
) |
Return the icon to move an item DOWN.
integer | $i | The row index. |
integer | $n | The number of items in the list. |
boolean | $condition | True to show the icon. |
string | $task | The task to fire. |
string | $alt | The image alternative text string. |
boolean | $enabled | An optional setting for access control on the action. |
string | $checkbox | An optional prefix for checkboxes. |
Références $alt, $condition, $enabled, $i, et $task.
orderUpIcon | ( | $i, | |
$condition = true , |
|||
$task = 'orderup' , |
|||
$alt = 'JLIB_HTML_MOVE_UP' , |
|||
$enabled = true , |
|||
$checkbox = 'cb' |
|||
) |
Return the icon to move an item UP.
integer | $i | The row index. |
boolean | $condition | True to show the icon. |
string | $task | The task to fire. |
string | $alt | The image alternative text string. |
boolean | $enabled | An optional setting for access control on the action. |
string | $checkbox | An optional prefix for checkboxes. |
Références $alt, $condition, $enabled, $i, et $task.
set | ( | $property, | |
$value = null |
|||
) |
setAdditionalUrlParam | ( | $key, | |
$value | |||
) |
Method to set an additional URL parameter to be added to all pagination class generated links.
string | $key | The name of the URL parameter for which to set a value. |
mixed | $value | The value to set for the URL parameter. |
|
protected |
|
protected |
|
protected |
$hideEmptyLimitstart = false |
$limit = null |
$limitstart = null |
$pagesCurrent |
$pagesStart |
$pagesStop |
$pagesTotal |
$total = null |
|
protected |