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 license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_View
- Version
- $Id$
\Zend_View_Helper_PaginationControl
Package: Zend_View




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

string|array $_defaultViewPartial = nullstatic
Default view partial
Default value
nullDetails- Type
- string | array
Methods

getDefaultViewPartial() : string | arraystatic
Gets the default view partial
Returns
| Type | Description |
|---|---|
| string | array |

paginationControl( $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).
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $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) : voidstatic
Sets the default view partial.
Parameters
| Name | Type | Description |
|---|---|---|
| $partial | string | array | View partial |

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