Documentation

tree
in package

Table of Contents

$db  : mixed
$default  : mixed
$options  : mixed
__construct()  : mixed
analyze()  : mixed
cp()  : mixed
dump()  : mixed
get_children()  : mixed
get_node()  : mixed
get_path()  : mixed
mk()  : mixed
mv()  : mixed
reconstruct()  : mixed
res()  : mixed
rm()  : mixed
rn()  : mixed

Properties

$default

protected mixed $default = array( 'structure_table' => 'structure', // the structure table (containing the id, left, right, level, parent_id and position fields) 'data_table' => 'structure', // table for additional fields (apart from structure ones, can be the same as structure_table) 'data2structure' => 'id', // which field from the data table maps to the structure table 'structure' => array( // which field (value) maps to what in the structure (key) 'id' => 'id', 'left' => 'lft', 'right' => 'rgt', 'level' => 'lvl', 'parent_id' => 'parent_id', 'position' => 'pos', ), 'data' => array(), )

Methods

__construct()

public __construct(IDB $db[, array<string|int, mixed> $options = array() ]) : mixed
Parameters
$db : IDB
$options : array<string|int, mixed> = array()
Return values
mixed

analyze()

public analyze([mixed $get_errors = false ]) : mixed
Parameters
$get_errors : mixed = false
Return values
mixed

cp()

public cp(mixed $id, mixed $parent, mixed $position) : mixed
Parameters
$id : mixed
$parent : mixed
$position : mixed
Return values
mixed

dump()

public dump() : mixed
Return values
mixed

get_children()

public get_children(mixed $id[, mixed $recursive = false ]) : mixed
Parameters
$id : mixed
$recursive : mixed = false
Return values
mixed

get_node()

public get_node(mixed $id[, mixed $options = array() ]) : mixed
Parameters
$id : mixed
$options : mixed = array()
Return values
mixed

get_path()

public get_path(mixed $id) : mixed
Parameters
$id : mixed
Return values
mixed

mk()

public mk(mixed $parent, mixed $position[, mixed $data = array() ]) : mixed
Parameters
$parent : mixed
$position : mixed
$data : mixed = array()
Return values
mixed

mv()

public mv(mixed $id, mixed $parent, mixed $position) : mixed
Parameters
$id : mixed
$parent : mixed
$position : mixed
Return values
mixed

reconstruct()

public reconstruct([mixed $analyze = true ]) : mixed
Parameters
$analyze : mixed = true
Return values
mixed

res()

public res([mixed $data = array() ]) : mixed
Parameters
$data : mixed = array()
Return values
mixed

rm()

public rm(mixed $id) : mixed
Parameters
$id : mixed
Return values
mixed

rn()

public rn(mixed $id, mixed $data) : mixed
Parameters
$id : mixed
$data : mixed
Return values
mixed

Search results