StudipStudyArea Class Reference

Inheritance diagram for StudipStudyArea:

Collaboration diagram for StudipStudyArea:

Public Member Functions
	__construct ($id=null)
	__toString ()
	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 ()
	isModule ()
	getModuleDescription ($semester_id='')
	getModuleInfoHTML ($semester_id='')
Public Member Functions inherited from SimpleORMap
	__construct ($id=null)
	__clone ()
	getRelationOptions ($relation)
	getTableMetadata ()
	hasAutoIncrementColumn ()
	setId ($id)
	getId ()
	getNewId ()
	toArray ($only_these_fields=null)
	toArrayRecursive ($only_these_fields=null)
	getValue ($field)
	getRelationValue ($relation, $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)
	setData ($data, $reset=false)
	haveData ()
	isNew ()
	isDeleted ()
	setNew ($is_new)
	getWhereQuery ()
	restore ()
	store ()
	triggerChdate ()
	delete ()
	isDirty ()
	isFieldDirty ($field)
	revertValue ($field)
	initRelation ($relation)
	resetRelation ($relation)

Static Public Member Functions
static	findByParent ($parent_id)
static	find ($id)
static	getStudyAreasForCourse ($id)
static	getRootArea ()
static	search ($searchTerm)
Static Public Member Functions inherited from SimpleORMap
static	expireTableScheme ()
static	find ($id)
static	exists ($id)
static	countBySql ($where=1, $params=array())
static	create ($data)
static	import ($data)
static	findBySQL ($where, $params=array())
static	findThru ($foreign_key_value, $options)
static	findEachBySQL ($callable, $where, $params=array())
static	findMany ($pks=array(), $order='', $order_params=array())
static	findEachMany ($callable, $pks=array(), $order='', $order_params=array())
static	findAndMapBySQL ($callable, $where, $params=array())
static	findAndMapMany ($callable, $pks=array(), $order='', $order_params=array())
static	deleteBySQL ($where, $params=array())
static	toObject ($id_or_object)
static	__callStatic ($name, $arguments)

Data Fields
const	ROOT = 'root'

Additional Inherited Members
Protected Member Functions inherited from SimpleORMap
	parseRelationOptions ($type, $name, $options)
	getTableScheme ()
	storeRelations ()
	deleteRelations ()
	initializeContent ()
	applyCallbacks ($type)
	registerCallback ($types, $cb)
	unregisterCallback ($types, $cb)
	cbAutoIncrementColumn ($type)
	cbAutoKeyCreation ()
Static Protected Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)
Protected Attributes inherited from SimpleORMap
	$content = array()
	$content_db = array()
	$is_new = true
	$db_table = ''
	$db_fields = null
	$pk = null
	$default_values = array()
	$alias_fields = array()
	$additional_fields = array()
	$relations = array()
	$has_many = array()
	$has_one = array()
	$belongs_to = array()
	$has_and_belongs_to_many = array()
	$registered_callbacks
	$known_slots = array()
	$reserved_slots = array('value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id')
Static Protected Attributes inherited from SimpleORMap
static	$schemes

Constructor & Destructor Documentation

__construct()

__construct

(

$id = null

)

Constructor.

Returns

void

Member Function Documentation

__toString()

__toString

(

)

Get a string representation of this study area.

find()

static find (   $id )

static

Returns the study area with the specified ID.

Here is the caller graph for this function:

findByParent()

static findByParent (   $parent_id )

static

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

getChildren()

getChildren

(

)

Returns the children of this study area.

getInfo()

getInfo

(

)

Get the comment of this study area.

getModuleDescription()

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

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

getName

(

)

Get the display name of this study area.

getParent()

getParent

(

)

Get the parent.

getParentId()

getParentId

(

)

Get the parent ID of this study area.

getPath()

getPath

(

$separator = NULL

)

Get the path along the sem_tree to this study area.

Parameters

string

optional; TODO

Returns

mixed TODO

getPriority()

getPriority

(

)

Get the priority of this study area.

getRootArea()

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

getStudipObjectId

(

)

Get the studip_object_id of this study area.

getStudyAreasForCourse()

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

Here is the call graph for this function:

Here is the caller graph for this function:

getType()

getType

(

)

get the type of this study area.

Here is the caller graph for this function:

getTypeName()

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

hasChildren

(

)

Returns1 TRUE if the area has children.

Here is the caller graph for this function:

isAssignable()

isAssignable

(

)

Returns TRUE if this area can be select.

Here is the call graph for this function:

isEditable()

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

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

isRoot

(

)

Returns TRUE if this area is the root.

Here is the call graph for this function:

Here is the caller graph for this function:

search()

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 caller graph for this function:

setInfo()

setInfo

(

$info

)

Set the comment of this study area.

setName()

setName

(

$name

)

Set the display name of this study area.

setParentId()

setParentId

(

$parent_id

)

Set the parent of this study area.

Here is the call graph for this function:

setPriority()

setPriority

(

$priority

)

Set the priority of this study area.

setStudipObjectId()

setStudipObjectId

(

$id

)

Set the studip_object_id of this study area.

Here is the call graph for this function:

setType()

setType

(

$type

)

set the type of this study area.

Field Documentation

ROOT

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