Stud.IP  5.4
RangeTreeObject Class Reference
Inheritance diagram for RangeTreeObject:
RangeTreeObjectFak RangeTreeObjectInst

Public Member Functions

 __construct ($item_id)
 
 getAllItemKids ($as_value_list=false)
 
 getAllObjectKids ($as_value_list=false)
 
 getInstKids ($as_value_list=false)
 
 getFakKids ($as_value_list=false)
 
 getAdminRange ()
 
 isInCorrectBranch ()
 
 getItemPath ()
 
 initItemDetail ()
 
 fetchCategories ()
 
getCategories ()
 
 fetchNumStaff ()
 
 getNumStaff ()
 
 getValueList ($list)
 

Static Public Member Functions

static GetInstance ($item_id)
 

Data Fields

 $tree_item_id
 
 $tree
 
 $item_data = null
 
 $item_data_mapping = null
 

Constructor & Destructor Documentation

◆ __construct()

__construct (   $item_id)

Constructor

Do not use directly, call factory method instead private

Parameters
string$item_id

Member Function Documentation

◆ fetchCategories()

fetchCategories ( )

fetch categories of this object from database

the categories are appended to the $item_data array, key 'categories', value is object of type DbSnapshot private

Returns
boolean true if categories were found

◆ fetchNumStaff()

fetchNumStaff ( )

◆ getAdminRange()

getAdminRange ( )

Returns array of Stud.IP range_ids of "real" objects

This function is a wrapper for the according function in StudipRangeTree

See also
StudipRangeTree::getAdminRange() public
Returns
array of primary keys from table "institute"

◆ getAllItemKids()

getAllItemKids (   $as_value_list = false)

Returns all tree items which are kids of this object

public

Parameters
boolean$as_value_list
Returns
mixed returns numeric array if param is false, else comma separated string

◆ getAllObjectKids()

getAllObjectKids (   $as_value_list = false)

Returns all tree items which are kids of this object and are "real" Stud.IP objects

public

Parameters
boolean$as_value_list
Returns
mixed returns numeric array if param is false, else comma separated string

◆ getCategories()

& getCategories ( )

getter method for categories of this object

public

Returns
object DbSnapshot

◆ getFakKids()

getFakKids (   $as_value_list = false)

Returns all tree items which are kids of this object and are Stud.IP "Fakultaeten"

public

Parameters
boolean$as_value_list
Returns
mixed returns numeric array if param is false, else comma separated string

◆ GetInstance()

static GetInstance (   $item_id)
static

Factory method

public

Parameters
string$item_id
Returns
object RangeTreeObject

◆ getInstKids()

getInstKids (   $as_value_list = false)

Returns all tree items which are kids of this object and are Stud.IP "Einrichtungen"

public

Parameters
boolean$as_value_list
Returns
mixed returns numeric array if param is false, else comma separated string

◆ getItemPath()

getItemPath ( )

Returns tree path of the current object

This function is a wrapper for the according function in StudipRangeTree

See also
StudipRangeTree::getItemPath() public
Returns
string

◆ getNumStaff()

getNumStaff ( )

◆ getValueList()

getValueList (   $list)

transform numerical array into a comma separated string

the result could be used in a SQL query private

Parameters
array$list
Returns
string

◆ initItemDetail()

initItemDetail ( )

extends the $item_data array

This function fills the $item_data array with fields from the according database table (is of no use in the base class) private

◆ isInCorrectBranch()

isInCorrectBranch ( )

Only useful in RangeTreeObjectInst ,all other items are always in the correct branch

public

Returns
bool

Field Documentation

◆ $item_data

array $item_data = null

associative array with data from database fields

public

◆ $item_data_mapping

array $item_data_mapping = null

associative array with mapping for database fields

public

◆ $tree

object StudipRangeTree $tree

References the tree object

private

◆ $tree_item_id

string $tree_item_id

item_id in range_tree

public


The documentation for this class was generated from the following file: