1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. Tree
  7. \
  8. Tree

Tree

abstract class Tree extends ConcreteObject (View source)

Properties

$error from  ConcreteObject
protected $treeNodeSelectedIDs

Methods

loadError($error)

No description

from  ConcreteObject
isError()

No description

from  ConcreteObject
getError()

No description

from  ConcreteObject
setPropertiesFromArray($arr)

No description

from  ConcreteObject
static 
camelcase($file)

No description

from  ConcreteObject
static 
uncamelcase($string)

No description

from  ConcreteObject
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

Node|null
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 Tree|null
getByID(int|mixed $treeID)

No description

static Translations
exportTranslations()

Export all the translations associates to every trees.

Details

in ConcreteObject at line 11
loadError($error)

No description

Parameters

$error

in ConcreteObject at line 16
isError()

No description

in ConcreteObject at line 26
getError()

No description

in ConcreteObject at line 31
setPropertiesFromArray($arr)

No description

Parameters

$arr

in ConcreteObject at line 38
static camelcase($file)

No description

Parameters

$file

in ConcreteObject at line 43
static uncamelcase($string)

No description

Parameters

$string

at line 17
abstract protected loadDetails()

No description

at line 19
abstract protected deleteDetails()

No description

at line 24
abstract string getTreeName()

Returns the standard name for this tree

Return Value

string

at line 31
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

at line 33
abstract exportDetails(SimpleXMLElement $sx)

No description

Parameters

SimpleXMLElement $sx

at line 41
static Tree|null importDetails(SimpleXMLElement $sx)

No description

Parameters

SimpleXMLElement $sx

Return Value

Tree|null

at line 46
setSelectedTreeNodeIDs($nodeIDs)

No description

Parameters

$nodeIDs

at line 51
getSelectedTreeNodeIDs()

No description

at line 56
getTreeTypeID()

No description

at line 60
getTreeTypeObject()

No description

at line 65
getTreeTypeHandle()

No description

at line 73
export(SimpleXMLElement $sx)

No description

Parameters

SimpleXMLElement $sx

at line 83
static exportList(SimpleXMLElement $sx)

No description

Parameters

SimpleXMLElement $sx

at line 95
static import(SimpleXMLElement $sx)

No description

Parameters

SimpleXMLElement $sx

at line 104
getTreeID()

No description

at line 112
Node|null getRootTreeNodeObject()

No description

Return Value

Node|null

at line 117
getRootTreeNodeID()

No description

at line 128
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

at line 165
getRequestData()

No description

at line 170
setRequest($data)

No description

Parameters

$data

at line 175
delete()

No description

at line 188
duplicate()

No description

at line 204
getJSON()

No description

at line 221
static protected create(Node $rootNode)

No description

Parameters

Node $rootNode

at line 243
final static Tree|null getByID(int|mixed $treeID)

No description

Parameters

int|mixed $treeID

Return Value

Tree|null

at line 279
static Translations exportTranslations()

Export all the translations associates to every trees.

Return Value

Translations