Documentation

AjaxTree
in package

Class AjaxTree

Table of Contents

$db  : mixed
$default  : mixed
$options  : mixed
__construct()  : mixed
AjaxTree constructor.
analyze()  : array<string|int, mixed>|bool
cp()  : int
dump()  : mixed
get_children()  : mixed
get_node()  : mixed
get_path()  : bool
mk()  : mixed
mv()  : bool
reconstruct()  : bool
res()  : bool
rm()  : bool
rn()  : bool

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' => 'pid', 'position' => 'pos', ), 'data' => array(), )

Methods

__construct()

AjaxTree constructor.

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([bool $get_errors = false ]) : array<string|int, mixed>|bool
Parameters
$get_errors : bool = false
Return values
array<string|int, mixed>|bool

cp()

public cp( $id,  $parent, int $position) : int
Parameters
$id :
$parent :
$position : int
Tags
throws
Exception
Return values
int

get_children()

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

get_node()

public get_node( $id[, array<string|int, mixed> $options = array() ]) : mixed
Parameters
$id :
$options : array<string|int, mixed> = array()
Tags
throws
Exception
Return values
mixed

get_path()

public get_path( $id) : bool
Parameters
$id :
Tags
throws
Exception
Return values
bool

mk()

public mk( $parent, int $position[, array<string|int, mixed> $data = array() ]) : mixed
Parameters
$parent :
$position : int
$data : array<string|int, mixed> = array()
Tags
throws
Exception
Return values
mixed

mv()

public mv( $id,  $parent, int $position) : bool
Parameters
$id :
$parent :
$position : int
Tags
throws
Exception
Return values
bool

reconstruct()

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

res()

public res([array<string|int, mixed> $data = array() ]) : bool
Parameters
$data : array<string|int, mixed> = array()
Tags
throws
Exception
Return values
bool

rm()

public rm( $id) : bool
Parameters
$id :
Tags
throws
Exception
Return values
bool

rn()

public rn( $id,  $data) : bool
Parameters
$id :
$data :
Tags
throws
Exception
Return values
bool

Search results