category Zend
package Zend_View
subpackage Helper

 Methods

Render the provided pages.

__invoke(\Zend\Paginator\Paginator $paginator, string $scrollingStyle, string $partial, array | string $params) : string

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

$paginator

\Zend\Paginator\Paginator

(Optional) $paginator

$scrollingStyle

string

(Optional) Scrolling style

$partial

string

(Optional) View partial

$params

arraystring

(Optional) params to pass to the partial

Exceptions

\Zend\View\Exception\RuntimeException if no paginator or no view partial provided
\Zend\View\Exception\InvalidArgumentException if partial is invalid array

Returns

string

Gets the default scrolling style

getDefaultScrollingStyle() : string

Returns

string

Gets the default view partial

getDefaultViewPartial() : string | array

Returns

stringarray

Get the view object

getView() : null | \Zend\View\Renderer\RendererInterface
Inherited

inherited_from \Zend\View\Helper\AbstractHelper::getView()

Returns

Sets the default Scrolling Style

setDefaultScrollingStyle(string $style) 

Parameters

$style

string

string 'all' | 'elastic' | 'sliding' | 'jumping'

Sets the default view partial.

setDefaultViewPartial(string | array $partial) 

Parameters

$partial

stringarray

View partial

Set the View object

setView(\Zend\View\Renderer\RendererInterface $view) : \Zend\View\Helper\AbstractHelper
Inherited

inherited_from \Zend\View\Helper\AbstractHelper::setView()

Parameters

Returns

 Properties

 

Default Scrolling Style

$defaultScrollingStyle : string

 

Default view partial

$defaultViewPartial : string | array

 

View object

$view : \Zend\View\Renderer\RendererInterface
Inherited

inherited_from \Zend\View\Helper\AbstractHelper::$$view