Stud.IP  5.4
StudipRangeTree Class Reference
Inheritance diagram for StudipRangeTree:
TreeAbstract

Public Member Functions

 __construct ($args)
 
 init ()
 
 initEntries ()
 
 getAdminRange ($item_id)
 
 getNextLink ($item_id)
 
 getSemIds ($item_id, $ids_from_kids=false)
 
 getNumEntries ($item_id, $num_entries_from_kids=false)
 
 InsertItem ($item_id, $parent_id, $item_name, $priority, $studip_object, $studip_object_id)
 
 UpdateItem ($item_name, $studip_object, $studip_object_id, $item_id)
 
 DeleteItems ($items_to_delete)
 
- Public Member Functions inherited from TreeAbstract
 init ()
 
 storeItem ($item_id, $parent_id, $name, $priority)
 
 buildIndex ($item_id=false)
 
 getKids ($item_id)
 
 getNumKids ($item_id)
 
 getKidsKids ($item_id, $in_recursion=false)
 
 getNumKidsKids ($item_id, $in_recursion=false)
 
 isLastKid ($item_id)
 
 isFirstKid ($item_id)
 
 isChildOf ($ancestor_id, $item_id)
 
 hasKids ($item_id)
 
 getItemPath ($item_id)
 
 getParents ($item_id)
 
 getShortPath ($item_id, $length=null, $delimeter=">", $offset=0)
 
 getMaxPriority ($parent_id)
 
 getNumEntries ($item_id, $num_entries_from_kids=false)
 
 getNumEntriesKids ($item_id, $in_recursion=false)
 
 getValue ($item_id, $field)
 

Data Fields

 $sem_number
 
 $sem_status
 
 $sem_dates
 
 $studip_objects = []
 
 $visible_only
 
 $entries_init_done = false
 
- Data Fields inherited from TreeAbstract
 $root_name
 
 $view
 
 $tree_data = []
 
 $tree_childs = []
 
 $tree_num_childs = []
 
 $index_offset = 0
 

Additional Inherited Members

- Static Public Member Functions inherited from TreeAbstract
static GetInstance ($class_name, $args=null, $invalidate_cache=false)
 
- Protected Member Functions inherited from TreeAbstract
 __construct ()
 

Constructor & Destructor Documentation

◆ __construct()

__construct (   $args)

constructor

do not use directly, call TreeAbstract::GetInstance("StudipRangeTree") private

Member Function Documentation

◆ DeleteItems()

DeleteItems (   $items_to_delete)

◆ getAdminRange()

getAdminRange (   $item_id)

Returns Stud.IP range_id of the next "real" object

This function finds the next item wich is a real Stud.IP Object, either an "Einrichtung" or a "Fakultaet"
useful for the user rights management public

Parameters
string$item_id
Returns
bool|array of primary keys from table "institute"

◆ getNextLink()

getNextLink (   $item_id)

returns the next item_id upwards the tree which is a Stud.IP object

help function for getAdminRange()

private

Parameters
string$item_id
Returns
string

◆ getNumEntries()

getNumEntries (   $item_id,
  $num_entries_from_kids = false 
)

◆ getSemIds()

getSemIds (   $item_id,
  $ids_from_kids = false 
)

◆ init()

init ( )

initializes the tree

stores all rows from table range_tree in array $tree_data public

◆ initEntries()

initEntries ( )

◆ InsertItem()

InsertItem (   $item_id,
  $parent_id,
  $item_name,
  $priority,
  $studip_object,
  $studip_object_id 
)

◆ UpdateItem()

UpdateItem (   $item_name,
  $studip_object,
  $studip_object_id,
  $item_id 
)

Field Documentation

◆ $entries_init_done

$entries_init_done = false

◆ $sem_dates

$sem_dates

◆ $sem_number

◆ $sem_status

$sem_status

◆ $studip_objects

$studip_objects = []

◆ $visible_only

$visible_only

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