View/Helper/PaginationControl.php

Show: PublicProtectedPrivateinherited
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-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

>VPropertyprotectedstring|array $_defaultViewPartial = null
static
Default view partial
Default valuenullDetails
Type
string | array
>VPropertypublic\Zend_View_Instance $view = null
View instance
Default valuenullDetails
Type
\Zend_View_Instance

Methods

methodpublicgetDefaultViewPartial() : string | array
static

Gets the default view partial

Returns
TypeDescription
string | array
methodpublicpaginationControl( $paginator = null, string $scrollingStyle = null, string $partial = null, array | string $params = null) : string

Render 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
NameTypeDescription
$paginator
$scrollingStylestring

(Optional) Scrolling style

$partialstring

(Optional) View partial

$paramsarray | string

(Optional) params to pass to the partial

Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_View_Exception
methodpublicsetDefaultViewPartial(string | array $partial) : void
static

Sets the default view partial.

Parameters
NameTypeDescription
$partialstring | array

View partial

methodpublicsetView(\Zend_View_Interface $view) : \Zend_View_Helper_PaginationControl

Sets the view instance.

Parameters
NameTypeDescription
$view\Zend_View_Interface

View instance

Returns
TypeDescription
\Zend_View_Helper_PaginationControl
Documentation was generated by phpDocumentor 2.2.0 .