Inheritance diagram for StudipStudyArea:

Public Member Functions
	__toString ()

	getInfo ()

	setInfo ($info)

	getName ()

	setName ($name)

	getParentId ()

	getParent ()

	setParentId ($parent_id)

	getType ()

	setType ($type)

	getTypeName ()

	isEditable ()

	isHidden ()

	getPath ($separator=NULL)

	getPriority ()

	setPriority ($priority)

	getStudipObjectId ()

	setStudipObjectId ($id)

	getChildren ()

	hasChildren ()

	isRoot ()

	isAssignable ()

	isModule ()

Public Member Functions inherited from SimpleORMap
	__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)

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

Static Public Member Functions
static	findByParent ($parent_id)

static	find ($id)

static	getStudyAreasForCourse ($id)

static	getRootArea ()

static	search ($searchTerm)

static	backwards ($nodes)

Static Public Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)

static	expireTableScheme ()

static	exists ($id)

static	countBySql ($sql= '1', $params=[])

static	create ($data)

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 ($name, $arguments)

Data Fields
const	ROOT = 'root'

	$required_children = []

Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'

Static Protected Member Functions
static	configure ($config=[])

Static Protected Member Functions inherited from SimpleORMap
static	db_table ()

static	db_fields ()

static	pk ()

static	default_values ()

static	serialized_fields ()

static	alias_fields ()

static	i18n_fields ()

static	additional_fields ()

static	has_many ()

static	has_one ()

static	belongs_to ()

static	has_and_belongs_to_many ()

static	registered_callbacks ()

static	known_slots ()

static	notification_map ()

static	getter_setter_map ()

static	configure ($config=[])

static	config ($key)

static	registerCallback ($types, $cb)

static	unregisterCallback ($types, $cb)

Additional Inherited Members
Static Public Attributes inherited from SimpleORMap
static	$schemes = null

Protected Member Functions inherited from SimpleORMap
	_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)

Protected Attributes inherited from SimpleORMap
	$content = []

	$content_db = []

	$is_new = true

	$is_deleted = false

	$relations = []

	$additional_data = []

Static Protected Attributes inherited from SimpleORMap
static	$config = []

static	$reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']

static	$performs_batch_operation = false

Member Function Documentation

__toString ( )

Get a string representation of this study area.

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

static configure ( $config = [] )

staticprotected

static find ( $id )

static

Returns the study area with the specified ID.

static findByParent ( $parent_id )

static

Returns the children of the study area with the specified ID.

getChildren ( )

Returns the children of this study area.

getInfo ( )

Get the comment of this study area.

getName ( )

Get the display name of this study area.

getParent ( )

Get the parent.

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

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

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

Parameters

id	the course's ID

Returns: SimpleCollection a SimpleORMapCollection of that course's study areas

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

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.

static search ( $searchTerm )

static

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

Parameters

string the seach term

Returns: type

setInfo ( $info )

Set the comment of this study area.

setName ( $name )

Set the display name of this study area.

setParentId ( $parent_id )

Set the parent of this study area.

setPriority ( $priority )

Set the priority of this study area.

setStudipObjectId ( $id )

Set the studip_object_id of this study area.

setType ( $type )

set the type of this study area.

Field Documentation

$required_children = []

This is required, if the nodes are added backwards

const ROOT = 'root'

This constant represents the key of the root area.

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

lib/models/StudipStudyArea.class.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Protected Member Functions

Additional Inherited Members

Member Function Documentation

Field Documentation