Stud.IP  2.0 Revision 48548
 All Data Structures Namespaces Files Functions Variables Pages
Evaluation Class Reference
Inheritance diagram for Evaluation:
Inheritance graph
Collaboration diagram for Evaluation:
Collaboration graph

Public Member Functions

 Evaluation ($evalID="")
 setTitle ($title)
 getTitle ()
 getEvalID ()
 getChildren ()
 Evaluation ($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
 EvaluationObject ($objectID="", $parentObject=NULL, $loadChildren=EVAL_LOAD_NO_CHILDREN)
 setTitle ($title, $encoded=false)
 getTitle ($escaped=false)
 setText ($text, $encoded=false)
 getText ($escaped=false)
 setPosition ($position)
 getPosition ()
 setParentObject (&$parentObject)
 getParentObject ()
 getParentID ()
 setParentID ($parentID)
 removeChildID ($childID)
 addChild (&$child)
getChild ($childID="")
getNextChild ()
 getNumberChildren ()
 save ()
 delete ()
duplicate ()
 duplicate_init ()
 init ($objectID="")
 load ()
 getSpecialChildobjects (&$object, $instanceof, $reset=false)
 toString ()
- Public Member Functions inherited from StudipObject
 StudipObject ($objectID="")
 createNewID ()
 getObjectID ()
 setObjectID ($objectID)
 getAuthorID ()
 getAuthor ()
 getFullname ()
 setAuthorID ($authorID)
 setRangeID ($rangeID)
- Public Member Functions inherited from AuthorObject
 AuthorObject ()
 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

 $evalID
 $authorID
 $rangeIDs
 $groupObjects
 $title
 $text
 $startdate
 $stopdate
 $timespan
 $mkdate
 $chdate
 $resultvisibility
 $inUse
 $visible
 $evalDB
 $anonymous
 $shared
 $numberRanges
- 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
 $authorEmail
 $authorName
 $instanceof

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

Reimplemented from EvaluationObject.

Here is the call graph for this function:

Evaluation (   $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

Here is the call graph for this function:

Evaluation (   $evalID = "")

Constructor public

Parameters
string$evalIDThe ID of an existing evaluation
getChangedate ( )

Gets the changedate public

Returns
integer The changedate
getChildren ( )

Gets all the groups in the evaluation public

Returns
array An array full of groupObjects

Reimplemented from EvaluationObject.

getCreationdate ( )

Gets the creationdate public

Returns
integer The creationdate
getEvalID ( )

Gets the evalID public

Returns
string The evalID
getNextRangeID ( )

Gets the next rangeID public

Returns
string The rangeID

Here is the caller graph for this function:

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

Reimplemented from StudipObject.

Here is the caller graph for this function:

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

Here is the call graph for this function:

getStartdate ( )

Gets the startdate public

Returns
integer The startdate

Here is the caller graph for this function:

getStopdate ( )

Gets the stopdate public

Returns
string The stopdate

Here is the caller graph for this function:

getTimespan ( )

Gets the timespan public

Returns
string The timespan

Here is the caller graph for this function:

getTitle ( )

Gets the title public

Returns
string The title of a vote
hasVoted (   $userID = "")

Has a user used this evaluation? public

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

Here is the call graph for this function:

Here is the caller graph for this function:

isAnonymous ( )

Gets anonymous public

Returns
string The anonymous
isShared ( )

Is shared for a public search? public

Returns
boolen true if it is shared template

Here is the caller graph for this function:

isTemplate ( )

Is this evaluation a template? public

Returns
boolen true if it is a template

Here is the caller graph for this function:

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

Here is the call graph for this function:

removeRangeIDs ( )

Removes all rangeIDs public

Here is the call graph for this function:

resetAnswers ( )

Resets all answers for this evaluation public

Here is the call graph for this function:

setAnonymous (   $anonymous)

Sets anonymous public

Parameters
string$anonymousThe anonymous.
Exceptions
error
setChangedate (   $changedate)
  umber);s ($filepointer, SEPERATOR);SEPERATOR);TOR);        $number .= 

($this->getPosition () + 1)."."; $this->exportHeader ($filepointer); _("Kann nicht in die Datei schreiben.")); * 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

Here is the call graph for this function:

setStartdate (   $startdate)

Sets the startdate public

Parameters
integer$startdateThe startdate.
Exceptions
error

Here is the call graph for this function:

setStopdate (   $stopdate)

Sets the stopdate public

Parameters
integer$stopdateThe stopdate.
Exceptions
error

Here is the call graph for this function:

setTimespan (   $timespan)

Sets the timespan public

Parameters
string$timespanThe timespan.
Exceptions
error
setTitle (   $title)

Sets the title public

Parameters
string$titleThe title.
Exceptions
error
setVisible (   $visible)

Sets visible public

Parameters
string$visibleThe visible.
Exceptions
error

Field Documentation

boolean $anonymous

Defines wheter the evaluation is anonymous private

string $authorID

The unique userID of the author of the evaluation private

integer $chdate

Time of last change. Is set automatically. private

object EvaluationDB $evalDB

Holds the EvaluationDB object public

integer $evalID

The unique ID of the evaluation private

array $groupObjects

The group objects of the evaluation private

boolean $inUse

Defines whether a user had already used this evaluation private

integer $mkdate

Time of creation. Is set automatically. private

integer $numberRanges

Counts the number of connected ranges private

array $rangeIDs

The unique range IDs of the evaluation private

integer $resultvisibility

Defines how to show the result. private

boolean $shared

Defines whether the evaluation template is shared private

integer $startdate

Startdate private

integer $stopdate

Stopdate private

string $text

An text for description. private

integer $timespan

Timespan private

string $title

The title of the evaluation. private

boolean $visible

Defines whether the evaluation is visible private


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