Class APager

Abstract pager class

XLite\Base\SuperClass

XLite\Base\Singleton

XLite\Base

XLite\Core\Handler

XLite\View\AView

XLite\View\RequestHandler\ARequestHandler

XLite\View\Pager\APager

Direct known subclasses

XLite\Module\CDev\Bestsellers\View\Pager\Pager, XLite\Module\CDev\FeaturedProducts\View\Pager\Pager, XLite\View\Pager, XLite\View\Pager\Admin\AAdmin, XLite\View\Pager\Customer\ACustomer

Indirect known subclasses

Abstract
Namespace: XLite\View\Pager
Since: 1.0.0
See: ____class_see____
Located at XLite/View/Pager/APager.php

Methods summary
`abstract protected integer`	# `getItemsPerPageDefault( )` Return number of items per page Return number of items per page Returns `integer` Since 1.0.0 See ____func_see____
`abstract protected integer`	# `getPagesPerFrame( )` Return number of pages to display Return number of pages to display Returns `integer` Since 1.0.0 See ____func_see____
`public array`	# `getCSSFiles( )` Register CSS files Register CSS files Returns `array` Since 1.0.0 See ____func_see____
`public string`	# `getCSSClasses( )` Return CSS classes for parent block of pager (list-pager by default) Return CSS classes for parent block of pager (list-pager by default) Returns `string` Since 1.0.0 See ____func_see____
`public array\|Doctrine\ORM\PersistentCollection`	# `getLimitCondition( integer $start = null, integer $count = null, XLite\Core\CommonCell $cnd = null )` Return SQL condition with limits Return SQL condition with limits Parameters `$start` `integer` Index of the first item on the page OPTIONAL `$count` `integer` Number of items per page OPTIONAL `$cnd` `XLite\Core\CommonCell` Search condition OPTIONAL Returns `array\|Doctrine\ORM\PersistentCollection` Since 1.0.0 See ____func_see____
`protected string`	# `getListName( )` Return current list name Return current list name Returns `string` Since 1.0.0 See ____func_see____
`protected string`	# `getDir( )` getDir getDir Returns `string` Since 1.0.0 See ____func_see____
`protected string`	# `getDefaultTemplate( )` Return widget default template Return widget default template Returns `string` Since 1.0.0 See ____func_see____
`protected XLite\View\ItemsList\AItemsList`	# `getList( )` getList getList Returns `XLite\View\ItemsList\AItemsList` Since 1.0.0 See ____func_see____
`protected integer`	# `getItemsTotal( )` getItemsTotal getItemsTotal Returns `integer` Since 1.0.0 See ____func_see____
`protected integer`	# `getMaxItemsCount( )` Get maximum number of items to display in the list Get maximum number of items to display in the list Returns `integer` Since 1.0.11 See ____func_see____
`protected integer`	# `getPagesCount( )` Get pages count Get pages count Returns `integer` Since 1.0.0 See ____func_see____
`protected integer`	# `getItemsPerPageMin( )` Return minimal possible items number per page Return minimal possible items number per page Returns `integer` Since 1.0.0 See ____func_see____
`protected integer`	# `getItemsPerPageMax( )` Return maximal possible items number per page Return maximal possible items number per page Returns `integer` Since 1.0.0 See ____func_see____
`protected integer`	# `getItemsPerPage( )` getItemsPerPage getItemsPerPage Returns `integer` Since 1.0.0 See ____func_see____
`protected`	# `defineWidgetParams( )` Define widget parameters Define widget parameters Since 1.0.0 See ____func_see____
`protected`	# `defineRequestParams( )` Define so called "request" parameters Define so called "request" parameters Since 1.0.0 See ____func_see____
`protected string`	# `buildURLByPageId( integer $pageId )` Build page URL by page ID Build page URL by page ID Parameters `$pageId` `integer` Page ID Returns `string` Since 1.0.0 See ____func_see____
`protected integer`	# `getFrameLength( )` getFrameLength getFrameLength Returns `integer` Since 1.0.0 See ____func_see____
`protected integer`	# `getFrameHalfLength( boolean $shortPart = true )` getFrameHalfLength getFrameHalfLength Parameters `$shortPart` `boolean` Which part of frame to return OPTIONAL Returns `integer` Since 1.0.0 See ____func_see____
`protected integer`	# `getFrameStartPage( )` getFrameStartPage getFrameStartPage Returns `integer` Since 1.0.0 See ____func_see____
`protected integer`	# `getFirstPageId( )` Return ID of the first page Return ID of the first page Returns `integer` Since 1.0.0 See ____func_see____
`protected integer`	# `getPreviousPageId( )` Return ID of the previous page Return ID of the previous page Returns `integer` Since 1.0.0 See ____func_see____
`protected integer`	# `getLastPageId( )` Return ID of the last page Return ID of the last page Returns `integer` Since 1.0.0 See ____func_see____
`protected`	# `getNextPageId( )` Return ID of the next page Return ID of the next page Since 1.0.0 See ____func_see____
`protected array`	# `getPages( )` Return an array with information on the pages to be displayed Return an array with information on the pages to be displayed Returns `array` Since 1.0.0 See ____func_see____
`protected boolean`	# `isCurrentPage( integer $pageId )` Check whether the page is currently selected Check whether the page is currently selected Parameters `$pageId` `integer` ID of the page to check Returns `boolean` Since 1.0.0 See ____func_see____
`protected integer`	# `getPageId( )` Return ID of the current page Return ID of the current page Returns `integer` Since 1.0.0 See ____func_see____
`protected integer`	# `getStartItem( )` Return index of the first item on the current page Return index of the first item on the current page Returns `integer` Since 1.0.0 See ____func_see____
`protected integer`	# `getBeginRecordNumber( )` Get page begin record number Get page begin record number Returns `integer` Since 1.0.0 See ____func_see____
`protected integer`	# `getEndRecordNumber( )` Get page end record number Get page end record number Returns `integer` Since 1.0.0 See ____func_see____
`protected boolean`	# `isPagesListVisible( )` Check if pages list is visible or not Check if pages list is visible or not Returns `boolean` Since 1.0.0 See ____func_see____
`protected boolean`	# `isItemsPerPageVisible( )` isItemsPerPageVisible isItemsPerPageVisible Returns `boolean` Since 1.0.0 See ____func_see____
`protected boolean`	# `isItemsPerPageSelectorVisible( )` isItemsPerPageSelectorVisible isItemsPerPageSelectorVisible Returns `boolean` Since 1.0.0 See ____func_see____
`protected boolean`	# `isVisible( )` isVisible isVisible Returns `boolean` Since 1.0.0 See ____func_see____
`protected boolean`	# `isVisibleBottom( )` isVisible bottom isVisible bottom Returns `boolean` Since 1.0.0 See ____func_see____

Methods inherited from XLite\View\RequestHandler\ARequestHandler
`checkRequestParams(), checkSessionCell(), getJSData(), getRequestParams(), getRequestParamsHash(), getSavedRequestParam(), getSessionCell(), getWidgetClass(), getWidgetParameters(), getWidgetTarget(), initView(), setWidgetParams(), setWidgetRequestParamValues()`

Methods inherited from XLite\View\AView
__call(), __clone(), __constructStatic(), __get(), addSlashes(), addViewListChild(), applyXpathPatches(), buildListItemClass(), checkMode(), checkTarget(), checkVisibility(), closeView(), concat(), defineViewList(), detectCurrentViewZone(), display(), displayCommentedData(), displayInheritedViewListContent(), displayNestedViewListContent(), displayViewListContent(), formatDate(), formatFileSize(), formatPrice(), formatSize(), formatTime(), get(), getAllowedTargets(), getArrayField(), getChildWidget(), getCommonFiles(), getContent(), getCurrencySymbol(), getCurrentLanguage(), getDefaultModes(), getInheritedListName(), getInheritedViewList(), getJSFiles(), getMetaTags(), getNamePostedData(), getNameToDelete(), getNamespaces(), getNestedListName(), getNestedViewList(), getObjectField(), getRegisteredMetas(), getRegisteredNamespaces(), getRegisteredResources(), getRequestParamValue(), getResources(), getResourcesSchema(), getResourcesTypeSchema(), getRowClass(), getTail(), getTemplate(), getTemplateFile(), getThemeFiles(), getValidationEngineLanguageFile(), getValidationEngineLanguageResource(), getViewList(), getViewListChildren(), getViewListClass(), getViewListContent(), getViewListContentAsNodes(), getWidget(), getXpathByContent(), inc(), includeCompiledFile(), insertViewListByPattern(), insertViewListByXpath(), isDeveloperMode(), isDisplayRequired(), isDisplayRequiredForMode(), isEmpty(), isSelected(), isViewListVisible(), postprocessContent(), prepareResource(), rand(), registerMetas(), registerNamespaces(), registerResources(), registerResourcesForCurrentWidget(), removeWidgetFromList(), split(), truncate()

Methods inherited from XLite\Core\Handler
`__construct(), buildFullURL(), buildURL(), buildURLArguments(), buildURLPath(), getParam(), getParamsHash(), getPostedData(), getPrefixPostedData(), getPrefixSelected(), getRequestDataByPrefix(), getSelected(), getWidgetParams(), getWidgetSettings(), getWidgetSettingsFilter(), init(), isExported(), validateAttributes()`

Methods inherited from XLite\Base
`getComplex(), is(), isComplex(), set(), setComplex(), setProperties()`

Methods inherited from XLite\Base\Singleton
`getInstance(), resetInstance()`

Methods inherited from XLite\Base\SuperClass
`doDie(), t()`

Constants summary
`string`	`PARAM_PAGE_ID`	`'pageId'`	# Widget parameter names Widget parameter names
`string`	`PARAM_ITEMS_COUNT`	`'itemsCount'`	#
`string`	`PARAM_ONLY_PAGES`	`'onlyPages'`	#
`string`	`PARAM_ITEMS_PER_PAGE`	`'itemsPerPage'`	#
`string`	`PARAM_SHOW_ITEMS_PER_PAGE_SELECTOR`	`'showItemsPerPageSelector'`	#
`string`	`PARAM_LIST`	`'list'`	#
`string`	`PARAM_MAX_ITEMS_COUNT`	`'maxItemsCount'`	#
`string`	`PAGE_FIRST`	`'first'`	# Page short names Page short names
`string`	`PAGE_PREVIOUS`	`'previous'`	#
`string`	`PAGE_NEXT`	`'next'`	#
`string`	`PAGE_LAST`	`'last'`	#

Constants inherited from XLite\View\RequestHandler\ARequestHandler
`PARAM_SESSION_CELL, W_CLASS, W_PARAMS, W_TARGET`

Constants inherited from XLite\View\AView
`INSERT_AFTER, INSERT_BEFORE, PARAM_MODES, PARAM_TEMPLATE, REPLACE, RESOURCE_CSS, RESOURCE_JS`

Constants inherited from XLite\Core\Handler
`PARAM_AJAX_TARGET, PARAM_AJAX_WIDGET, PARAM_DUMP_STARTED, PARAM_IS_EXPORTED, PARAM_SILENT`

Properties summary
`protected integer`	`$currentPageId`		# currentPageId FIXME: due to old-style params mapping we cannot use the "pageId" name here: it will be overriden by the "PARAM_PAGE_ID" request parameter currentPageId FIXME: due to old-style params mapping we cannot use the "pageId" name here: it will be overriden by the "PARAM_PAGE_ID" request parameter Since 1.0.0 See ____var_see____
`protected integer`	`$pagesCount`		# pagesCount pagesCount Since 1.0.0 See ____var_see____
`protected integer`	`$itemsPerPage`		# Number of items per page (cached value) Number of items per page (cached value) Since 1.0.0 See ____var_see____
`protected array`	`$pages`	`null`	# Cached pages Cached pages Since 1.0.0 See ____var_see____

Properties inherited from XLite\View\RequestHandler\ARequestHandler
`$requestParams, $savedRequestParams`

Properties inherited from XLite\View\AView
`$countDeep, $countLevel, $isCloned, $metas, $namedWidgets, $namespaces, $resources, $tail, $viewLists`

Properties inherited from XLite\Core\Handler
`$widgetParams`

Properties inherited from XLite\Base
`$singletons`

Properties inherited from XLite\Base\Singleton
`$instances`

Namespaces

Classes

Class APager

Direct known subclasses

Indirect known subclasses

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Parameters

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Since

See

Since

See

Parameters

Returns

Since

See

Returns

Since

See

Parameters

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Since

See