Class BeTreeHelper

BEdita tree of contents helper

Helper

Extended by

AppHelper

Extended by

BeTreeHelper

Version: $Revision$
Modifiedby: $LastChangedBy$
Lastmodified:

$LastChangedDate$

$Id$

Located at views/helpers/be_tree.php

Methods summary

`public`	# `__construct( )`
`public`	# `beforeRender( )` beforeRender callback initialize BeTree::treeParams to $this->params beforeRender callback initialize BeTree::treeParams to $this->params
`public`	# `setTreeParams( array $params )` Merge BeTree::treeParams with array of params you can use it to override some params used to build url in the rel attribute inside tree items. For example: url is build using $treeParams['controller'] and treeParams['action']. If you want tree items go to another controller you have to call BeTree::setTreeParams() before building the tree. From view file call {$beTree->setTreeParams(['controller' => 'myController'])} Merge BeTree::treeParams with array of params you can use it to override some params used to build url in the rel attribute inside tree items. For example: url is build using $treeParams['controller'] and treeParams['action']. If you want tree items go to another controller you have to call BeTree::setTreeParams() before building the tree. From view file call {$beTree->setTreeParams(['controller' => 'myController'])} Parameters `$params`
`public`	# `resetTreeParams( )` set BeTree::treeParams to $this->params set BeTree::treeParams to $this->params
`public string`	# `optionsMobile( array $tree, integer $options = array() , string $indentation,… )` build option for select build option for select Parameters `$tree` `$options` $numInd number of $indentation repetition foreach branch `$indentation`,… string to use for indentation Returns string ....
`private string`	# `optionMobileBranch( $branch, integer $options = array() , string $indentation,… )` build branch build branch Parameters `$branch` `$options` $numInd number of repetition on $indentation string foreach branch `$indentation`,… string to use for indentation Returns string of option
`public string`	# `designBranchMobile( array $branch, string $inputType = null, array $parent_ids = array() )` get html section get html section Parameters `$branch` $branch, section `$inputType` $inputType, type of input to prepend to section name (checkbox, radio) `$parent_ids` $parent_ids, array of ids parent Returns string html for section simple tree
`public string`	# `view( array $tree = array(), string $inputType = null, array $parent_ids = array() )` output a tree output a tree Parameters `$tree` $tree, publications tree `$inputType` $inputType, type of input to prepend to section name (checkbox, radio) `$parent_ids` $parent_ids, array of ids parent Returns string html for simple view tree
`public string`	# `sitemap( array $sections = array(), string $public_url = '/' )` output sitemap tree output sitemap tree Parameters `$sections` $sections, sections tree `$public_url` $public_url, public url of publication Returns string html for sitemap
`private`	# `designsitemap( array $sections = array(), string $public_url = '/' )` get sitemap get sitemap Parameters `$sections` `$public_url`
`public string`	# `option( array $tree, integer $selId = null, string $numInd = 1, $indentation = "    " )` build option for select build option for select Parameters `$tree` `$selId` $numInd number of $indentation repetition foreach branch `$numInd` $indentation string to use for indentation `$indentation` Returns string ....
`private string`	# `designBranch( array $branch, string $inputType, array $parent_ids, string $parent_id )` get html section get html section Parameters `$branch` $branch, section `$inputType` $inputType, type of input to prepend to section name (checkbox, radio) `$parent_ids` $parent_ids, array of ids parent `$parent_id` $parent_id, the bedita id of the parent Returns string html for section simple tree
`private string`	# `optionBranch( $branch, integer $selId, string $numInd, $indentation, $path )` build branch build branch Parameters `$branch` `$selId` $numInd number of repetition on $indentation string foreach branch `$numInd` $indentation string to use for indentation `$indentation` `$path` Returns string of option

Methods inherited from AppHelper

getHelper(), oEmbedInfo()

Properties summary

`public array`	`$helpers` Included helpers. Included helpers.	# `array("Html", "SessionFilter")`
`public array`	`$tags`	# `array( 'option' => "<option value=\"%s\"%s>%s</option>", 'checkbox' => "<input type=\"checkbox\" name=\"data[destination][]\" value=\"%s\" %s/>", 'radio' => "<input type=\"radio\" name=\"data[destination]\" value=\"%s\" %s/>", )`
`public string`	`$hiddenBranchLabel`	# `'*'`
`public`	`$excludeFromTreeIds`	#
`protected array`	`$treeParams`	# `array()`