Inheritance diagram for ilStudyProgrammeProgress:

Collaboration diagram for ilStudyProgrammeProgress:

Public Member Functions
	getAssignmentId ()
	Get the assignment, this progress belongs to. More...

	getNodeId ()
	Get the id of the program node this progress belongs to. More...

	getUserId ()
	Get the id of the user this progress is for. More...

	getAmountOfPoints ()
	Get the amount of points the user needs to achieve on the subnodes of this node. More...

	setAmountOfPoints ($a_points)
	Get the amount of points the user needs to achieve on the subnodes of this node. More...

	getCurrentAmountOfPoints ()
	Get the amount of points the user currently has achieved on the node. More...

	setCurrentAmountOfPoints ($a_points)
	Set the amount of points the user currently has achieved on this node. More...

	getStatus ()
	Get the status the user has on this node. More...

	setStatus ($a_status)
	Set the status of this node. More...

	setCompletionBy ($a_id)
	Set the completion_by field. More...

	getCompletionBy ()
	Get the id of object or user that lead to the successful completion of this node. More...

	getLastChangeBy ()
	Get the id of the user who did the last change on this assignment. More...

	setLastChangeBy ($a_usr_id)
	Set the id of the user who did the last change on this progress. More...

	getLastChange ()
	Get the timestamp of the last change on this progress. More...

	updateLastChange ()
	Update the last change timestamp to the current time. More...

	setLastChange (ilDateTime $a_timestamp)
	Set the last change timestamp to the given time. More...

	getDeadline ()
	Get the deadline of this progress. More...

	setDeadline (ilDateTime $deadline=null)
	Set the deadline of this progress. More...

Public Member Functions inherited from ActiveRecord
	getArConnector ()

	getArFieldList ()

	getConnectorContainerName ()

	setConnectorContainerName ($connector_container_name)

	getPrimaryFieldValue ()

	setPrimaryFieldValue ($value)

	__construct ($primary_key=0, arConnector $connector=null)

	storeObjectToCache ()

	__getConvertedDateFieldsAsArray ($format=null)

	__asCsv ($separator=';', $header=false)

	__asArray ()

	__asStdClass ()

	__asSerializedObject ()

	buildFromArray (array $array)

	fixDateField ($field_name, $value)

	sleep ($field_name)

	wakeUp ($field_name, $field_value)

	getArrayForDb ()

	getArrayForConnector ()

	installConnector ()

	store ()

	save ()

	create ()

	copy ($new_id=0)

	afterObjectLoad ()

	read ()

	update ()

	delete ()

	__call ($name, $arguments)

Static Public Member Functions
static	returnDbTableName ()

static	createFor (ilStudyProgramme $a_prg, ilStudyProgrammeAssignment $a_ass)
	Create a new progress object for a given program node and assignment. More...

Static Public Member Functions inherited from ActiveRecord
static	returnDbTableName ()

static	installDB ()

static	renameDBField ($old_name, $new_name)

static	tableExists ()

static	fieldExists ($field_name)

static	removeDBField ($field_name)

static	updateDB ()

static	resetDB ()

static	truncateDB ()

static	flushDB ()

static	preloadObjects ()

static	additionalParams (array $additional_params)

static	findOrFail ($primary_key, array $add_constructor_args=array())
	Tries to find the object and throws an Exception if object is not found, instead of returning null. More...

static	findOrGetInstance ($primary_key, array $add_constructor_args=array())

static	where ($where, $operator=null)

static	innerjoinAR (ActiveRecord $ar, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)

static	innerjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)

static	leftjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)

static	orderBy ($orderBy, $orderDirection='ASC')

static	dateFormat ($date_format='d.m.Y - H:i:s')

static	limit ($start, $end)

static	affectedRows ()

static	count ()

static	get ()

static	debug ()

static	first ()

static	getCollection ()

static	last ()

static	getFirstFromLastQuery ()

static	connector (arConnector $connector)

static	raw ($set_raw=true)

static	getArray ($key=null, $values=null)

static	_toCamelCase ($str, $capitalise_first_char=false)

Data Fields
const	STATUS_IN_PROGRESS = 1

const	STATUS_COMPLETED = 2

const	STATUS_ACCREDITED = 3

const	STATUS_NOT_RELEVANT = 4

const	STATUS_FAILED = 5

Data Fields inherited from ActiveRecord
const	ACTIVE_RECORD_VERSION = '2.0.7'

Static Public Attributes
static	$STATUS

Protected Member Functions
	setAssignmentId ($a_id)

	setNodeId ($a_id)

	setUserId ($a_id)

Protected Member Functions inherited from ActiveRecord
	serializeToCSV ($field)
	This method is called for every field of your instance if you use __asCsv. More...

	installDatabase ()

Protected Attributes
	$id

	$assignment_id

	$prg_id

	$usr_id

	$points

	$points_cur

	$status

	$completion_by

	$last_change

	$last_change_by

	$deadline

Protected Attributes inherited from ActiveRecord
	$ar_safe_read = true

	$connector_container_name = ''

Additional Inherited Members
Static Protected Member Functions inherited from ActiveRecord
static	getCalledClass ()

static	fromCamelCase ($str)

Detailed Description

Class ilStudyProgrammeProgress.

Represents the progress of a user for one program assignment on one node of the program.

The user has one progress per assignment and program node in the subtree of the assigned program.

Author: : Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Version: : 0.1.0

Definition at line 20 of file class.ilStudyProgrammeProgress.php.

Member Function Documentation

◆ createFor()

static ilStudyProgrammeProgress::createFor	(	ilStudyProgramme	$a_prg,
		ilStudyProgrammeAssignment	$a_ass
	)

static

Create a new progress object for a given program node and assignment.

Parameters

$a_assigning_user int

Returns: ilStudyProgrammeProgress

Definition at line 206 of file class.ilStudyProgrammeProgress.php.

References ilStudyProgrammeAssignment\getId(), ilStudyProgramme\getObjId(), ilStudyProgramme\getPoints(), ilStudyProgrammeAssignment\getUserId(), setCurrentAmountOfPoints(), setNodeId(), setStatus(), setUserId(), and STATUS_IN_PROGRESS.

Referenced by ilStudyProgrammeUserAssignment\addMissingProgresses(), and ilObjStudyProgramme\createProgressForAssignment().

     {
         $prg = new ilStudyProgrammeProgress();
         $prg->setAssignmentId($a_ass->getId())
             ->setNodeId($a_prg->getObjId())
             ->setUserId($a_ass->getUserId())
             ->setStatus(ilStudyProgrammeProgress::STATUS_IN_PROGRESS)
             ->setAmountOfPoints($a_prg->getPoints())
             ->setCurrentAmountOfPoints(0)
             ->setCompletionBy(null)
             ->setLastChangeBy(null)
             ->updateLastChange()
             ->create();
         return $prg;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAmountOfPoints()

ilStudyProgrammeProgress::getAmountOfPoints ( )

Get the amount of points the user needs to achieve on the subnodes of this node.

Also the amount of points, this node yields for the progress on the nodes above.

Returns: int

Definition at line 277 of file class.ilStudyProgrammeProgress.php.

References $points.

     {
         return $this->points;
     }

◆ getAssignmentId()

ilStudyProgrammeProgress::getAssignmentId ( )

Get the assignment, this progress belongs to.

Returns: ilStudyProgrammeAssignment.

Definition at line 227 of file class.ilStudyProgrammeProgress.php.

References $assignment_id.

     {
         return $this->assignment_id;
     }

◆ getCompletionBy()

ilStudyProgrammeProgress::getCompletionBy ( )

Get the id of object or user that lead to the successful completion of this node.

Returns: int

Definition at line 390 of file class.ilStudyProgrammeProgress.php.

References $completion_by.

     {
         return $this->completion_by;
     }

◆ getCurrentAmountOfPoints()

ilStudyProgrammeProgress::getCurrentAmountOfPoints ( )

Get the amount of points the user currently has achieved on the node.

Returns: int

Definition at line 310 of file class.ilStudyProgrammeProgress.php.

References $points_cur.

     {
         return $this->points_cur;
     }

◆ getDeadline()

ilStudyProgrammeProgress::getDeadline ( )

Get the deadline of this progress.

Returns: ilDateTime

Definition at line 474 of file class.ilStudyProgrammeProgress.php.

References $deadline, and IL_CAL_DATE.

     {
         if ($this->deadline !== null) {
             return new ilDateTime($this->deadline, IL_CAL_DATE);
         }
         return $this->deadline;
     }

◆ getLastChange()

ilStudyProgrammeProgress::getLastChange ( )

Get the timestamp of the last change on this progress.

Returns: ilDateTime

Definition at line 427 of file class.ilStudyProgrammeProgress.php.

References IL_CAL_DATETIME.

Referenced by setLastChange().

     {
         return new ilDateTime($this->last_change, IL_CAL_DATETIME);
     }

Here is the caller graph for this function:

◆ getLastChangeBy()

ilStudyProgrammeProgress::getLastChangeBy ( )

Get the id of the user who did the last change on this assignment.

Returns: int

Definition at line 399 of file class.ilStudyProgrammeProgress.php.

References $last_change_by.

     {
         return $this->last_change_by;
     }

◆ getNodeId()

ilStudyProgrammeProgress::getNodeId ( )

Get the id of the program node this progress belongs to.

Returns: int

Definition at line 243 of file class.ilStudyProgrammeProgress.php.

References $prg_id.

     {
         return $this->prg_id;
     }

◆ getStatus()

ilStudyProgrammeProgress::getStatus ( )

Get the status the user has on this node.

Returns: int - one of ilStudyProgramme::STATUS_*

Definition at line 340 of file class.ilStudyProgrammeProgress.php.

References $status.

     {
         return $this->status;
     }

◆ getUserId()

ilStudyProgrammeProgress::getUserId ( )

Get the id of the user this progress is for.

Returns: int

Definition at line 259 of file class.ilStudyProgrammeProgress.php.

References $usr_id.

     {
         return $this->usr_id;
     }

◆ returnDbTableName()

static ilStudyProgrammeProgress::returnDbTableName ( )

static

Returns: string

Definition at line 50 of file class.ilStudyProgrammeProgress.php.

Referenced by ilStudyProgrammeMembersTableGUI\getFrom().

     {
         return "prg_usr_progress";
     }

Here is the caller graph for this function:

◆ setAmountOfPoints()

ilStudyProgrammeProgress::setAmountOfPoints ( $a_points )

Get the amount of points the user needs to achieve on the subnodes of this node.

Also the amount of points, this node yields for the progress on the nodes above.

Throws when amount of points is smaller then zero.

Exceptions

ilException

Returns: $this

Definition at line 292 of file class.ilStudyProgrammeProgress.php.

References updateLastChange().

     {
         if (!is_numeric($a_points) || $a_points < 0) {
             throw new ilException("ilStudyProgrammeProgress::setAmountOfPoints: "
                                  . "Expected a number >= 0 as argument, got '$a_points'");
         }
         
         $this->points = (int) $a_points;
 
         $this->updateLastChange();
         return $this;
     }

Here is the call graph for this function:

◆ setAssignmentId()

ilStudyProgrammeProgress::setAssignmentId ( $a_id )

protected

Definition at line 232 of file class.ilStudyProgrammeProgress.php.

     {
         $this->assignment_id = $a_id;
         return $this;
     }

◆ setCompletionBy()

ilStudyProgrammeProgress::setCompletionBy ( $a_id )

Set the completion_by field.

Parameters

$a_id int | null

Returns: $this

Definition at line 374 of file class.ilStudyProgrammeProgress.php.

References updateLastChange().

     {
         if ($a_id !== null) {
             $a_id = (int) $a_id;
         }
         $this->completion_by = $a_id;
         $this->updateLastChange();
         return $this;
     }

Here is the call graph for this function:

◆ setCurrentAmountOfPoints()

ilStudyProgrammeProgress::setCurrentAmountOfPoints ( $a_points )

Set the amount of points the user currently has achieved on this node.

Throw when amount of points is smaller then zero.

Exceptions

ilException

Returns: $this

Definition at line 323 of file class.ilStudyProgrammeProgress.php.

References updateLastChange().

Referenced by createFor().

     {
         if (!is_numeric($a_points) || $a_points < 0) {
             throw new ilException("ilStudyProgrammeProgress::setCurrentAmountOfPoints: "
                                  . "Expected a number >= 0 as argument, got '$a_points'.");
         }
         
         $this->points_cur = (int) $a_points;
         $this->updateLastChange();
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDeadline()

ilStudyProgrammeProgress::setDeadline ( ilDateTime $deadline = null )

Set the deadline of this progress.

Parameters

ilDateTime | null $deadline

Returns: $this

Definition at line 489 of file class.ilStudyProgrammeProgress.php.

References $deadline, and IL_CAL_DATE.

     {
         if ($deadline === null) {
             $this->deadline = $deadline;
         } else {
             $this->deadline = $deadline->get(IL_CAL_DATE);
         }
 
         return $this;
     }

◆ setLastChange()

ilStudyProgrammeProgress::setLastChange ( ilDateTime $a_timestamp )

Set the last change timestamp to the given time.

Throws when given time is smaller then current timestamp since that is logically impossible.

Exceptions

ilException

Returns: $this

Definition at line 457 of file class.ilStudyProgrammeProgress.php.

References ilDateTime\_before(), ilDateTime\get(), getLastChange(), and IL_CAL_DATETIME.

Referenced by updateLastChange().

     {
         if (ilDateTime::_before($a_timestamp, $this->getLastChange())) {
             throw new ilException("ilStudyProgrammeProgress::setLastChange: Given "
                                  . "timestamp is before current timestamp. That "
                                  . "is logically impossible.");
         }
         
         $this->last_change = $a_timestamp->get(IL_CAL_DATETIME);
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLastChangeBy()

ilStudyProgrammeProgress::setLastChangeBy ( $a_usr_id )

Set the id of the user who did the last change on this progress.

Throws when $a_usr_id is not the id of a user.

Exceptions

ilException

Returns: $this

Definition at line 412 of file class.ilStudyProgrammeProgress.php.

References ilObject\_lookupType().

     {
         if ($a_usr_id !== null && ilObject::_lookupType($a_usr_id) != "usr") {
             throw new ilException("ilStudyProgrammeProgress::setLastChangeBy: '$a_usr_id' "
                                  . "is no id of a user.");
         }
         $this->last_change_by = $a_usr_id;
         return $this;
     }

Here is the call graph for this function:

◆ setNodeId()

ilStudyProgrammeProgress::setNodeId ( $a_id )

protected

Definition at line 248 of file class.ilStudyProgrammeProgress.php.

Referenced by createFor().

     {
         $this->prg_id = $a_id;
         return $this;
     }

Here is the caller graph for this function:

◆ setStatus()

ilStudyProgrammeProgress::setStatus ( $a_status )

Set the status of this node.

Throws when status is none of ilStudyProgramme::STATUS_*. Throws when current status is STATUS_COMPLETED.

Exceptions

ilException

Parameters

$a_status int - one of ilStudyProgramme::STATUS_*

Returns: $this

Definition at line 355 of file class.ilStudyProgrammeProgress.php.

References updateLastChange().

Referenced by createFor().

     {
         $a_status = (int) $a_status;
         if (!in_array($a_status, self::$STATUS)) {
             throw new ilException("ilStudyProgrammeProgress::setStatus: No status: "
                                  . "'$a_status'");
         }
 
         $this->status = $a_status;
         $this->updateLastChange();
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setUserId()

ilStudyProgrammeProgress::setUserId ( $a_id )

protected

Definition at line 264 of file class.ilStudyProgrammeProgress.php.

Referenced by createFor().

     {
         $this->usr_id = $a_id;
         return $this;
     }

Here is the caller graph for this function:

◆ updateLastChange()

ilStudyProgrammeProgress::updateLastChange ( )

Update the last change timestamp to the current time.

TODO: I'm not quite sure how the semantics of the last change field should be. Should this record every change or only changes done by a user manually. The answer to this question will also tell whether this method should be called in other setters or not.

Returns: $this

Definition at line 442 of file class.ilStudyProgrammeProgress.php.

References IL_CAL_DATETIME, ilUtil\now(), and setLastChange().

Referenced by setAmountOfPoints(), setCompletionBy(), setCurrentAmountOfPoints(), and setStatus().

     {
         $this->setLastChange(new ilDateTime(ilUtil::now(), IL_CAL_DATETIME));
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $assignment_id

ilStudyProgrammeProgress::$assignment_id

protected

Definition at line 85 of file class.ilStudyProgrammeProgress.php.

Referenced by getAssignmentId().

◆ $completion_by

ilStudyProgrammeProgress::$completion_by

protected

Definition at line 162 of file class.ilStudyProgrammeProgress.php.

Referenced by getCompletionBy().

◆ $deadline

ilStudyProgrammeProgress::$deadline

protected

Definition at line 198 of file class.ilStudyProgrammeProgress.php.

Referenced by getDeadline(), and setDeadline().

◆ $id

ilStudyProgrammeProgress::$id

protected

Definition at line 73 of file class.ilStudyProgrammeProgress.php.

◆ $last_change

ilStudyProgrammeProgress::$last_change

protected

Definition at line 175 of file class.ilStudyProgrammeProgress.php.

◆ $last_change_by

ilStudyProgrammeProgress::$last_change_by

protected

Definition at line 187 of file class.ilStudyProgrammeProgress.php.

Referenced by getLastChangeBy().

◆ $points

ilStudyProgrammeProgress::$points

protected

Definition at line 123 of file class.ilStudyProgrammeProgress.php.

Referenced by getAmountOfPoints().

◆ $points_cur

ilStudyProgrammeProgress::$points_cur

protected

Definition at line 135 of file class.ilStudyProgrammeProgress.php.

Referenced by getCurrentAmountOfPoints().

◆ $prg_id

ilStudyProgrammeProgress::$prg_id

protected

Definition at line 97 of file class.ilStudyProgrammeProgress.php.

Referenced by getNodeId().

◆ $STATUS

ilStudyProgrammeProgress::$STATUS

static

Initial value:

= array( ilStudyProgrammeProgress::STATUS_IN_PROGRESS
                          , ilStudyProgrammeProgress::STATUS_COMPLETED
                          , ilStudyProgrammeProgress::STATUS_ACCREDITED
                          , ilStudyProgrammeProgress::STATUS_NOT_RELEVANT
                          , ilStudyProgrammeProgress::STATUS_FAILED
                          )

Definition at line 40 of file class.ilStudyProgrammeProgress.php.

◆ $status

ilStudyProgrammeProgress::$status

protected

Definition at line 147 of file class.ilStudyProgrammeProgress.php.

Referenced by getStatus().

◆ $usr_id

ilStudyProgrammeProgress::$usr_id

protected

Definition at line 110 of file class.ilStudyProgrammeProgress.php.

Referenced by getUserId().

◆ STATUS_ACCREDITED

const ilStudyProgrammeProgress::STATUS_ACCREDITED = 3

Definition at line 34 of file class.ilStudyProgrammeProgress.php.

Referenced by ilObjStudyProgrammeAccess\checkCondition(), ilStudyProgrammeMembersTableGUI\fetchData(), ilStudyProgrammeIndividualPlanTableGUI\getManualStatusSelect(), ilStudyProgrammeUserProgress\getPossibleActions(), ilStudyProgrammeUserProgress\isAccredited(), ilStudyProgrammeUserProgress\isSuccessful(), ilStudyProgrammeUserProgress\markAccredited(), ilStudyProgrammeUserProgress\markFailed(), ilObjStudyProgrammeMembersGUI\markRelevantMulti(), ilStudyProgrammeUserProgressDB\statusToRepr(), ilStudyProgrammeUserProgressTest\testMarkAccredited(), ilStudyProgrammeUserProgressTest\testPossibleActions(), ilStudyProgrammeProgressCalculationTest\testProgress2(), ilStudyProgrammeUserProgress\unmarkAccredited(), ilObjStudyProgrammeMembersGUI\unmarkAccreditedMulti(), ilObjStudyProgrammeIndividualPlanGUI\updateStatus(), and ilStudyProgrammeUserProgress\updateStatus().

◆ STATUS_COMPLETED

const ilStudyProgrammeProgress::STATUS_COMPLETED = 2

Definition at line 31 of file class.ilStudyProgrammeProgress.php.

Referenced by ilObjStudyProgrammeAccess\checkCondition(), ilStudyProgrammeMembersTableGUI\fetchData(), ilStudyProgrammeIndividualPlanTableGUI\getManualStatusSelect(), ilStudyProgrammeUserProgress\isSuccessful(), ilStudyProgrammeUserProgress\markFailed(), ilStudyProgrammeUserProgress\setLPCompleted(), ilStudyProgrammeUserProgressDB\statusToRepr(), ilStudyProgrammeProgressCalculationTest\testInitialProgressOnOptionalNodes(), ilStudyProgrammeUserProgressTest\testMarkAccredited(), ilStudyProgrammeProgressCalculationTest\testProgress1(), ilStudyProgrammeProgressCalculationTest\testProgress2(), ilStudyProgrammeProgressCalculationTest\testProgress3(), ilStudyProgrammeProgressCalculationTest\testProgress4(), ilStudyProgrammeUserProgress\updateFromProgramNode(), and ilStudyProgrammeUserProgress\updateStatus().

◆ STATUS_FAILED

const ilStudyProgrammeProgress::STATUS_FAILED = 5

Definition at line 38 of file class.ilStudyProgrammeProgress.php.

Referenced by ilStudyProgrammeUserProgress\isFailed(), ilStudyProgrammeUserProgress\markFailed(), ilStudyProgrammeUserProgress\markNotFailed(), ilStudyProgrammeUserProgress\recalculateFailedToDeadline(), ilStudyProgrammeUserProgressDB\statusToRepr(), ilStudyProgrammeUserProgressTest\testMarkFailed(), ilStudyProgrammeUserProgressTest\testMarkNotFailed(), and ilObjStudyProgrammeIndividualPlanGUI\updateStatus().

◆ STATUS_IN_PROGRESS

const ilStudyProgrammeProgress::STATUS_IN_PROGRESS = 1

Definition at line 28 of file class.ilStudyProgrammeProgress.php.

◆ STATUS_NOT_RELEVANT

const ilStudyProgrammeProgress::STATUS_NOT_RELEVANT = 4

Definition at line 36 of file class.ilStudyProgrammeProgress.php.

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

Modules/StudyProgramme/classes/model/class.ilStudyProgrammeProgress.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ createFor()

◆ getAmountOfPoints()

◆ getAssignmentId()

◆ getCompletionBy()

◆ getCurrentAmountOfPoints()

◆ getDeadline()

◆ getLastChange()

◆ getLastChangeBy()

◆ getNodeId()

◆ getStatus()

◆ getUserId()

◆ returnDbTableName()

◆ setAmountOfPoints()

◆ setAssignmentId()

◆ setCompletionBy()

◆ setCurrentAmountOfPoints()

◆ setDeadline()

◆ setLastChange()

◆ setLastChangeBy()

◆ setNodeId()

◆ setStatus()

◆ setUserId()

◆ updateLastChange()

Field Documentation

◆ $assignment_id

◆ $completion_by

◆ $deadline

◆ $id

◆ $last_change

◆ $last_change_by

◆ $points

◆ $points_cur

◆ $prg_id

◆ $STATUS

◆ $status

◆ $usr_id

◆ STATUS_ACCREDITED

◆ STATUS_COMPLETED

◆ STATUS_FAILED

◆ STATUS_IN_PROGRESS

◆ STATUS_NOT_RELEVANT