Class BeToolbarHelper

Table toolbar for pagination and search helper

Helper

AppHelper

BeToolbarHelper

Located at views/helpers/be_toolbar.php

Methods summary

`public`	# `__construct( )` Inheritdoc
`public`	# `init( array & $toolbar, string $prefix = '' )` Initialize toolbar parameters Initialize toolbar parameters Parameters `$toolbar` The toolbar `$prefix` The prefix
`public string`	# `next( string $title = ' > ', array $options = array(), string $disabledTitle = ' > ', array $disabledOption = array() )` Return the link (html anchor tag) for the next page Return the link (html anchor tag) for the next page Parameters `$title` Label link `$options` $option attributes for link `$disabledTitle` Label link disabled `$disabledOption` HTML attributes for link disabled (if present, insert a tag SPAN) Returns string
`public string`	# `prev( string $title = ' < ', array $options = array(), string $disabledTitle = ' < ', array $disabledOption = array() )` Return the link (html anchor tag) for the previous page Return the link (html anchor tag) for the previous page Parameters `$title` Label link `$options` $option HTML attributes for link `$disabledTitle` Label link disabled `$disabledOption` HTML attributes for link disabled (if present, insert a tag SPAN) Returns string
`public string`	# `first( string $title = ' \|< ', array $options = array(), string $disabledTitle = ' \|< ', array $disabledOption = array() )` Return the link (html anchor tag) for the first page Return the link (html anchor tag) for the first page Parameters `$title` Label link `$options` $option HTML attributes for link `$disabledTitle` Label link disabled `$disabledOption` HTML attributes for link disabled (if present, insert a tag SPAN) Returns string
`public string`	# `last( string $title = ' >\| ', array $options = array(), string $disabledTitle = ' >\| ', array $disabledOption = array() )` Return the link (html anchor tag) for the last page Return the link (html anchor tag) for the last page Parameters `$title` Label link `$options` $option HTML attributes for link `$disabledTitle` Label link disabled `$disabledOption` HTML attributes for link disabled (if present, insert a tag SPAN) 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 mixed`	# `pages( )` Return total number of pages Return total number of pages Returns mixed int\|string
`public string`	# `changeDim( array $htmlAttributes = array(), array $options = array() )` View page size html select tag View page size html select tag Parameters `$htmlAttributes` Associative Array with HTML attributes `$options` The options 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 string`	# `changePage( array $htmlAttributes = array(), array $items = 5 )` Change selected page Change selected page Parameters `$htmlAttributes` Associative Array with HTML attributes `$items` Number of available pages, before and after current. Default: 5 Returns string
`public string`	# `changePageSelect( string $selectId, array $htmlAttributes = array(), array $items = 5 )` Change page in a dropdown list of results Change page in a dropdown list of results Parameters `$selectId` The combo\|select ID `$htmlAttributes` Associative Array with HTML attributes `$items` Number of available pages, before and after current. Default: 5 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`	# `order( string $field, string $title = '', array $image = '', boolean $htmlAttributes = array(), $dir = null )` Change list order Change list order Parameters `$field` Field for the "order by" `$title` Title for the link. Default: field name `$image` $htmlAttributes Associative Array with HTML attributes `$htmlAttributes` $dir If any, specify direction. 1: ascending, 0: descending; otherwise, !() `$dir` Returns string
`private string`	# `_scroll( string $where, string $title, array $options, string $disabledTitle, array $disabledOption )` Return the link (html anchor tag) for the page $where Return the link (html anchor tag) for the page $where Parameters `$where` Page target (next, prev, first, last) `$title` Label link `$options` $option HTML attributes for link `$disabledTitle` Label link disabled `$disabledOption` HTML attributes for link disabled (if present, insert a tag SPAN) Returns string
`private string`	# `_output( string $text, array $options )` Return output for text Return output for text Parameters `$text` The output text `$options` The options Returns string
`public array`	# `getPassedArgs( array $otherParams = array() )` Get array arguments Get array arguments Parameters `$otherParams` Other parameters Returns array
`private string`	# `getUrl( array $data )` Fix the parameter $data to correct work with plugin modules. It must be manually removed from the data array. Fix the parameter $data to correct work with plugin modules. It must be manually removed from the data array. Parameters `$data` The data to parse Returns string
`public string`	# `show( string $type = 'default', array $params = array() )` Return toolbar by type. Return toolbar by type. Parameters `$type` The view type, can be 'compact' or default `$params` The parameters, can be 'itemName' and 'noitem' 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( )` Page title, combining publication\|section\|content title Page title, combining publication\|section\|content title 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( )` Page pagination data, info about page(s), links, etc. Page pagination data, info about page(s), links, etc. 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

Methods inherited from AppHelper

getHelper(), oEmbedInfo()

Properties summary

`public array`	`$helpers` Included helpers. Included helpers.	# `array('Form', 'Html', '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	#
`public array`	`$tags` Tags types of enclosuers (with or without text) Tags types of enclosuers (with or without text)	# `array( 'with_text' => '<span %s >%s</span>', 'without_text' => '<span %s />', )`
`protected array`	`$changePageDefaultOptions` Default options for change page combo Default options for change page combo	# `array(1, 5, 10, 20, 50, 100)`

Classes

Interfaces

Exceptions

Class BeToolbarHelper

Methods summary

Inheritdoc

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Methods inherited from AppHelper

Properties summary