Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
Evaluation Class Reference
Inheritance diagram for Evaluation:
EvaluationObject PrivacyObject StudipObject AuthorObject

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 (   $objectID = "",
  $parentObject = null,
  $loadChildren = EVAL_LOAD_NO_CHILDREN 
)

Constructor public

Parameters
string$objectIDThe ID of an existing evaluation
object$parentObjectThe parent object if exists
integer$loadChildrenSee const EVAL_LOAD_*_CHILDREN

Member Function Documentation

addRangeID (   $rangeID)

Adds a rangeID public

Parameters
string$rangeIDThe rangeID
Exceptions
error
check ( )

Checks if object is in a valid state private

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$storageobject to store data into

Implements PrivacyObject.

getChangedate ( )

Gets the changedate public

Returns
integer The changedate
getCreationdate ( )

Gets the creationdate public

Returns
integer The creationdate
getNextRangeID ( )

Gets the next rangeID public

Returns
string The rangeID
getNumberRanges ( )

Gets the number of ranges public

Returns
integer Number of ranges
getRangeID ( )

Gets the first rangeID and removes it public

Returns
string The first object
getRangeIDs ( )

Gets all the rangeIDs from the evaluation public

Returns
array An array full of rangeIDs
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 ( )

Gets the startdate public

Returns
integer The startdate
getStopdate ( )

Gets the stopdate public

Returns
string The stopdate
getTimespan ( )

Gets the timespan public

Returns
string The timespan
hasVoted (   $userID = "")

Has a user used this evaluation? public

Parameters
string$userIDOptional an user id
Returns
string YES if a user used this evaluation
isAnonymous ( )

Gets anonymous public

Returns
string The anonymous
isShared ( )

Is shared for a public search? public

Returns
boolen true if it is shared template
isTemplate ( )

Is this evaluation a template? public

Returns
boolen true if it is a template
isVisible ( )

Gets visible public

Returns
string The visible
removeRangeID (   $rangeID)

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

Parameters
string$rangeIDThe range id
removeRangeIDs ( )

Removes all rangeIDs public

resetAnswers ( )

Resets all answers for this evaluation public

setAnonymous (   $anonymous)

Sets anonymous public

Parameters
string$anonymousThe anonymous.
Exceptions
error
setChangedate (   $changedate)

Sets the changedate private

Parameters
integer$changedateThe changedate.
Exceptions
error
setCreationdate (   $creationdate)

Sets the creationdate private

Parameters
integer$creationdateThe creationdate.
Exceptions
error
setShared (   $shared)

Set shared for a public search public

Parameters
boolean$sharedif true it is shared
setStartdate (   $startdate)

Sets the startdate public

Parameters
integer$startdateThe startdate.
Exceptions
error
setStopdate (   $stopdate)

Sets the stopdate public

Parameters
integer$stopdateThe stopdate.
Exceptions
error
setTimespan (   $timespan)

Sets the timespan public

Parameters
string$timespanThe timespan.
Exceptions
error
setVisible (   $visible)

Sets visible public

Parameters
string$visibleThe visible.
Exceptions
error

Field Documentation

boolean $anonymous

Defines wheter the evaluation is anonymous private

integer $chdate

Time of last change. Is set automatically. private

integer $mkdate

Time of creation. Is set automatically. private

integer $numberRanges

Counts the number of connected ranges private

integer $rangeNum

Counts the number of connected ranges private

boolean $shared

Defines whether the evaluation template is shared private

integer $startdate

Startdate private

integer $stopdate

Stopdate private

integer $timespan

Timespan private

boolean $visible

Defines whether the evaluation is visible private


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