API Documentation

Zend/View/Helper/PaginationControl.php

Show: inherited
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 license@zend.com 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 24594 2012-01-05 21:27:01Z matthew $  

\Zend_View_Helper_PaginationControl

Package: Zend\View

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

Properties

Propertyprotectedstring|array  $_defaultViewPartial= 'null'
static

Default view partial

Default valuenullDetails
Type
stringarray
Propertypublic\Zend_View_Instance  $view= 'null'

View instance

Default valuenullDetails
Type
\Zend_View_Instance

Methods

methodpublicgetDefaultViewPartial( ) : string|array
static

Gets the default view partial

Returns
Type Description
string|array
methodpublicpaginationControl( \Zend_Paginator $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
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

Returns
Type Description
string
Throws
Exception Description
\Zend_View_Exception
methodpublicsetDefaultViewPartial( string|array $partial ) : void
static

Sets the default view partial.

Parameters
Name Type Description
$partial string|array

View partial

methodpublicsetView( \Zend_View_Interface $view ) : \Zend_View_Helper_PaginationControl

Sets the view instance.

Parameters
Name Type Description
$view \Zend_View_Interface

View instance

Returns
Type Description
\Zend_View_Helper_PaginationControl
Documentation was generated by DocBlox 0.15.1.