Stud.IP: MvvTreeItem Interface Reference

Inheritance diagram for MvvTreeItem:

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()

getChildren ( )

Returns all children of this object.

Returns: SimplORMapCollection

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

◆ getDisplayName()

getDisplayName ( )

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

Returns: string

Implemented in Studiengang, Abschluss, Modul, StgteilVersion, Fachbereich, Modulteil, StudiengangTeil, MvvCourse, MvvTreeRoot, and StgteilabschnittModul.

◆ getId()

getId ( )

Returns the id of this object.

Returns: string

Implemented in MvvTreeRoot.

◆ getParents()

getParents ( $mode )

Returns all parents of this object.

Parameters

int $mode Parameter to modify search result.

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

◆ getTrailParent()

getTrailParent ( )

Returns the parent of this object in the specific trail.

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

◆ getTrailParentId()

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, Abschluss, StgteilVersion, Lvgruppe, AbschlussKategorie, Modul, Modulteil, StgteilAbschnitt, StgteilabschnittModul, StudiengangTeil, Fachbereich, MvvCourse, ModuleManagementModelTreeItem, and MvvTreeRoot.

◆ getTrails()

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	$types	An array of class names.
int	$mode	Modifeies the result (only possible value is MvvTreeItem::TRAIL_SHOW_INCOMPLETE)
array	$path	The uncomplete path (used in recursion)
boolean	$last	True 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()

hasChildren ( )

Returns whether this object has children.

Returns: boolean

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

◆ isAssignable()

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

◆ TRAIL_SHOW_INCOMPLETE

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:

lib/classes/MvvTreeItem.php

Public Member Functions

Data Fields