class Tree extends ConcreteObject (View source)

Properties

$error from ConcreteObject
protected $treeNodeSelectedIDs

Methods

loadError($error)

No description

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

static 
camelcase($file)

No description

static 
uncamelcase($string)

No description

loadDetails()

No description

deleteDetails()

No description

string
getTreeName()

Returns the standard name for this tree

string
getTreeDisplayName(string $format = 'html')

Returns the display name for this tree (localized and escaped accordingly to $format)

exportDetails(SimpleXMLElement $sx)

No description

static Tree|null
importDetails(SimpleXMLElement $sx)

No description

setSelectedTreeNodeIDs($nodeIDs)

No description

getSelectedTreeNodeIDs()

No description

getTreeTypeID()

No description

getTreeTypeObject()

No description

getTreeTypeHandle()

No description

export(SimpleXMLElement $sx)

No description

static 
exportList(SimpleXMLElement $sx)

No description

static 
import(SimpleXMLElement $sx)

No description

getTreeID()

No description

getRootTreeNodeObject()

No description

getRootTreeNodeID()

No description

getNodeByDisplayPath($path)

Iterates through the segments in the path, to return the node at the proper display. Mostly used for export and import.

getRequestData()

No description

setRequest($data)

No description

delete()

No description

duplicate()

No description

getJSON()

No description

static 
create(Node $rootNode)

No description

static 
getByID($treeID)

No description

static Translations
exportTranslations()

Export all the translations associates to every trees.

Details

loadError($error)

Parameters

$error

isError()

getError()

setPropertiesFromArray($arr)

Parameters

$arr

static camelcase($file)

Parameters

$file

static uncamelcase($string)

Parameters

$string

abstract protected loadDetails()

abstract protected deleteDetails()

abstract string getTreeName()

Returns the standard name for this tree

Return Value

string

abstract string getTreeDisplayName(string $format = 'html')

Returns the display name for this tree (localized and escaped accordingly to $format)

Parameters

string $format = 'html' Escape the result in html format (if $format is 'html'). If $format is 'text' or any other value, the display name won't be escaped

Return Value

string

abstract exportDetails(SimpleXMLElement $sx)

Parameters

SimpleXMLElement $sx

static Tree|null importDetails(SimpleXMLElement $sx)

Parameters

SimpleXMLElement $sx

Return Value

Tree|null

setSelectedTreeNodeIDs($nodeIDs)

Parameters

$nodeIDs

getSelectedTreeNodeIDs()

getTreeTypeID()

getTreeTypeObject()

getTreeTypeHandle()

export(SimpleXMLElement $sx)

Parameters

SimpleXMLElement $sx

static exportList(SimpleXMLElement $sx)

Parameters

SimpleXMLElement $sx

static import(SimpleXMLElement $sx)

Parameters

SimpleXMLElement $sx

getTreeID()

getRootTreeNodeObject()

getRootTreeNodeID()

getNodeByDisplayPath($path)

Iterates through the segments in the path, to return the node at the proper display. Mostly used for export and import.

Parameters

$path

getRequestData()

setRequest($data)

Parameters

$data

delete()

duplicate()

getJSON()

static protected create(Node $rootNode)

Parameters

Node $rootNode

final static getByID($treeID)

Parameters

$treeID

static Translations exportTranslations()

Export all the translations associates to every trees.

Return Value

Translations