Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
MvvTreeItem Interface Reference
Inheritance diagram for MvvTreeItem:
ModuleManagementModelTreeItem MvvTreeRoot Abschluss AbschlussKategorie Fach Fachbereich Lvgruppe Modul Modulteil MvvCourse StgteilAbschnitt StgteilabschnittModul StgteilVersion Studiengang StudiengangTeil

Public Member Functions

 getTrailParentId ()
 
 getTrailParent ()
 
 getChildren ()
 
 hasChildren ()
 
 getId ()
 
 getDisplayName ()
 
 isAssignable ()
 
 getParents ($mode)
 
 getTrails ($types=null, $mode=null, $path=null, $in_recursion=false)
 

Data Fields

const TRAIL_SHOW_INCOMPLETE = 1
 

Member Function Documentation

getChildren ( )

Returns all children of this object.

Returns
SimplORMapCollection

Implemented in Studiengang, Fach, StgteilVersion, Lvgruppe, Abschluss, AbschlussKategorie, Modul, Modulteil, StgteilAbschnitt, StgteilabschnittModul, Fachbereich, StudiengangTeil, MvvCourse, and MvvTreeRoot.

getDisplayName ( )

Returns the name of the object to displa in the trail.

Returns
string

Implemented in MvvTreeRoot.

getId ( )

Returns the id of this object.

Returns
string

Implemented in MvvTreeRoot.

getParents (   $mode)

Returns all parents of this object.

Parameters
int$modeParameter to modify search result.

Implemented in Studiengang, Fach, Abschluss, Lvgruppe, StgteilVersion, AbschlussKategorie, Modul, Modulteil, StgteilAbschnitt, StgteilabschnittModul, Fachbereich, StudiengangTeil, MvvTreeRoot, and MvvCourse.

getTrailParent ( )

Returns the parent of this object in the specific trail.

Returns
object The parent object, null if object has no parent.

Implemented in Studiengang, Fach, StgteilVersion, Lvgruppe, Abschluss, AbschlussKategorie, Modul, Modulteil, StgteilAbschnitt, StgteilabschnittModul, Fachbereich, StudiengangTeil, MvvCourse, and MvvTreeRoot.

getTrailParentId ( )

Returns the parent of the last selected item. Used by assignnment of LV-Gruppen to courses.

Returns
string|null Id of object, null if object has no parent.

Implemented in Studiengang, Fach, StgteilVersion, Lvgruppe, Abschluss, AbschlussKategorie, Modul, Modulteil, StgteilAbschnitt, StgteilabschnittModul, Fachbereich, StudiengangTeil, ModuleManagementModelTreeItem, MvvCourse, and MvvTreeRoot.

getTrails (   $types = null,
  $mode = null,
  $path = null,
  $in_recursion = false 
)

Returns all trails (pathes through the mvv object structure) for one object. The trails are the relations of this object along the given types (classes of MvvTreeItem objects) to the root object type.

Parameters
array$typesAn array of class names.
int$modeModifeies the result (only possible value is MvvTreeItem::TRAIL_SHOW_INCOMPLETE)
array$pathThe uncomplete path (used in recursion)
boolean$lastTrue if the last object (no parents) is reached (used in recursion)
Returns
array An Array of trails. Each trail is an array of objects with the class names as keys. Each trail consists of the objects defined by the types parameter and have the same order as the types array.

Implemented in MvvTreeRoot, and ModuleManagementModelTreeItem.

hasChildren ( )

Returns whether this object has children.

Returns
boolean

Implemented in Studiengang, Fach, StgteilVersion, Abschluss, Lvgruppe, Modul, Modulteil, StgteilabschnittModul, Fachbereich, ModuleManagementModelTreeItem, MvvTreeRoot, and MvvCourse.

isAssignable ( )

Returns whether this object is assignable to courses. Only used by selecting and asssigning LV-Gruppen to courses.

Implemented in Lvgruppe, ModuleManagementModelTreeItem, and MvvTreeRoot.

Field Documentation

const TRAIL_SHOW_INCOMPLETE = 1

Returns a trail even if the object is not related to the root item.


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