Public Member Functions | |
| __construct ($aParams) | |
| setCount ($iCount) | |
| setOnChangePage ($sCode) | |
| setOnChangePerPage ($sCode) | |
| getSorting ($aValues, $sSorting='') | |
| getPages ($iPerPage=-1) | |
| getPaginate ($iStart=-1, $iPerPage=-1, $sTemplate=false) | |
| getSimplePaginate ($sViewAllUrl='', $iStart=-1, $iPerPage=-1, $bViewAll=true) | |
| getMobilePaginate ($iStart=-1, $iPerPage=-1) | |
| _getReplacement () | |
| _getPageChangeUrl ($aReplacement) | |
| _getPageChangeOnClick ($aReplacement) | |
| _getPerPageChanger ($iPerPage=-1) | |
| _getPerPageChangerFloat () | |
| _getPerPageChangerStatic () | |
 Public Member Functions inherited from ChWsbTemplate | |
| __construct ($sRootPath=CH_DIRECTORY_PATH_ROOT, $sRootUrl=CH_WSB_URL_ROOT) | |
| loadTemplates () | |
| init () | |
| addLocation ($sKey, $sLocationPath, $sLocationUrl) | |
| addDynamicLocation ($sLocationPath, $sLocationUrl) | |
| removeLocation ($sKey) | |
| addLocationJs ($sKey, $sLocationPath, $sLocationUrl) | |
| addDynamicLocationJs ($sLocationPath, $sLocationUrl) | |
| removeLocationJs ($sKey) | |
| getCodeKey () | |
| getCode () | |
| getPageWidth () | |
| setPageWidth ($sWidth) | |
| setPageTitle ($sTitle) | |
| setPageMainBoxTitle ($sTitle) | |
| setPageDescription ($sDescription) | |
| addJsOption ($mixedName) | |
| addJsTranslation ($mixedKey) | |
| addJsImage ($aImages) | |
| addJsIcon ($aIcons) | |
| addCssStyle ($sName, $sContent) | |
| addPageKeywords ($mixedKeywords, $sDevider=',') | |
| setOpenGraphInfo ($a, $sNamespace='og') | |
| getMetaInfo () | |
| getTemplate ($sName) | |
| getIconUrl ($sName, $sCheckIn=CH_WSB_TEMPLATE_CHECK_IN_BOTH) | |
| getIconPath ($sName, $sCheckIn=CH_WSB_TEMPLATE_CHECK_IN_BOTH) | |
| getImageUrl ($sName, $sCheckIn=CH_WSB_TEMPLATE_CHECK_IN_BOTH) | |
| getImagePath ($sName, $sCheckIn=CH_WSB_TEMPLATE_CHECK_IN_BOTH) | |
| getCssUrl ($sName, $sCheckIn=CH_WSB_TEMPLATE_CHECK_IN_BOTH) | |
| getCssPath ($sName, $sCheckIn=CH_WSB_TEMPLATE_CHECK_IN_BOTH) | |
| getHtml ($sName, $sCheckIn=CH_WSB_TEMPLATE_CHECK_IN_BOTH) | |
| parseHtmlByName ($sName, $aVariables, $mixedKeyWrapperHtml=null, $sCheckIn=CH_WSB_TEMPLATE_CHECK_IN_BOTH) | |
| parseHtmlByContent ($sContent, $aVariables, $mixedKeyWrapperHtml=null) | |
| parseHtmlByTemplateName ($sName, $aVariables, $mixedKeyWrapperHtml=null) | |
| parsePageByName ($sName, $aVariables) | |
| parseSystemKey ($sKey, $mixedKeyWrapperHtml=null) | |
| getTemplatesCacheObject () | |
| getCached ($sName, &$aVariables, $mixedKeyWrapperHtml=null, $sCheckIn=CH_WSB_TEMPLATE_CHECK_IN_BOTH, $bEvaluate=true) | |
| addJs ($mixedFiles, $bDynamic=false) | |
| addJsSystem ($mixedFiles) | |
| deleteJs ($mixedFiles) | |
| deleteJsSystem ($mixedFiles) | |
| _compileJs ($sAbsolutePath, &$aIncluded) | |
| _wrapInTagJs ($sFile) | |
| _wrapInTagJsCode ($sCode) | |
| addCss ($mixedFiles, $bDynamic=false) | |
| addCssAsync ($mixedFiles) | |
| includeCssAsync () | |
| addCssSystem ($mixedFiles) | |
| deleteCss ($mixedFiles) | |
| deleteCssSystem ($mixedFiles) | |
| _compileCss ($sAbsolutePath, &$aIncluded) | |
| _minifyCss ($s) | |
| _wrapInTagCss ($sFile) | |
| _wrapInTagCssCode ($sCode) | |
| includeCssStyles () | |
| includeFiles ($sType, $bSystem=false) | |
| _includeFiles ($sType, &$aFiles) | |
| _processFiles ($sType, $sAction, $mixedFiles, $bDynamic=false, $bSystem=false) | |
| _parseContent ($sContent, $aVariables, $mixedKeyWrapperHtml=null) | |
| _compileContent ($sContent, $aVarName, $iVarDepth, $aVarValues, $mixedKeyWrapperHtml=null) | |
| _getAbsoluteLocation ($sType, $sFolder, $sName, $sCheckIn=CH_WSB_TEMPLATE_CHECK_IN_BOTH) | |
| _getAbsoluteLocationJs ($sType, $sName) | |
| _getAbsoluteLocationCss ($sType, $sName) | |
| _getInlineData ($sType, $sName, $sCheckIn) | |
| _getCacheFileName ($sType, $sAbsolutePath) | |
| _getKeyWrappers ($mixedKeyWrapperHtml) | |
| _processJsTranslations () | |
| _processJsOptions () | |
| _processJsImages () | |
| _getLoaderUrl ($sType, $sName) | |
| displayAccessDenied () | |
| displayNoData () | |
| displayErrorOccured () | |
| displayPageNotFound () | |
| displayMsg ($s, $bTranslate=false) | |
| processInjection ($iPageIndex, $sKey, $sValue="") | |
| addInjection ($sKey, $sType, $sData, $iReplace=0) | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ChWsbTemplate | |
| static | _callbackParseUrl ($sPath, $aMatches) |
Detailed Description
Paginage for any content.
It is used to create paginate, configuring it via input parameters. The list of available input parameters: — Main parameters start - position of the first item. count - total number of items. per_page - number of items displayed on the page. sorting - sorting order. page_url - current page URL. view_all_url - URL for 'view all' page. range - number of pages from the left and rigth sides of the current page. page - current page.
— JS mode parameters on_change_page - JavaScript function to be called on change page. on_change_per_page - JavaScript function to be called on change number of results per page. on_change_sorting - JavaScript function to be called on change the sorting order.
— Per page parameters per_page_step - difference between two nearest per page values. per_page_interval - number of values from the left and rigth sides of the current page page value.
— Layout parameters info - display info. view_all - display 'View All' link. page_reloader - display 'Reloader' button. per_page_changer - display 'Per page' dropdown. page_links - display page links.
Example of usage: $oPaginate = new ChWsbPaginate(array( 'start' => 0, 'count' => 100, 'per_page' => 10, 'on_change_page' => 'changePage({start}, {per_page})' )); $oPaginate->getPaginate();
Memberships/ACL: Doesn't depend on user's membership.
Alerts: no alerts available
Definition at line 68 of file ChWsbPaginate.php.
Constructor & Destructor Documentation
◆ __construct()
| ChWsbPaginate::__construct | ( | $aParams | ) |
Constructor
Definition at line 106 of file ChWsbPaginate.php.
Member Function Documentation
◆ _getPageChangeOnClick()
| ChWsbPaginate::_getPageChangeOnClick | ( | $aReplacement | ) |
Definition at line 423 of file ChWsbPaginate.php.
◆ _getPageChangeUrl()
| ChWsbPaginate::_getPageChangeUrl | ( | $aReplacement | ) |
Definition at line 419 of file ChWsbPaginate.php.
◆ _getPerPageChanger()
| ChWsbPaginate::_getPerPageChanger | ( | $iPerPage = -1 | ) |
Definition at line 427 of file ChWsbPaginate.php.
◆ _getPerPageChangerFloat()
| ChWsbPaginate::_getPerPageChangerFloat | ( | ) |
Definition at line 439 of file ChWsbPaginate.php.
◆ _getPerPageChangerStatic()
| ChWsbPaginate::_getPerPageChangerStatic | ( | ) |
Definition at line 470 of file ChWsbPaginate.php.
◆ _getReplacement()
| ChWsbPaginate::_getReplacement | ( | ) |
Definition at line 408 of file ChWsbPaginate.php.
◆ getMobilePaginate()
| ChWsbPaginate::getMobilePaginate | ( | $iStart = -1, |
|
$iPerPage = -1 |
|||
| ) |
Definition at line 386 of file ChWsbPaginate.php.
◆ getPages()
| ChWsbPaginate::getPages | ( | $iPerPage = -1 | ) |
Definition at line 196 of file ChWsbPaginate.php.
◆ getPaginate()
| ChWsbPaginate::getPaginate | ( | $iStart = -1, |
|
$iPerPage = -1, |
|||
$sTemplate = false |
|||
| ) |
Definition at line 200 of file ChWsbPaginate.php.
◆ getSimplePaginate()
| ChWsbPaginate::getSimplePaginate | ( | $sViewAllUrl = '', |
|
$iStart = -1, |
|||
$iPerPage = -1, |
|||
$bViewAll = true |
|||
| ) |
Definition at line 372 of file ChWsbPaginate.php.
◆ getSorting()
| ChWsbPaginate::getSorting | ( | $aValues, | |
$sSorting = '' |
|||
| ) |
Definition at line 167 of file ChWsbPaginate.php.
◆ setCount()
| ChWsbPaginate::setCount | ( | $iCount | ) |
Definition at line 155 of file ChWsbPaginate.php.
◆ setOnChangePage()
| ChWsbPaginate::setOnChangePage | ( | $sCode | ) |
Definition at line 159 of file ChWsbPaginate.php.
◆ setOnChangePerPage()
| ChWsbPaginate::setOnChangePerPage | ( | $sCode | ) |
Definition at line 163 of file ChWsbPaginate.php.
Member Data Documentation
◆ $_bInfo
| ChWsbPaginate::$_bInfo |
Definition at line 96 of file ChWsbPaginate.php.
◆ $_bPageLinks
| ChWsbPaginate::$_bPageLinks |
Definition at line 100 of file ChWsbPaginate.php.
◆ $_bPageLinksFirstLast
| ChWsbPaginate::$_bPageLinksFirstLast |
Definition at line 101 of file ChWsbPaginate.php.
◆ $_bPageReloader
| ChWsbPaginate::$_bPageReloader |
Definition at line 98 of file ChWsbPaginate.php.
◆ $_bPerPageChanger
| ChWsbPaginate::$_bPerPageChanger |
Definition at line 99 of file ChWsbPaginate.php.
◆ $_bViewAll
| ChWsbPaginate::$_bViewAll |
Definition at line 97 of file ChWsbPaginate.php.
◆ $_iCount
| ChWsbPaginate::$_iCount |
Definition at line 71 of file ChWsbPaginate.php.
◆ $_iPage
| ChWsbPaginate::$_iPage |
Definition at line 76 of file ChWsbPaginate.php.
◆ $_iPages
| ChWsbPaginate::$_iPages |
Definition at line 77 of file ChWsbPaginate.php.
◆ $_iPerPage
| ChWsbPaginate::$_iPerPage |
Definition at line 72 of file ChWsbPaginate.php.
◆ $_iPerPageInterval
| ChWsbPaginate::$_iPerPageInterval |
Definition at line 93 of file ChWsbPaginate.php.
◆ $_iPerPageStep
| ChWsbPaginate::$_iPerPageStep |
Definition at line 92 of file ChWsbPaginate.php.
◆ $_iRange
| ChWsbPaginate::$_iRange |
Definition at line 75 of file ChWsbPaginate.php.
◆ $_iStart
| ChWsbPaginate::$_iStart |
Definition at line 70 of file ChWsbPaginate.php.
◆ $_sButtonActiveTmpl
| ChWsbPaginate::$_sButtonActiveTmpl |
Definition at line 84 of file ChWsbPaginate.php.
◆ $_sButtonActiveTmplMobile
| ChWsbPaginate::$_sButtonActiveTmplMobile |
Definition at line 85 of file ChWsbPaginate.php.
◆ $_sButtonInactiveTmpl
| ChWsbPaginate::$_sButtonInactiveTmpl |
Definition at line 86 of file ChWsbPaginate.php.
◆ $_sLinkActiveTmpl
| ChWsbPaginate::$_sLinkActiveTmpl |
Definition at line 87 of file ChWsbPaginate.php.
◆ $_sLinkInactiveTmpl
| ChWsbPaginate::$_sLinkInactiveTmpl |
Definition at line 88 of file ChWsbPaginate.php.
◆ $_sOnChangePage
| ChWsbPaginate::$_sOnChangePage |
Definition at line 80 of file ChWsbPaginate.php.
◆ $_sOnChangePerPage
| ChWsbPaginate::$_sOnChangePerPage |
Definition at line 81 of file ChWsbPaginate.php.
◆ $_sOnChangeSorting
| ChWsbPaginate::$_sOnChangeSorting |
Definition at line 82 of file ChWsbPaginate.php.
◆ $_sPageUrl
| ChWsbPaginate::$_sPageUrl |
Definition at line 74 of file ChWsbPaginate.php.
◆ $_sPerPageType
| ChWsbPaginate::$_sPerPageType |
Definition at line 91 of file ChWsbPaginate.php.
◆ $_sPerPageValues
| ChWsbPaginate::$_sPerPageValues |
Definition at line 94 of file ChWsbPaginate.php.
◆ $_sSorting
| ChWsbPaginate::$_sSorting |
Definition at line 73 of file ChWsbPaginate.php.
◆ $_sSortingTmpl
| ChWsbPaginate::$_sSortingTmpl |
Definition at line 89 of file ChWsbPaginate.php.
◆ $_sViewAllUrl
| ChWsbPaginate::$_sViewAllUrl |
Definition at line 78 of file ChWsbPaginate.php.
The documentation for this class was generated from the following file:
- inc/classes/ChWsbPaginate.php
