View/Helper/PaginationControl.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 [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_View
- Version
- $Id: PaginationControl.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_View_Helper_PaginationControl
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties

string|array $_defaultViewPartial = nullDefault view partial
nullDetails- Type
- string | array
Methods

getDefaultViewPartial() : string | arrayGets the default view partial
| Type | Description |
|---|---|
| string | array |

paginationControl(\Zend_Paginator $paginator = null, string $scrollingStyle = null, string $partial = null, array | string $params = null) : stringRender the provided pages.
This checks if $view->paginator is set and, if so, uses that. Also, if no scrolling style or partial are specified, the defaults will be used (if set).
| Name | Type | Description |
|---|---|---|
| $paginator | \Zend_Paginator | (Optional) $paginator |
| $scrollingStyle | string | (Optional) Scrolling style |
| $partial | string | (Optional) View partial |
| $params | array | string | (Optional) params to pass to the partial |
| Type | Description |
|---|---|
| string |
| Exception | Description |
|---|---|
| \Zend_View_Exception |

setDefaultViewPartial(string | array $partial) : voidSets the default view partial.
| Name | Type | Description |
|---|---|---|
| $partial | string | array | View partial |

setView(\Zend_View_Interface $view) : \Zend_View_Helper_PaginationControlSets the view instance.
| Name | Type | Description |
|---|---|---|
| $view | \Zend_View_Interface | View instance |
| Type | Description |
|---|---|
| \Zend_View_Helper_PaginationControl |