Evaluation Class Reference

Inheritance diagram for Evaluation:

Public Member Functions
	__construct ($objectID="", $parentObject=null, $loadChildren=EVAL_LOAD_NO_CHILDREN)
	setStartdate ($startdate)
	getStartdate ()
	setStopdate ($stopdate)
	getStopdate ()
	getRealStopdate ()
	setTimespan ($timespan)
	getTimespan ()
	getCreationdate ()
	getChangedate ()
	setAnonymous ($anonymous)
	isAnonymous ()
	setVisible ($visible)
	isVisible ()
	setShared ($shared)
	isShared ()
	isTemplate ()
	hasVoted ($userID="")
	removeRangeID ($rangeID)
	removeRangeIDs ()
	addRangeID ($rangeID)
	getRangeID ()
	getNextRangeID ()
	getRangeIDs ()
	getNumberRanges ()
	resetAnswers ()
	setCreationdate ($creationdate)
	setChangedate ($changedate)
	check ()
Public Member Functions inherited from EvaluationObject
	__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)

Static Public Member Functions
static	exportUserData (StoredUserData $storage)
Static Public Member Functions inherited from StudipObject
static	createNewID ()

Data Fields
	$startdate
	$stopdate
	$timespan
	$mkdate
	$chdate
	$anonymous
	$visible
	$shared
	$numberRanges
	$rangeNum
Data Fields inherited from EvaluationObject
	$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

Constructor & Destructor Documentation

__construct()

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

Constructor public

Parameters

string	$objectID	The ID of an existing evaluation
object	$parentObject	The parent object if exists
integer	$loadChildren	See const EVAL_LOAD_*_CHILDREN

Member Function Documentation

addRangeID()

addRangeID

(

$rangeID

)

Adds a rangeID public

Parameters

string

$rangeID

The rangeID

Exceptions

error

check()

check

(

)

Checks if object is in a valid state private

exportUserData()

static exportUserData ( StoredUserData  $storage )

static

Export available data of a given user into a storage object (an instance of the StoredUserData class) for that user.

Parameters

StoredUserData

$storage

object to store data into

Implements PrivacyObject.

getChangedate()

getChangedate

(

)

Gets the changedate public

Returns

integer The changedate

getCreationdate()

getCreationdate

(

)

Gets the creationdate public

Returns

integer The creationdate

getNextRangeID()

getNextRangeID

(

)

Gets the next rangeID public

Returns

string The rangeID

getNumberRanges()

getNumberRanges

(

)

Gets the number of ranges public

Returns

integer Number of ranges

getRangeID()

getRangeID

(

)

Gets the first rangeID and removes it public

Returns

string The first object

getRangeIDs()

getRangeIDs

(

)

Gets all the rangeIDs from the evaluation public

Returns

array An array full of rangeIDs

getRealStopdate()

getRealStopdate

(

)

Gets the real stop date as a UNIX-timestamp (e.g. startdate + timespan) public

Returns

integer The UNIX-timestamp with the real stopdate

getStartdate()

getStartdate

(

)

Gets the startdate public

Returns

integer The startdate

getStopdate()

getStopdate

(

)

Gets the stopdate public

Returns

string The stopdate

getTimespan()

getTimespan

(

)

Gets the timespan public

Returns

string The timespan

hasVoted()

hasVoted

(

$userID = ""

)

Has a user used this evaluation? public

Parameters

string

$userID

Optional an user id

Returns

string YES if a user used this evaluation

isAnonymous()

isAnonymous

(

)

Gets anonymous public

Returns

string The anonymous

isShared()

isShared

(

)

Is shared for a public search? public

Returns

boolen true if it is shared template

isTemplate()

isTemplate

(

)

Is this evaluation a template? public

Returns

boolen true if it is a template

isVisible()

isVisible

(

)

Gets visible public

Returns

string The visible

removeRangeID()

removeRangeID

(

$rangeID

)

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

Parameters

string

$rangeID

The range id

removeRangeIDs()

removeRangeIDs

(

)

Removes all rangeIDs public

resetAnswers()

resetAnswers

(

)

Resets all answers for this evaluation public

setAnonymous()

setAnonymous

(

$anonymous

)

Sets anonymous public

Parameters

string

$anonymous

The anonymous.

Exceptions

error

setChangedate()

setChangedate

(

$changedate

)

Sets the changedate private

Parameters

integer

$changedate

The changedate.

Exceptions

error

setCreationdate()

setCreationdate

(

$creationdate

)

Sets the creationdate private

Parameters

integer

$creationdate

The creationdate.

Exceptions

error

setShared()

setShared

(

$shared

)

Set shared for a public search public

Parameters

boolean

$shared

if true it is shared

setStartdate()

setStartdate

(

$startdate

)

Sets the startdate public

Parameters

integer

$startdate

The startdate.

Exceptions

error

setStopdate()

setStopdate

(

$stopdate

)

Sets the stopdate public

Parameters

integer

$stopdate

The stopdate.

Exceptions

error

setTimespan()

setTimespan

(

$timespan

)

Sets the timespan public

Parameters

string

$timespan

The timespan.

Exceptions

error

setVisible()

setVisible

(

$visible

)

Sets visible public

Parameters

string

$visible

The visible.

Exceptions

error

Field Documentation

$anonymous

boolean $anonymous

Defines wheter the evaluation is anonymous private

$chdate

integer $chdate

Time of last change. Is set automatically. private

$mkdate

integer $mkdate

Time of creation. Is set automatically. private

$numberRanges

integer $numberRanges

Counts the number of connected ranges private

$rangeNum

integer $rangeNum

Counts the number of connected ranges private

$shared

boolean $shared

Defines whether the evaluation template is shared private

$startdate

integer $startdate

Startdate private

$stopdate

integer $stopdate

Stopdate private

$timespan

integer $timespan

Timespan private

$visible

boolean $visible

Defines whether the evaluation is visible private

---

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

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