Paginator.php

Show:

inherited

Classes
- \Zend_Paginator

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Paginator
Version: $Id: Paginator.php 24754 2012-05-05 02:30:56Z adamlundrigan $

\Zend_Paginator
jump to top

Package: Zend\Paginator

Implements
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

string 
                INTERNAL_ADAPTER
                = 'Zend_Paginator_Adapter_Internal'

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

: string

 
                CACHE_TAG_PREFIX
                = 'Zend_Paginator_'

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

Properties

\Zend_Paginator_Adapter_Interface $_adapter = null

Adapter

Default valuenullDetails

Type: \Zend_Paginator_Adapter_Interface

\Zend_Loader_PluginLoader $_adapterLoader = null

static

Adapter plugin loader

Default valuenullDetails

Type: \Zend_Loader_PluginLoader

\Zend_Cache_Core $_cache =

static

Cache object

Details

Type: \Zend_Cache_Core

bool $_cacheEnabled = true

Enable or disable the cache by Zend_Paginator instance

Default valuetrueDetails

Type: bool

\Zend_Config $_config = null

static

Configuration file

Default valuenullDetails

Type: \Zend_Config

integer $_currentItemCount = null

Number of items in the current page

Default valuenullDetails

Type: integer

\Traversable $_currentItems = null

Current page items

Default valuenullDetails

Type: \Traversable

integer $_currentPageNumber = 1

Current page number (starting from 1)

Default value1Details

Type: integer

int $_defaultItemCountPerPage = 10

static

Default item count per page

Default value10Details

Type: int

int $_defaultPageRange = 10

static

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

Default value10Details

Type: int

string $_defaultScrollingStyle = 'Sliding'

static

Default scrolling style

Default value'Sliding'Details

Type: string

\Zend_Filter_Interface $_filter = null

Result filter

Default valuenullDetails

Type: \Zend_Filter_Interface

integer $_itemCountPerPage = null

Number of items per page

Default valuenullDetails

Type: integer

integer $_pageCount = null

Number of pages

Default valuenullDetails

Type: integer

integer $_pageRange = null

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

Default valuenullDetails

Type: integer

array $_pages = null

Pages

Default valuenullDetails

Type: array

\Zend_Loader_PluginLoader $_scrollingStyleLoader = null

static

Scrolling style plugin loader

Default valuenullDetails

Type: \Zend_Loader_PluginLoader

\Zend_View_Interface $_view = null

View instance used for self rendering

Default valuenullDetails

Type: \Zend_View_Interface

Methods

__construct(\Zend_Paginator_Adapter_Interface | \Zend_Paginator_AdapterAggregate $adapter) : void

Constructor.

Parameters

Name	Type	Description
$adapter	\Zend_Paginator_Adapter_Interface \| \Zend_Paginator_AdapterAggregate

__toString() : string

Serializes the object as a string.

Proxies to render().

Returns

Type	Description
string

_cacheEnabled() : bool

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

Returns

Type	Description
bool

_calculatePageCount() : integer

Calculates the page count.

Returns

Type	Description
integer

_createPages(string $scrollingStyle = null) : \stdClass

Creates the page collection.

Parameters

Name	Type	Description
$scrollingStyle	string	Scrolling style

Returns

Type	Description
\stdClass

_getCacheId(int $page = null) : string

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

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

Parameters

Name	Type	Description
$page	int

Returns

Type	Description
string

_getCacheInternalId() : string

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

Used to tag that unique Paginator instance in cache

Returns

Type	Description
string

_loadScrollingStyle(string $scrollingStyle = null) : \Zend_Paginator_ScrollingStyle_Interface

Loads a scrolling style.

Parameters

Name	Type	Description
$scrollingStyle	string

Returns

Type	Description
\Zend_Paginator_ScrollingStyle_Interface

addAdapterPrefixPath(string $prefix, string $path) : void

static

Adds an adapter prefix path to the plugin loader.

Parameters

Name	Type	Description
$prefix	string
$path	string

addAdapterPrefixPaths(array $prefixPaths) : void

static

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

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

Parameters

Name	Type	Description
$prefixPaths	array

addScrollingStylePrefixPath(string $prefix, string $path) : void

static

Adds a scrolling style prefix path to the plugin loader.

Parameters

Name	Type	Description
$prefix	string
$path	string

addScrollingStylePrefixPaths(array $prefixPaths) : void

static

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

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

Parameters

Name	Type	Description
$prefixPaths	array

clearPageItemCache(int $pageNumber = null) : \Zend_Paginator

Clear the page item cache.

Parameters

Name	Type	Description
$pageNumber	int

Returns

Type	Description
\Zend_Paginator

count() : integer

Returns the number of pages.

Returns

Type	Description
integer

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

static

Factory.

Parameters

Name	Type	Description
$data	mixed
$adapter	string
$prefixPaths	array

Returns

Type	Description
\Zend_Paginator

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

Returns the absolute item number for the specified item.

Parameters

Name	Type	Description
$relativeItemNumber	integer	Relative item number
$pageNumber	integer	Page number

Returns

Type	Description
integer

getAdapter() : \Zend_Paginator_Adapter_Interface

Returns the adapter.

Returns

Type	Description
\Zend_Paginator_Adapter_Interface

getAdapterLoader() : \Zend_Loader_PluginLoader

static

Returns the adapter loader.

If it doesn't exist it's created.

Returns

Type	Description
\Zend_Loader_PluginLoader

getCurrentItemCount() : integer

Returns the number of items for the current page.

Returns

Type	Description
integer

getCurrentItems() : \Traversable

Returns the items for the current page.

Returns

Type	Description
\Traversable

getCurrentPageNumber() : integer

Returns the current page number.

Returns

Type	Description
integer

getDefaultItemCountPerPage() : int

static

Get the default item count per page

Returns

Type	Description
int

getDefaultPageRange() : int

static

Get the default page range

Returns

Type	Description
int

getDefaultScrollingStyle() : string

static

Returns the default scrolling style.

Returns

Type	Description
string

getFilter() : \Zend_Filter_Interface

Get the filter

Returns

Type	Description
\Zend_Filter_Interface

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

Returns an item from a page.

The current page is used if there's no page sepcified.

Parameters

Name	Type	Description
$itemNumber	integer	Item number (1 to itemCountPerPage)
$pageNumber	integer

Returns

Type	Description
mixed

getItemCount(mixed $items) : integer

Returns the number of items in a collection.

Parameters

Name	Type	Description
$items	mixed	Items

Returns

Type	Description
integer

getItemCountPerPage() : integer

Returns the number of items per page.

Returns

Type	Description
integer

getItemsByPage( $pageNumber) : \Traversable

Returns the items for a given page.

Parameters

Name	Type	Description
$pageNumber

Returns

Type	Description
\Traversable

getIterator() : \Traversable

Returns a foreach-compatible iterator.

Returns

Type	Description
\Traversable

getPageItemCache() : array

Returns the page item cache.

Returns

Type	Description
array

getPageRange() : integer

Returns the page range (see property declaration above).

Returns

Type	Description
integer

getPages(string $scrollingStyle = null) : array

Returns the page collection.

Parameters

Name	Type	Description
$scrollingStyle	string	Scrolling style

Returns

Type	Description
array

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

Returns a subset of pages within a given range.

Parameters

Name	Type	Description
$lowerBound	integer	Lower bound of the range
$upperBound	integer	Upper bound of the range

Returns

Type	Description
array

getScrollingStyleLoader() : \Zend_Loader_PluginLoader

static

Returns the scrolling style loader.

If it doesn't exist it's created.

Returns

Type	Description
\Zend_Loader_PluginLoader

getTotalItemCount() : integer

Returns the total number of items available.

Uses cache if caching is enabled.

Returns

Type	Description
integer

getView() : \Zend_View_Interface | null

Retrieves the view instance.

If none registered, attempts to pull f rom ViewRenderer.

Returns

Type	Description
\Zend_View_Interface \| null

normalizeItemNumber(integer $itemNumber) : integer

Brings the item number in range of the page.

Parameters

Name	Type	Description
$itemNumber	integer

Returns

Type	Description
integer

normalizePageNumber(integer $pageNumber) : integer

Brings the page number in range of the paginator.

Parameters

Name	Type	Description
$pageNumber	integer

Returns

Type	Description
integer

render(\Zend_View_Interface $view = null) : string

Renders the paginator.

Parameters

Name	Type	Description
$view	\Zend_View_Interface

Returns

Type	Description
string

setCache(\Zend_Cache_Core $cache) : void

static

Sets a cache object

Parameters

Name	Type	Description
$cache	\Zend_Cache_Core

setCacheEnabled(bool $enable) : \Zend_Paginator

Enables/Disables the cache for this instance

Parameters

Name	Type	Description
$enable	bool

Returns

Type	Description
\Zend_Paginator

setConfig(\Zend_Config $config) : void

static

Set a global config

Parameters

Name	Type	Description
$config	\Zend_Config

setCurrentPageNumber(integer $pageNumber) : \Zend_Paginator

Sets the current page number.

Parameters

Name	Type	Description
$pageNumber	integer	Page number

Returns

Type	Description
\Zend_Paginator	$this

setDefaultItemCountPerPage(int $count) : void

static

Set the default item count per page

Parameters

Name	Type	Description
$count	int

setDefaultPageRange(int $count) : void

static

Set the default page range

Parameters

Name	Type	Description
$count	int

setDefaultScrollingStyle(string $scrollingStyle = 'Sliding') : void

static

Sets the default scrolling style.

Parameters

Name	Type	Description
$scrollingStyle	string

setFilter(\Zend_Filter_Interface $filter) : \Zend_Paginator

Set a filter chain

Parameters

Name	Type	Description
$filter	\Zend_Filter_Interface

Returns

Type	Description
\Zend_Paginator

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

Sets the number of items per page.

Parameters

Name	Type	Description
$itemCountPerPage	integer

Returns

Type	Description
\Zend_Paginator	$this

setPageRange(integer $pageRange) : \Zend_Paginator

Sets the page range (see property declaration above).

Parameters

Name	Type	Description
$pageRange	integer

Returns

Type	Description
\Zend_Paginator	$this

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

Sets the view object.

Parameters

Name	Type	Description
$view	\Zend_View_Interface

Returns

Type	Description
\Zend_Paginator

toJson() : string

Returns the items of the current page as JSON.

Returns

Type	Description
string

Paginator.php

\Zend_Paginatorjump to top

Constants

Properties

Methods

\Zend_Paginator
jump to top