Zend Framework  3.0
Public Member Functions | Static Public Member Functions | Static Protected Attributes | List of all members
PaginationControl Class Reference

Public Member Functions

 __invoke (Paginator\Paginator $paginator=null, $scrollingStyle=null, $partial=null, $params=null)
 Render the provided pages.
 
- Public Member Functions inherited from AbstractHelper
 setView (Renderer $view)
 Set the View object.
 
 getView ()
 Get the view object.
 

Static Public Member Functions

static setDefaultScrollingStyle ($style)
 Sets the default Scrolling Style.
 
static getDefaultScrollingStyle ()
 Gets the default scrolling style.
 
static setDefaultViewPartial ($partial)
 Sets the default view partial.
 
static getDefaultViewPartial ()
 Gets the default view partial.
 

Static Protected Attributes

static $defaultScrollingStyle = 'sliding'
 
static $defaultViewPartial = null
 

Additional Inherited Members

- Protected Attributes inherited from AbstractHelper
 $view = null
 

Member Function Documentation

__invoke ( Paginator\Paginator  $paginator = null,
  $scrollingStyle = null,
  $partial = null,
  $params = null 
)

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
Paginator\Paginator$paginator(Optional)
string$scrollingStyle(Optional) Scrolling style
string$partial(Optional) View partial
array | string$params(Optional) params to pass to the partial
Exceptions
Exception\RuntimeExceptionif no paginator or no view partial provided
Exception\InvalidArgumentExceptionif partial is invalid array
Returns
string
static getDefaultScrollingStyle ( )
static

Gets the default scrolling style.

Returns
string
static getDefaultViewPartial ( )
static

Gets the default view partial.

Returns
string|array
static setDefaultScrollingStyle (   $style)
static

Sets the default Scrolling Style.

Parameters
string$stylestring 'all' | 'elastic' | 'sliding' | 'jumping'
static setDefaultViewPartial (   $partial)
static

Sets the default view partial.

Parameters
string | array$partialView partial

Member Data Documentation

$defaultScrollingStyle = 'sliding'
staticprotected
$defaultViewPartial = null
staticprotected