|
| __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 () |
|
| __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 () |
|
| 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 | 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 | 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) |
|
|
static | $schemes = null |
|
| _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) |
|
| $content = [] |
|
| $content_db = [] |
|
| $is_new = true |
|
| $is_deleted = false |
|
| $relations = [] |
|
| $additional_data = [] |
|
static | $config = [] |
|
static | $reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id'] |
|
static | $performs_batch_operation = false |
|
◆ __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 | $nodes | All 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()
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_visible | Whether 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()
Returns an array containing all ancestor nodes with id and name.
- Returns
- array
Implements StudipTreeNode.
◆ getChildNodes()
getChildNodes |
( |
bool |
$onlyVisible = false | ) |
|
◆ 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
-
- Returns
- array
Implements StudipTreeNode.
◆ getCourses()
getCourses |
( |
|
$semester_id = 'all' , |
|
|
|
$semclass = 0 , |
|
|
|
$searchterm = '' , |
|
|
|
$with_children = false , |
|
|
array |
$courses = [] |
|
) |
| |
◆ getDescription()
Optional description for this node.
- Returns
- string
Implements StudipTreeNode.
◆ getImage()
◆ 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()
Get the comment of this study area.
◆ getName()
◆ getNode()
◆ getParent()
◆ 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
-
- Returns
- mixed TODO
◆ getPriority()
Get the priority of this study area.
◆ getRootArea()
Returns the not really existing root study area.
- Returns
- object the root study area object
◆ getStudyAreasForCourse()
static getStudyAreasForCourse |
( |
|
$id | ) |
|
|
static |
◆ getType()
get the type of this study area.
◆ getTypeName()
get the name of the type of this study area, see $SEM_TREE_TYPES in config.inc.php
- Returns
- string
◆ hasChildNodes()
Indicator if this node has children.
- Returns
- bool
Implements StudipTreeNode.
◆ hasChildren()
Returns1 TRUE if the area has children.
◆ isAssignable()
Returns TRUE if this area can be select.
◆ isEditable()
is this study area editable, see $SEM_TREE_TYPES in config.inc.php
- Returns
- bool
◆ isHidden()
is this study area hidden, see $SEM_TREE_TYPES in config.inc.php
- Returns
- bool
◆ isModule()
is this study area considered a study modul?, see $SEM_TREE_TYPES in config.inc.php
- Returns
- bool
◆ 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 | $searchTerm | the seach term |
- Returns
- StudipStudyArea[] nodes
◆ setInfo()
Set the comment of this study area.
◆ setName()
Set the display name of this study area.
◆ setParentId()
setParentId |
( |
|
$parent_id | ) |
|
Set the parent of this study area.
◆ setPriority()
Set the priority of this study area.
◆ setType()
set the type of this study area.
◆ $required_children
This is required, if the nodes are added backwards
◆ ROOT
This constant represents the key of the root area.
The documentation for this class was generated from the following file: