Stud.IP  6.0
StudipStudyArea Class Reference
Inheritance diagram for StudipStudyArea:
SimpleORMap StudipTreeNode

Public Member Functions

 __toString ()
 
 getInfo ()
 
 setInfo ($info)
 
 getName ()
 
 setName ($name)
 
 getParentId ()
 
 getParent ()
 
 setParentId ($parent_id)
 
 getType ()
 
 setType ($type)
 
 getTypeName ()
 
 isEditable ()
 
 isHidden ()
 
 getPath ($separator=NULL)
 
 getPriority ()
 
 setPriority ($priority)
 
 getChildren ()
 
 hasChildren ()
 
 isRoot ()
 
 isAssignable ()
 
 isModule ()
 
 getDescription ()
 
 getImage ()
 
 hasChildNodes ()
 
 getChildNodes (bool $onlyVisible=false)
 
 getAllChildNodes (bool $only_visible=false)
 
 countCourses ( $semester_id='all', $semclass=0, $with_children=false)
 
 getCourses ( $semester_id='all', $semclass=0, $searchterm='', $with_children=false, array $courses=[])
 
 getAncestors ()
 
 getIndex ()
 
- Public Member Functions inherited from SimpleORMap
 __construct ($id=null)
 
 __clone ()
 
 getRelationOptions ($relation)
 
 getTableMetadata ()
 
 hasAutoIncrementColumn ()
 
 setId ($id)
 
 getId ()
 
 getNewId ()
 
 toArray ($only_these_fields=null)
 
 toRawArray ($only_these_fields=null)
 
 toArrayRecursive ($only_these_fields=null)
 
 getValue ($field)
 
 getRelationValue ($relation, $field)
 
 getDefaultValue ($field)
 
 setValue ($field, $value)
 
 __get ($field)
 
 __set ($field, $value)
 
 __isset ($field)
 
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 
 getIterator ()
 
 count ()
 
 isField ($field)
 
 isRelation ($field)
 
 isAdditionalField ($field)
 
 isAliasField ($field)
 
 isI18nField ($field)
 
 setData ($data, $reset=false)
 
 isNew ()
 
 isDeleted ()
 
 setNew ($is_new)
 
 getWhereQuery ()
 
 restore ()
 
 store ()
 
 triggerChdate ()
 
 delete ()
 
 isDirty ()
 
 isFieldDirty ($field)
 
 revertValue ($field)
 
 getPristineValue ($field)
 
 initRelation ($relation)
 
 resetRelation ($relation)
 
 cleanup ()
 
- Public Member Functions inherited from StudipTreeNode
 getId ()
 
 countCourses (string $semester_id='', int $semclass=0, bool $with_children=false)
 
 getCourses (string $semester_id='all', int $semclass=0, string $searchterm='', bool $with_children=false, array $courses=[])
 

Static Public Member Functions

static findByParent ($parent_id)
 
static find ($id)
 
static getStudyAreasForCourse ($id)
 
static getRootArea ()
 
static search ($searchTerm)
 
static backwards ($nodes)
 
static getNode ($id)
 
static getCourseNodes (string $course_id)
 
- Static Public Member Functions inherited from SimpleORMap
static tableScheme ($db_table)
 
static expireTableScheme ()
 
static exists ($id)
 
static countBySql ($sql='1', $params=[])
 
static create ($data)
 
static build ($data, $is_new=true)
 
static buildExisting ($data)
 
static import ($data)
 
static findBySQL ($sql, $params=[])
 
static findOneBySQL ($where, $params=[])
 
static findThru ($foreign_key_value, $options)
 
static findEachBySQL ($callable, $sql, $params=[])
 
static findMany ($pks=[], $order='', $order_params=[])
 
static findEachMany ($callable, $pks=[], $order='', $order_params=[])
 
static findAndMapBySQL ($callable, $where, $params=[])
 
static findAndMapMany ($callable, $pks=[], $order='', $order_params=[])
 
static deleteBySQL ($where, $params=[])
 
static toObject ($id_or_object)
 
static __callStatic (string $name, array $arguments)
 

Data Fields

const ROOT = 'root'
 
 $required_children = []
 
- Data Fields inherited from SimpleORMap
const ID_SEPARATOR = '_'
 

Static Protected Member Functions

static configure ($config=[])
 
- Static Protected Member Functions inherited from SimpleORMap
static db_table ()
 
static db_fields ()
 
static pk ()
 
static default_values ()
 
static serialized_fields ()
 
static alias_fields ()
 
static i18n_fields ()
 
static additional_fields ()
 
static has_many ()
 
static has_one ()
 
static belongs_to ()
 
static has_and_belongs_to_many ()
 
static registered_callbacks ()
 
static known_slots ()
 
static notification_map ()
 
static getter_setter_map ()
 
static configure ($config=[])
 
static config ($key)
 
static registerCallback ($types, $cb)
 
static unregisterCallback ($types, $cb)
 

Additional Inherited Members

- Static Public Attributes inherited from SimpleORMap
static $schemes = null
 
- Protected Member Functions inherited from SimpleORMap
 _getId ($field)
 
 _setId ($field, $value)
 
 _getAdditionalValueFromRelation ($field)
 
 _setAdditionalValueFromRelation ($field, $value)
 
 _getAdditionalValue ($field)
 
 _setAdditionalValue ($field, $value)
 
 parseRelationOptions ($type, $name, $options)
 
 storeRelations ($only_these=null)
 
 deleteRelations ()
 
 initializeContent ()
 
 applyCallbacks ($type)
 
 cbNotificationMapper ($cb_type)
 
 cbAfterInitialize ($cb_type)
 
 setSerializedValue ($field, $value)
 
 setI18nValue ($field, $value)
 
- Protected Attributes inherited from SimpleORMap
 $content = []
 
 $content_db = []
 
 $is_new = true
 
 $is_deleted = false
 
 $relations = []
 
 $additional_data = []
 
- Static Protected Attributes inherited from SimpleORMap
static $config = []
 
static $reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']
 
static $performs_batch_operation = false
 

Member Function Documentation

◆ __toString()

__toString ( )

Get a string representation of this study area.

◆ backwards()

static backwards (   $nodes)
static

Takes an array of StudyArea objects and produces the tree to the root node

Parameters
array$nodesAll required nodes in the tree
Returns
StudipStudyArea the root node

◆ configure()

static configure (   $config = [])
staticprotected

◆ countCourses()

countCourses (   $semester_id = 'all',
  $semclass = 0,
  $with_children = false 
)

◆ find()

static find (   $id)
static

Returns the study area with the specified ID.

◆ findByParent()

static findByParent (   $parent_id)
static

Returns the children of the study area with the specified ID.

◆ getAllChildNodes()

getAllChildNodes ( bool  $only_visible = false)

Retrieves all child nodes of this study area as a flat list.

Parameters
bool$only_visibleWhether to include only visible nodes (true) or all nodes (false). Defaults to false.
Returns
StudipStudyArea[] A list of all child nodes of this node.

◆ getAncestors()

getAncestors ( )

Returns an array containing all ancestor nodes with id and name.

Returns
array

Implements StudipTreeNode.

◆ getChildNodes()

getChildNodes ( bool  $onlyVisible = false)

◆ getChildren()

getChildren ( )

Returns the children of this study area.

◆ getCourseNodes()

static getCourseNodes ( string  $course_id)
static

Fetches an array of all nodes the given course is assigned to.

Parameters
string$course_id
Returns
array

Implements StudipTreeNode.

◆ getCourses()

getCourses (   $semester_id = 'all',
  $semclass = 0,
  $searchterm = '',
  $with_children = false,
array  $courses = [] 
)

◆ getDescription()

getDescription ( )

Optional description for this node.

Returns
string

Implements StudipTreeNode.

◆ getImage()

getImage ( )

◆ getIndex()

getIndex ( )

Constructs an index from the level hierarchy, This index is a number, containing the "depth" level and the priority on this level. For example, a node on level 2 with priority 3 will get an index of 23.

Returns
int

◆ getInfo()

getInfo ( )

Get the comment of this study area.

◆ getName()

getName ( )

Get the display name of this study area.

Implements StudipTreeNode.

◆ getNode()

static getNode (   $id)
static

Fetches a node by the given ID. The implementing class knows what to do.

Parameters
mixed$id
Returns
StudipTreeNode

Implements StudipTreeNode.

◆ getParent()

getParent ( )

Get the parent.

◆ getParentId()

getParentId ( )

Get the parent ID of this study area.

◆ getPath()

getPath (   $separator = NULL)

Get the path along the sem_tree to this study area.

Parameters
stringoptional; TODO
Returns
mixed TODO

◆ getPriority()

getPriority ( )

Get the priority of this study area.

◆ getRootArea()

static getRootArea ( )
static

Returns the not really existing root study area.

Returns
object the root study area object

◆ getStudyAreasForCourse()

static getStudyAreasForCourse (   $id)
static

Get an associative array of all study areas of a course. The array contains StudipStudyArea instances

Parameters
string$idthe course's ID
Returns
SimpleCollection a SimpleORMapCollection of that course's study areas

◆ getType()

getType ( )

get the type of this study area.

◆ getTypeName()

getTypeName ( )

get the name of the type of this study area, see $SEM_TREE_TYPES in config.inc.php

Returns
string

◆ hasChildNodes()

hasChildNodes ( )

Indicator if this node has children.

Returns
bool

Implements StudipTreeNode.

◆ hasChildren()

hasChildren ( )

Returns1 TRUE if the area has children.

◆ isAssignable()

isAssignable ( )

Returns TRUE if this area can be select.

◆ isEditable()

isEditable ( )

is this study area editable, see $SEM_TREE_TYPES in config.inc.php

Returns
bool

◆ isHidden()

isHidden ( )

is this study area hidden, see $SEM_TREE_TYPES in config.inc.php

Returns
bool

◆ isModule()

isModule ( )

is this study area considered a study modul?, see $SEM_TREE_TYPES in config.inc.php

Returns
bool

◆ isRoot()

isRoot ( )

Returns TRUE if this area is the root.

◆ search()

static search (   $searchTerm)
static

Search for study areas whose name matches the given search term.

Parameters
string$searchTermthe seach term
Returns
StudipStudyArea[] nodes

◆ setInfo()

setInfo (   $info)

Set the comment of this study area.

◆ setName()

setName (   $name)

Set the display name of this study area.

◆ setParentId()

setParentId (   $parent_id)

Set the parent of this study area.

◆ setPriority()

setPriority (   $priority)

Set the priority of this study area.

◆ setType()

setType (   $type)

set the type of this study area.

Field Documentation

◆ $required_children

$required_children = []

This is required, if the nodes are added backwards

◆ ROOT

const ROOT = 'root'

This constant represents the key of the root area.


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