1. class
  2. XELOS
  3. \
  4. Framework
  5. \
  6. XF
  7. \
  8. Lib
  9. \
  10. Hierarchy

Hierarchy

class Hierarchy

Helper for Data from Sys::Hierarchy

Methods

int
convert_context_id(mixed $short_id)

Get Context ID

int[]
evaluate_result(array $superiors_by_level, string $evaluation_method)

evaluate_result

Hierarchy
get_current(mixed $context_id = 1, int $user_id = null)

Get current hierarchy position for current user in specific context

bool|mixed
get_default_context()

Get Default Hierarchy Context

Hierarchy[]|ModelCollection
get_hierarchy(mixed $context_id = 1)

Get Hierarchy

Hierarchy
get_hierarchy_node(int $node_id, mixed $context_id = false)

Get a single hierarchy node (uses caching)

array
get_subordinates(int $context_id = 1, int $context_filter = null, int $user_id = null, bool $include_hierarchy_level = false)

Get Subordinates from Context ID You can apply additional filters which will limit the applicable users

User[][]|ModelCollection[]
get_superiors(int $context_id = 1, int $context_filter = null, int $user_id = null)

Get Superior Users from Context ID You can apply additional filters which will limit the applicable users

ModelCollection[]|User[][]
get_users_by_level(mixed $context_id, mixed $user_id, mixed $include_own_level = false, Hierarchy[] $hierarchy_per_level = [])

Helper for get_superiors

init_tree(mixed $context_id = 1)

Initialize a hierarchy tree Loads all hierarchy nodes as collection into internal array

Details

at line 56
int convert_context_id(mixed $short_id)

Get Context ID

Parameters

mixed $short_id

(Can be ID or SHORT)

Return Value

int

Context ID

at line 252
int[] evaluate_result(array $superiors_by_level, string $evaluation_method)

evaluate_result

Parameters

array $superiors_by_level
string $evaluation_method

'firstsuperiors' => ("Group of Superiors"), 'firstsuperior' => ("First Superior (Single Person)"), 'allsuperiors' => ("All Superiors"), 'first_superiors_secondlevel' => ("Group of Superiors (Second Level)"), 'first_superior_secondlevel' => ("First Superior (Second Level)"),

Return Value

int[]

User Ids

at line 76
Hierarchy get_current(mixed $context_id = 1, int $user_id = null)

Get current hierarchy position for current user in specific context

Parameters

mixed $context_id
int $user_id

Return Value

Hierarchy

at line 41
bool|mixed get_default_context()

Get Default Hierarchy Context

Return Value

bool|mixed

at line 233
Hierarchy[]|ModelCollection get_hierarchy(mixed $context_id = 1)

Get Hierarchy

Parameters

mixed $context_id

Return Value

Hierarchy[]|ModelCollection

of type HierarchyModel (system_model)

at line 289
Hierarchy get_hierarchy_node(int $node_id, mixed $context_id = false)

Get a single hierarchy node (uses caching)

Parameters

int $node_id
mixed $context_id

Return Value

Hierarchy

at line 184
array get_subordinates(int $context_id = 1, int $context_filter = null, int $user_id = null, bool $include_hierarchy_level = false)

Get Subordinates from Context ID You can apply additional filters which will limit the applicable users

Parameters

int $context_id

Hierarchy Context (Your Responsibility Context [e.g. Leader, CEO, Board])
int $context_filter

Additional Conditions to be applied as Hierarchy Tree (Your Department Context [e.g. Project, Department, Location])
int $user_id

(Default: Current User)
bool $include_hierarchy_level

Include the users responsibility level? (e.g. Colleagues)

Return Value

array

at line 98
User[][]|ModelCollection[] get_superiors(int $context_id = 1, int $context_filter = null, int $user_id = null)

Get Superior Users from Context ID You can apply additional filters which will limit the applicable users

Parameters

int $context_id

(Your Responsibility Context [e.g. Leader, CEO, Board])
int $context_filter

Additional Conditions to be applied (Your Department Context [e.g. Project, Department, Location])
int $user_id

(Default: Current User)

Return Value

User[][]|ModelCollection[]

Exceptions

Exception

at line 152
ModelCollection[]|User[][] get_users_by_level(mixed $context_id, mixed $user_id, mixed $include_own_level = false, Hierarchy[] $hierarchy_per_level = [])

Helper for get_superiors

Parameters

mixed $context_id
mixed $user_id
mixed $include_own_level
Hierarchy[] $hierarchy_per_level

Return Value

ModelCollection[]|User[][]

$users_by_level

Exceptions

Exception

at line 28
init_tree(mixed $context_id = 1)

Initialize a hierarchy tree Loads all hierarchy nodes as collection into internal array

Parameters

mixed $context_id