API Documentation

Paginator/Adapter/Iterator.php

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 license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Paginator  
version
$Id: Iterator.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Paginator_Adapter_Iterator

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

Properties

Propertyprotectedinteger  $_count= 'null'

Item count

Default valuenullDetails
Type
integer
Propertyprotected\Iterator  $_iterator= 'null'

Iterator which implements Countable

Default valuenullDetails
Type
\Iterator

Methods

methodpublic__construct( \Iterator $iterator ) : void

Constructor.

Parameters
Name Type Description
$iterator \Iterator Iterator to paginate
Throws
Exception Description
\Zend_Paginator_Exception
methodpubliccount( ) : integer

Returns the total number of rows in the collection.

Returns
Type Description
integer
methodpublicgetItems( integer $offset, integer $itemCountPerPage ) : \LimitIterator|array

Returns an iterator of items for a page, or an empty array.

Parameters
Name Type Description
$offset integer Page offset
$itemCountPerPage integer Number of items per page
Returns
Type Description
\LimitIteratorarray
Documentation was generated by DocBlox 0.13.3.