StudipStudyArea Class Reference

Collaboration diagram for StudipStudyArea:

Public Member Functions
	__construct ()
	__toString ()
	getID ()
	setID ($id)
	getInfo ()
	setInfo ($info)
	getName ()
	setName ($name)
	getParentId ()
	getParent ()
	setParentId ($parent_id)
	getType ()
	setType ($type)
	getTypeName ()
	isEditable ()
	getPath ($separator=NULL)
	getPriority ()
	setPriority ($priority)
	getStudipObjectId ()
	setStudipObjectId ($id)
	getChildren ()
	hasChildren ()
	isRoot ()
	isAssignable ()
	store ()
	delete ()
	restore ($fields)
	isModule ()
	getModuleDescription ($semester_id= '')
	getModuleInfoHTML ($semester_id= '')

Static Public Member Functions
static	find ($id)
static	getStudyAreasForCourse ($id)
static	getRootArea ()
static	search ($searchTerm)

Data Fields
const	ROOT = 'root'

Constructor & Destructor Documentation

__construct

(

)

Constructor.

Returns

void

Member Function Documentation

__toString

(

)

Get a string representation of this study area.

delete

(

)

Delete this user domain from the database.

Here is the call graph for this function:

static find (   $id )

static

Returns the study area with the specified ID.

Here is the call graph for this function:

Here is the caller graph for this function:

getChildren

(

)

Returns the children of this study area.

Here is the call graph for this function:

Here is the caller graph for this function:

getID

(

)

Get the ID of this study area.

Here is the caller graph for this function:

getInfo

(

)

Get the comment of this study area.

getModuleDescription

(

$semester_id = ''

)

returns the modul description if this study area is a module and if there is a compatible plugin available

Parameters

string

$semester_id

Returns

string

Here is the call graph for this function:

getModuleInfoHTML

(

$semester_id = ''

)

returns a HTML snippet for the info icon if this study area is a module and if there is a compatible plugin available

Parameters

string

$semester_id

Returns

string

Here is the call graph for this function:

getName

(

)

Get the display name of this study area.

getParent

(

)

Get the parent.

Here is the call graph for this function:

getParentId

(

)

Get the parent ID of this study area.

getPath

(

$separator = NULL

)

Get the path along the sem_tree to this study area.

Parameters

string

optional; TODO

Returns

mixed TODO

Here is the call graph for this function:

getPriority

(

)

Get the priority of this study area.

static getRootArea ( )

static

Returns the not really existing root study area.

Returns

object the root study area object

Here is the caller graph for this function:

getStudipObjectId

(

)

Get the studip_object_id of this study area.

static getStudyAreasForCourse (   $id )

static

Get an associative array of all study areas of a course. The array contains StudipStudyArea instances and its keys correspond to the ID of each entry.

Parameters

id	the course's ID

Returns

array an array of that courses study areas

Here is the call graph for this function:

getType

(

)

get the type of this study area.

Here is the caller graph for this function:

getTypeName

(

)

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

Returns

string

Here is the call graph for this function:

hasChildren

(

)

Returns TRUE if the area has children.

Here is the call graph for this function:

Here is the caller graph for this function:

isAssignable

(

)

Returns TRUE if this area can be select.

Here is the call graph for this function:

isEditable

(

)

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

Returns

bool

Here is the call graph for this function:

isModule

(

)

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

Returns

bool

Here is the call graph for this function:

Here is the caller graph for this function:

isRoot

(

)

Returns TRUE if this area is the root.

Here is the caller graph for this function:

restore

(

$fields

)

Here is the call graph for this function:

static search (   $searchTerm )

static

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

Parameters

string

the seach term

Returns

type

Here is the call graph for this function:

Here is the caller graph for this function:

setID

(

$id

)

Set the ID of this study area.

setInfo

(

$info

)

Set the comment of this study area.

Here is the caller graph for this function:

setName

(

$name

)

Set the display name of this study area.

Here is the caller graph for this function:

setParentId

(

$parent_id

)

Set the parent of this study area.

Here is the caller graph for this function:

setPriority

(

$priority

)

Set the priority of this study area.

Here is the caller graph for this function:

setStudipObjectId

(

$id

)

Set the studip_object_id of this study area.

Here is the caller graph for this function:

setType

(

$type

)

set the type of this study area.

Here is the caller graph for this function:

store

(

)

Store changes to the study area to the database.

Here is the call graph for this function:

Field Documentation

const ROOT = 'root'

This constant represents the key of the root area.

---

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

• lib/classes/StudipStudyArea.class.php