EvaluationObject Class Reference

Inheritance 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="")
	getObjectID ()
	setObjectID ($objectID)
	getAuthorID ()
	getAuthor ()
	getFullName ()
	setAuthorID ($authorID)
	getRangeID ()
	setRangeID ($rangeID)
Public Member Functions inherited from AuthorObject
	__construct ()
	x_instanceof ()
	isError ()
	getErrors ()
	resetErrors ()
	throwError ($errcode, $errstring)
	throwErrorFromClass (AuthorObject $class)

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
	$instanceof

Additional Inherited Members
Static Public Member Functions inherited from StudipObject
static	createNewID ()

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 public

Member Function Documentation

addChild()

addChild

(

&

$child

)

Adds a child public

Parameters

object

EvaluationObject &$child The child object

check()

check

(

)

Checks if object is in a valid state private

delete()

delete

(

)

Deletes the object from the database public

duplicate()

& duplicate

(

)

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

duplicate_init()

duplicate_init

(

)

Initialisation for duplicated objects private

getChild()

& getChild

(

$childID = ""

)

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

Parameters

string

$childID

The child id

Returns

object The first object

getChildren()

getChildren

(

)

Gets all the childs in the object public

Returns

array An array full of childObjects

getNextChild()

& getNextChild

(

)

Gets the next child public

Returns

object The next object, otherwise NULL

getNumberChildren()

getNumberChildren

(

)

Gets the number of children public

Returns

integer Number of children

getParentID()

getParentID

(

)

Gets the parentObjectID public

Returns

string The parentObjectID

getParentObject()

getParentObject

(

)

Gets the parentObject public

Returns

object The parentObject.

getPosition()

getPosition

(

)

Gets the position 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 public

getText()

getText

(

)

Gets the text public

Returns

string The text

getTitle()

getTitle

(

)

Gets the title public

Returns

string The title

init()

init

(

$objectID = ""

)

Initialisation for objects private

Parameters

string

$objectID

The object id

load()

load

(

)

Loads the Object from the database private

removeChildID()

removeChildID

(

$childID

)

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

Parameters

string

$childID

The child id

save()

save

(

)

Saves the object into the database public

setParentID()

setParentID

(

$parentID

)

Sets the parentObjectID public

Parameters

string

$parentID

The parent id

setParentObject()

setParentObject

(

&

$parentObject

)

Sets the parentObject public

Parameters

string

&$parentObject

The parentObject.

setPosition()

setPosition

(

$position

)

Sets the position public

Parameters

string

$position

The position.

setText()

setText

(

$text

)

Sets the text public

Parameters

string

$text

The text.

Exceptions

error

setTitle()

setTitle

(

$title

)

Sets the title public

Parameters

string

$title

The title.

Exceptions

error

toString()

toString

(

)

Debugfunction public

Field Documentation

$childNum

integer $childNum

Is used as a counter for getNextChild ) private

$childObjects

array $childObjects

Array with all linked childobjects private

$db

object DatabaseObject $db

Holds the DB object private

$loadChildren

integer $loadChildren

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

$numberChildren

integer $numberChildren

Counts the number of childs private

$parentObject

string $parentObject

The parent object private

$parentObjectID

$parentObjectID

$position

integer $position

Position of this group in parent object private

$text

integer $text

Text of the group private

$title

integer $title

Title of the group private

---

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

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