Properties

$itCounter

$itCounter : mixed

itCounter

Type

mixed — itCounter

$whereCols

$whereCols : mixed

whereCols

Type

mixed — whereCols

$treeArray

$treeArray : mixed

treeArray

Type

mixed — treeArray

$extensionTables

$extensionTables : mixed

extensionTables

Type

mixed — extensionTables

$DATA_API

$DATA_API : mixed

DATA_API

Type

mixed — DATA_API

$config

$config : mixed

config

Type

mixed — config

$treeStyle

$treeStyle : mixed

treeStyle

Type

mixed — treeStyle

$outputString

$outputString : mixed

outputString

Type

mixed — outputString

$whereClause

$whereClause : mixed

whereClause

Type

mixed — whereClause

Methods

__construct()

__construct(  $config = null) : NULL

DESCRIPTOR: __construct

Parameters

$config

Returns

NULL

setTreeStyle()

setTreeStyle(string  $treeStyle = 'TEXT', array  $extArgs = null) : boolean

TEXT - plain text SIMPLE - basic tree array FULL - basic tree array with data for each node EXTENDED - tree array with join data for each node

Parameters

string $treeStyle
array $extArgs

Returns

boolean

getTreeStyle()

getTreeStyle() : NULL

DESCRIPTOR: getTreeStyle

Returns

NULL

getCallBackDisplay()

getCallBackDisplay() : NULL

DESCRIPTOR: getCallBackDisplay

Returns

NULL

setCallBackDisplay()

setCallBackDisplay(  $callBackDisplay) : NULL

DESCRIPTOR: setCallBackDisplay

Parameters

$callBackDisplay

Returns

NULL

select_tree()

select_tree(  $root) : NULL

this is a bias towards selecting the whole menu rather than a sub-branch break out functions for these conditions A) if $root is_int - select the root node data inc whereCols [scope a specific tree] (new func to build "from clause") - select all the sub-nodes of that tree/branch ELSE - select the root node data - select all sub-nodes of the tree B) if $this->config["treeStyle"] == EXTENDED -

Parameters

$root

Returns

NULL

render_tree()

render_tree(  $result) : string

catch all method to render a tree calls the internal text or array methods or passes off to a handler method

Parameters

$result

Returns

string —

result

render_tree_array()

render_tree_array(  $result,   $ACL = false) : \JCORE\DAO\TREE\this->treeArray

converts the array from a mysql result into a tree array

Parameters

$result
$ACL

Returns

\JCORE\DAO\TREE\this->treeArray

render_tree_text()

render_tree_text(  $result) : NULL

output a basic text tree with indentation

Parameters

$result

Returns

NULL

addNode()

addNode(integer  $nodeId = null, array  $values = null, boolean  $child = false) : integer|boolean

DESCRIPTOR: addNode loads the cfg internally and returns a value of true if all good

Parameters

integer $nodeId
array $values
boolean $child

Returns

integer|boolean

addAttributes()

addAttributes(integer  $nodeId = null) : null

DESCRIPTOR: adds attribute record

Parameters

integer $nodeId

Returns

null

deleteNode()

deleteNode(integer  $nodeId = null) : null

DESCRIPTOR: loads the ini internally and returns a value of true if all good

Parameters

integer $nodeId

Returns

null

removeAttributes()

removeAttributes(integer  $nodeId = null) : null

DESCRIPTOR: removes attribute record

Parameters

integer $nodeId

Returns

null

unsetNode()

unsetNode(  $nodeData = null) : null

DESCRIPTOR: loads the ini internally and returns a value of true if all good

Parameters

$nodeData

Returns

null

resetNode()

resetNode(integer  $nodeId = null, \JCORE\DAO\TREE\arrray  $values = null, boolean  $child = true) : null

DESCRIPTOR: loads the cfg internally and returns a value of true if all good

Parameters

integer $nodeId
\JCORE\DAO\TREE\arrray $values
boolean $child

Returns

null

sortNode()

sortNode(integer  $nodeId = null, string  $sortOrder = 'UP') : boolean

DESCRIPTOR: sortNode loads the cfg internally and returns a value of true if all good $sortOrder UP/DOWN

Parameters

integer $nodeId
string $sortOrder

Returns

boolean

checkIndex()

checkIndex(  $indexName = null) : NULL

DESCRIPTOR: checkIndex

Parameters

$indexName

Returns

NULL

unlockTable()

unlockTable(  $reIndex = false) : mixed

DESCRIPTOR: unlockTable

Parameters

$reIndex

Returns

mixed —

result

lockTable()

lockTable(  $deIndex = false) : NULL

DESCRIPTOR: lockTable

Parameters

$deIndex

Returns

NULL

changeParent()

changeParent(  $nodeId = null,   $newParentId = null) : NULL

DESCRIPTOR: changeParent

Parameters

$nodeId
$newParentId

Returns

NULL

setWhereClause()

setWhereClause(  $setAnd = true,   $prepend = '') : NULL

DESCRIPTOR: setWhereClause

Parameters

$setAnd
$prepend

Returns

NULL

setUniqueColumns()

setUniqueColumns(  $baseColumn = '',   $asInsert = false) : NULL

DESCRIPTOR: setUniqueColumns

Parameters

$baseColumn
$asInsert

Returns

NULL

joinAttributes()

joinAttributes(  $setAnd = true) : NULL

joinAttributes must return Select extension (add the fields of multiple attributes tables) From extension (add the attributes table) Where extension (scope the look up to FK join)

SELECT [$structureScopeTable]leftBound, [$structureScopeTable]rightBound [selectExt] FROM treeStructure [structureScopeTableFrom] [fromExt] [setWhereClause()] [whereExt] ORDER BY leftBound ASC ;

Parameters

$setAnd

Returns

NULL