Class BePaginatorToolbarHelper

Help to build a toolbar for pagination.

Internally it uses PaginatorHelper. It can be used when resources are paginated with CakePHP pagination. Do not use with BEdita objects, use BeToolbarHelper instead.

Helper

Extended by

AppHelper

Extended by

BePaginatorToolbarHelper

Located at views/helpers/be_paginator_toolbar.php

Methods summary

`public`	# `__construct( )` Inheritdoc
`public string`	# `show( string $type = 'default', array $options = array() )` Return toolbar by type. Return toolbar by type. `$options` available are: - `name` the name of the resource paginated - `headerName` if present override `name` in the toolbar header - `newAction` the name of the controller action corresponding to the creation page of new resources Parameters `$type` The view type, can be 'compact' or default `$options` Toolbar options Returns string
`private`	# `separator( string & $html, string $separator )` Apply separator to specified html, if not empty Apply separator to specified html, if not empty Parameters `$html` The html string `$separator` The separator
`public string`	# `pageHeader( array $options )` Page title, System users or Users groups Page title, System users or Users groups `$options` available: - `headerName` to override default name Parameters `$options` Toolbar header options Returns string
`public string`	# `pageQuery( )` Page query data, info about matching query, if any Page query data, info about matching query, if any Returns string
`public string`	# `pagePagination( array $options )` Page pagination data, info about page(s), links, etc. Page pagination data, info about page(s), links, etc. `$options` available: - `newAction` the name of the controller action corresponding to the creation page of new resources Parameters `$options` Toolbar options Returns string
`public string`	# `pageCount( )` Return number of items per object type Return number of items per object type Returns string
`public string`	# `pageNav( )` Page nav data for page. Shows 'page of ', where is an input field Page nav data for page. Shows 'page of ', where is an input field Returns string
`public string`	# `pagePrev( )` Link to previous page Link to previous page Returns string
`public string`	# `pageNext( )` Link to next page Link to next page Returns string
`public string`	# `pageSize( )` Page size data for page Page size data for page Returns string
`public mixed`	# `size( )` Return number of records found Return number of records found Returns mixed int\|string
`public mixed`	# `current( )` Return current page Return current page Returns mixed int\|string
`public string`	# `prev( )` Return the link (html anchor tag) for the previous page Return the link (html anchor tag) for the previous page Returns string
`public string`	# `next( )` Return the link (html anchor tag) for the next page Return the link (html anchor tag) for the next page Returns string
`public string`	# `last( )` Return the link (html anchor tag) for the last page Return the link (html anchor tag) for the last page Returns string
`public string`	# `changePageInput( )` Change page as input text. Onchange, reload page to specified page number Change page as input text. Onchange, reload page to specified page number Returns string
`public string`	# `changeDimSelect( string $selectId, array $htmlAttributes = array(), array $options = array() )` Return dropdown list with changed dimension Return dropdown list with changed dimension Parameters `$selectId` The combo\|select ID `$htmlAttributes` Associative Array with HTML attributes `$options` The options Returns string
`public array`	# `getPassedArgs( )` Get array arguments Get array arguments Returns array

Methods inherited from AppHelper

getHelper(), oEmbedInfo()

Properties summary

`public array`	`$helpers` Included helpers. Included helpers.	# `array('Form', 'Html', 'Paginator', 'SessionFilter')`
`private array`	`$_publication` View publication data, if any View publication data, if any	#
`private array`	`$_section` View section data, if any View section data, if any	#
`private array`	`$_currentContent` View current content data, if any View current content data, if any	#
`private string`	`$_itemName` Template itemName string parameter Template itemName string parameter	#
`private string`	`$_noitem` Template noitem string parameter Template noitem string parameter	#
`private string`	`$_moduleName` View moduleName string, if any View moduleName string, if any	#
`private array`	`$_currentModule` View current module array View current module array	#
`private string`	`$_name` Name used in toolbar, can be itemName or moduleName value Name used in toolbar, can be itemName or moduleName value	#
`private Configure`	`$_conf` Configuration instance Configuration instance	#
`protected array`	`$changePageDefaultOptions` Default options for change page combo Default options for change page combo	# `array(1, 5, 10, 20, 50, 100)`