category Zend
package Zend_Paginator
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Constructor.

__construct(\Zend_Paginator_Adapter_Interface|\Zend_Paginator_AdapterAggregate $adapter) 

Parameters

$adapter

\Zend_Paginator_Adapter_Interface\Zend_Paginator_AdapterAggregate

Serializes the object as a string. Proxies to {@link render()}.

__toString() : string

Returns

string

Adds an adapter prefix path to the plugin loader.

addAdapterPrefixPath(string $prefix, string $path) 
Static

Parameters

$prefix

string

$path

string

Adds an array of adapter prefix paths to the plugin loader.

addAdapterPrefixPaths(array $prefixPaths) 
Static

$prefixPaths = array( 'My_Paginator_Adapter' => 'My/Paginator/Adapter/', 'Your_Paginator_Adapter' => 'Your/Paginator/Adapter/' );

Parameters

$prefixPaths

array

Adds a scrolling style prefix path to the plugin loader.

addScrollingStylePrefixPath(string $prefix, string $path) 
Static

Parameters

$prefix

string

$path

string

Adds an array of scrolling style prefix paths to the plugin loader.

addScrollingStylePrefixPaths(array $prefixPaths) 
Static

$prefixPaths = array( 'My_Paginator_ScrollingStyle' => 'My/Paginator/ScrollingStyle/', 'Your_Paginator_ScrollingStyle' => 'Your/Paginator/ScrollingStyle/' );

Parameters

$prefixPaths

array

Clear the page item cache.

clearPageItemCache(integer $pageNumber = null) : \Zend_Paginator

Parameters

$pageNumber

integer

Returns

\Zend_Paginator

Returns the number of pages.

count() : integer

Returns

integer

Factory.

factory(mixed $data, string $adapter = self::INTERNAL_ADAPTER, array $prefixPaths = null) : \Zend_Paginator
Static

Parameters

$data

mixed

$adapter

string

$prefixPaths

array

Returns

\Zend_Paginator

Returns the absolute item number for the specified item.

getAbsoluteItemNumber(integer $relativeItemNumber, integer $pageNumber = null) : integer

Parameters

$relativeItemNumber

integer

Relative item number

$pageNumber

integer

Page number

Returns

integer

Returns the adapter.

getAdapter() : \Zend_Paginator_Adapter_Interface

Returns

\Zend_Paginator_Adapter_Interface

Returns the adapter loader. If it doesn't exist it's created.

getAdapterLoader() : \Zend_Loader_PluginLoader
Static

Returns

\Zend_Loader_PluginLoader

Returns the number of items for the current page.

getCurrentItemCount() : integer

Returns

integer

Returns the items for the current page.

getCurrentItems() : \Traversable

Returns

\Traversable

Returns the current page number.

getCurrentPageNumber() : integer

Returns

integer

Get the default item count per page

getDefaultItemCountPerPage() : integer
Static

Returns

integer

Get the default page range

getDefaultPageRange() : integer
Static

Returns

integer

Returns the default scrolling style.

getDefaultScrollingStyle() : string
Static

Returns

string

Get the filter

getFilter() : \Zend_Filter_Interface

Returns

\Zend_Filter_Interface

Returns an item from a page. The current page is used if there's no page sepcified.

getItem(integer $itemNumber, integer $pageNumber = null) : mixed

Parameters

$itemNumber

integer

Item number (1 to itemCountPerPage)

$pageNumber

integer

Returns

mixed

Returns the number of items in a collection.

getItemCount(mixed $items) : integer

Parameters

$items

mixed

Items

Returns

integer

Returns the number of items per page.

getItemCountPerPage() : integer

Returns

integer

Returns the items for a given page.

getItemsByPage($pageNumber) : \Traversable

Parameters

$pageNumber

Returns

\Traversable

Returns a foreach-compatible iterator.

getIterator() : \Traversable

Returns

\Traversable

Returns the page item cache.

getPageItemCache() : array

Returns

array

Returns the page range (see property declaration above).

getPageRange() : integer

Returns

integer

Returns the page collection.

getPages(string $scrollingStyle = null) : array

Parameters

$scrollingStyle

string

Scrolling style

Returns

array

Returns a subset of pages within a given range.

getPagesInRange(integer $lowerBound, integer $upperBound) : array

Parameters

$lowerBound

integer

Lower bound of the range

$upperBound

integer

Upper bound of the range

Returns

array

Returns the scrolling style loader. If it doesn't exist it's created.

getScrollingStyleLoader() : \Zend_Loader_PluginLoader
Static

Returns

\Zend_Loader_PluginLoader

Returns the total number of items available. Uses cache if caching is enabled.

getTotalItemCount() : integer

Returns

integer

Retrieves the view instance. If none registered, attempts to pull f rom ViewRenderer.

getView() : \Zend_View_Interface | null

Returns

\Zend_View_Interfacenull

Brings the item number in range of the page.

normalizeItemNumber(integer $itemNumber) : integer

Parameters

$itemNumber

integer

Returns

integer

Brings the page number in range of the paginator.

normalizePageNumber(integer $pageNumber) : integer

Parameters

$pageNumber

integer

Returns

integer

Renders the paginator.

render(\Zend_View_Interface $view = null) : string

Parameters

$view

\Zend_View_Interface

Returns

string

Sets a cache object

setCache(\Zend_Cache_Core $cache) 
Static

Parameters

$cache

\Zend_Cache_Core

Enables/Disables the cache for this instance

setCacheEnabled(boolean $enable) : \Zend_Paginator

Parameters

$enable

boolean

Returns

\Zend_Paginator

Set a global config

setConfig(\Zend_Config $config) 
Static

Parameters

$config

\Zend_Config

Sets the current page number.

setCurrentPageNumber(integer $pageNumber) : \Zend_Paginator

Parameters

$pageNumber

integer

Page number

Returns

\Zend_Paginator$this

Set the default item count per page

setDefaultItemCountPerPage(integer $count) 
Static

Parameters

$count

integer

Set the default page range

setDefaultPageRange(integer $count) 
Static

Parameters

$count

integer

Sets the default scrolling style.

setDefaultScrollingStyle(string $scrollingStyle = 'Sliding'
Static

Parameters

$scrollingStyle

string

Set a filter chain

setFilter(\Zend_Filter_Interface $filter) : \Zend_Paginator

Parameters

$filter

\Zend_Filter_Interface

Returns

\Zend_Paginator

Sets the number of items per page.

setItemCountPerPage(integer $itemCountPerPage = -1) : \Zend_Paginator

Parameters

$itemCountPerPage

integer

Returns

\Zend_Paginator$this

Sets the page range (see property declaration above).

setPageRange(integer $pageRange) : \Zend_Paginator

Parameters

$pageRange

integer

Returns

\Zend_Paginator$this

Sets the view object.

setView(\Zend_View_Interface $view = null) : \Zend_Paginator

Parameters

$view

\Zend_View_Interface

Returns

\Zend_Paginator

Returns the items of the current page as JSON.

toJson() : string

Returns

string

Tells if there is an active cache object and if the cache has not been desabled

_cacheEnabled() : boolean

Returns

boolean

Calculates the page count.

_calculatePageCount() : integer

Returns

integer

Creates the page collection.

_createPages(string $scrollingStyle = null) : \stdClass

Parameters

$scrollingStyle

string

Scrolling style

Returns

\stdClass

Makes an Id for the cache Depends on the adapter object and the page number

_getCacheId(integer $page = null) : string

Used to store item in cache from that Paginator instance and that current page

Parameters

$page

integer

Returns

string

Get the internal cache id Depends on the adapter and the item count per page

_getCacheInternalId() : string

Used to tag that unique Paginator instance in cache

Returns

string

Loads a scrolling style.

_loadScrollingStyle(string $scrollingStyle = null) : \Zend_Paginator_ScrollingStyle_Interface

Parameters

$scrollingStyle

string

Returns

\Zend_Paginator_ScrollingStyle_Interface

 Properties

 

Adapter

$_adapter : \Zend_Paginator_Adapter_Interface

Default

null
 

Adapter plugin loader

$_adapterLoader : \Zend_Loader_PluginLoader

Default

null
Static
 

Cache object

$_cache : \Zend_Cache_Core

Default

Static
 

Enable or disable the cache by Zend_Paginator instance

$_cacheEnabled : boolean

Default

true
 

Configuration file

$_config : \Zend_Config

Default

null
Static
 

Number of items in the current page

$_currentItemCount : integer

Default

null
 

Current page items

$_currentItems : \Traversable

Default

null
 

Current page number (starting from 1)

$_currentPageNumber : integer

Default

1
 

Default item count per page

$_defaultItemCountPerPage : integer

Default

10
Static
 

Default number of local pages (i.e., the number of discretes page numbers that will be displayed, including the current page number)

$_defaultPageRange : integer

Default

10
Static
 

Default scrolling style

$_defaultScrollingStyle : string

Default

'Sliding'
Static
 

Result filter

$_filter : \Zend_Filter_Interface

Default

null
 

Number of items per page

$_itemCountPerPage : integer

Default

null
 

Number of pages

$_pageCount : integer

Default

null
 

Number of local pages (i.e., the number of discrete page numbers that will be displayed, including the current page number)

$_pageRange : integer

Default

null
 

Pages

$_pages : array

Default

null
 

Scrolling style plugin loader

$_scrollingStyleLoader : \Zend_Loader_PluginLoader

Default

null
Static
 

View instance used for self rendering

$_view : \Zend_View_Interface

Default

null

 Constants

 

The cache tag prefix used to namespace Paginator results in the cache

CACHE_TAG_PREFIX = 'Zend_Paginator_' 
 

Specifies that the factory should try to detect the proper adapter type first

INTERNAL_ADAPTER = 'Zend_Paginator_Adapter_Internal' : string