API Documentation

View/Helper/PaginationControl.php

Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_View
version
$Id: PaginationControl.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_View_Helper_PaginationControl

Description

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.

Zend_View_Helper_PaginationControl

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_View
Properties
$view
$_defaultViewPartial
Methods
setView
setDefaultViewPartial
getDefaultViewPartial
paginationControl

Description

Properties

$_defaultViewPartial

string|array $_defaultViewPartial = 'null'

Default view partial

Details

$_defaultViewPartial
string|array
visibility
protected
default
null
final
false
static
true

$view

Zend_View_Instance $view = 'null'

View instance

Details

$view
Zend_View_Instance
visibility
public
default
null
final
false
static
false

Methods

getDefaultViewPartial

getDefaultViewPartial( ) : string|array

Gets the default view partial

Output
string|array
Details
visibility
public
final
false
static
true

paginationControl

paginationControl( 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).

Arguments
$paginator
Zend_Paginator
(Optional) $paginator
$scrollingStyle
string
(Optional) Scrolling style
$partial
string
(Optional) View partial
$params
arraystring
(Optional) params to pass to the partial
Output
string
Details
visibility
public
final
false
static
false
throws

setDefaultViewPartial

setDefaultViewPartial( string|array $partial ) :

Sets the default view partial.

Arguments
$partial
stringarray
View partial
Details
visibility
public
final
false
static
true

setView

setView( Zend_View_Interface $view ) : Zend_View_Helper_PaginationControl

Sets the view instance.

Arguments
$view
Zend_View_Interface
View instance
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.