EvaluationObject Class Reference

Inheritance diagram for EvaluationObject:

Collaboration diagram for EvaluationObject:

Public Member Functions
	__construct ($objectID="", $parentObject=NULL, $loadChildren=EVAL_LOAD_NO_CHILDREN)
	setTitle ($title)
	getTitle ()
	setText ($text)
	getText ()
	setPosition ($position)
	getPosition ()
	setParentObject (&$parentObject)
	getParentObject ()
	getParentID ()
	setParentID ($parentID)
	removeChildID ($childID)
	addChild (&$child)
&	getChild ($childID="")
&	getNextChild ()
	getChildren ()
	getNumberChildren ()
	save ()
	delete ()
&	duplicate ()
	duplicate_init ()
	init ($objectID="")
	load ()
	check ()
	getSpecialChildobjects (&$object, $instanceof, $reset=false)
	toString ()
Public Member Functions inherited from StudipObject
	__construct ($objectID="")
	createNewID ()
	getObjectID ()
	setObjectID ($objectID)
	getAuthorID ()
	getAuthor ()
	getFullname ()
	setAuthorID ($authorID)
	getRangeID ()
	setRangeID ($rangeID)
Public Member Functions inherited from AuthorObject
	__construct ()
	finalize ()
	setAuthorEmail ($email)
	getAuthorEmail ()
	setAuthorName ($name)
	getAuthorName ()
	x_instanceof ()
	isError ()
	getErrors ()
	resetErrors ()
	throwError ($errcode, $errstring, $errline=0, $errfile=0, $errtype=ERROR_NORMAL)
	throwErrorFromClass (&$class)
	errorHandler ($no, $str, $file, $line, $ctx)

Data Fields
	$parentObject
	$parentObjectID
	$childObjects
	$numberChildren
	$title
	$text
	$position
	$db
	$childNum
	$loadChildren
Data Fields inherited from StudipObject
	$objectID
	$authorID
	$rangeID
Data Fields inherited from AuthorObject
	$errorArray
	$authorEmail
	$authorName
	$instanceof

Constructor & Destructor Documentation

__construct()

__construct	(		$objectID = "",
			$parentObject = NULL,
			$loadChildren = EVAL_LOAD_NO_CHILDREN
	)

Constructor

Parameters

string	$objectID	The ID of an existing object
EvaluationObject	$parentObject	The parent object
integer	$loadChildren	See const EVAL_LOAD_*_CHILDREN @access public

Reimplemented in Evaluation, EvaluationAnswer, EvaluationGroup, and EvaluationQuestion.

Here is the call graph for this function:

Member Function Documentation

addChild()

addChild

(

&

$child

)

Adds a child @access public

Parameters

object

EvaluationObject &$child The child object

Reimplemented in EvaluationGroup, and EvaluationQuestion.

check()

check

(

)

Checks if object is in a valid state @access private

Reimplemented in Evaluation, and EvaluationAnswer.

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

delete

(

)

Deletes the object from the database @access public

Here is the call graph for this function:

duplicate()

& duplicate

(

)

Duplicates the evaluation object. WARNING: Stored childs will be modified :( @access public

duplicate_init()

duplicate_init

(

)

Initialisation for duplicated objects @access private

Here is the call graph for this function:

getChild()

& getChild

(

$childID = ""

)

Gets the first child and removes it (if no id is given) @access public

Parameters

string

$childID

The child id

Returns

object The first object

Here is the call graph for this function:

Here is the caller graph for this function:

getChildren()

getChildren

(

)

Gets all the childs in the object @access public

Returns

array An array full of childObjects

getNextChild()

& getNextChild

(

)

Gets the next child @access public

Returns

object The next object, otherwise NULL

Here is the caller graph for this function:

getNumberChildren()

getNumberChildren

(

)

Gets the number of children @access public

Returns

integer Number of children

getParentID()

getParentID

(

)

Gets the parentObjectID @access public

Returns

string The parentObjectID

getParentObject()

getParentObject

(

)

Gets the parentObject @access public

Returns

object The parentObject.

getPosition()

getPosition

(

)

Gets the position @access public

Returns

string The position

getSpecialChildobjects()

getSpecialChildobjects	(	&	$object,
			$instanceof,
			$reset = false
	)

Gets all children of a special kind

Parameters

EvaluationObject	&$object	the parent object
string	$instanceof	instance of the searched child
boolean	$reset	for internal use @access public

Here is the call graph for this function:

Here is the caller graph for this function:

getText()

getText

(

)

Gets the text @access public

Returns

string The text

getTitle()

getTitle

(

)

Gets the title @access public

Returns

string The title

init()

init

(

$objectID = ""

)

Initialisation for objects @access private

Parameters

string

$objectID

The object id

Here is the call graph for this function:

Here is the caller graph for this function:

load()

load

(

)

Loads the Object from the database @access private

Here is the call graph for this function:

Here is the caller graph for this function:

removeChildID()

removeChildID

(

$childID

)

Removes a child from the object (not from the DB!) @access public

Parameters

string

$childID

The child id

Here is the call graph for this function:

save()

save

(

)

Saves the object into the database @access public

Here is the call graph for this function:

setParentID()

setParentID

(

$parentID

)

Sets the parentObjectID @access public

Parameters

string

$parentID

The parent id

setParentObject()

setParentObject

(

&

$parentObject

)

Sets the parentObject @access public

Parameters

string

&$parentObject

The parentObject.

setPosition()

setPosition

(

$position

)

Sets the position @access public

Parameters

string

$position

The position.

setText()

setText

(

$text

)

Sets the text @access public

Parameters

string

$text

The text.

Exceptions

error

setTitle()

setTitle

(

$title

)

Sets the title @access public

Parameters

string

$title

The title.

Exceptions

error

toString()

toString

(

)

Debugfunction @access public

Reimplemented in EvaluationAnswer.

Here is the call graph for this function:

Field Documentation

$childNum

integer $childNum

Is used as a counter for getNextChild ) @access private

$childObjects

array $childObjects

Array with all linked childobjects @access private

$db

object DatabaseObject $db

Holds the DB object @access private

$loadChildren

integer $loadChildren

Defines how many children to load. See EVAL_LOAD_*_CHILDREN @access private

$numberChildren

integer $numberChildren

Counts the number of childs @access private

$parentObject

string $parentObject

The parent object @access private

$parentObjectID

$parentObjectID

$position

integer $position

Position of this group in parent object @access private

$text

integer $text

Text of the group @access private

$title

integer $title

Title of the group @access private

---

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

• lib/evaluation/classes/EvaluationObject.class.php