MvvTreeItem Interface Reference

Inheritance diagram for MvvTreeItem:

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

Here is the caller graph for this function:

getDisplayName()

getDisplayName

(

)

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

Returns

string

Implemented in MvvTreeRoot.

Here is the caller graph for this function:

getId()

getId

(

)

Returns the id of this object.

Returns

string

Implemented in MvvTreeRoot.

Here is the caller graph for this function:

getParents()

getParents

(

$mode

)

Returns all parents of this object.

Parameters

int

$mode

Parameter to modify search result.

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

Here is the caller graph for this function:

getTrailParent()

getTrailParent

(

)

Returns the parent of this object in the specific trail.

Returns

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

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

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

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

isAssignable()

isAssignable

(

)

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

Implemented in MvvTreeRoot, Lvgruppe, and ModuleManagementModelTreeItem.

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