ILIAS
release_6 Revision v6.24-5-g0c8bfefb3b8
|
Class ilStudyProgrammeProgress. More...
Public Member Functions | |
__construct (int $id) | |
getId () | |
Get the id of the progress. More... | |
getAssignmentId () | |
Get the assignment, this progress belongs to. More... | |
setAssignmentId (int $a_id) | |
getNodeId () | |
Get the id of the program node this progress belongs to. More... | |
setNodeId (int $a_id) | |
getUserId () | |
Get the id of the user this progress is for. More... | |
setUserId (int $a_id) | |
getAmountOfPoints () | |
Get the amount of points the user needs to achieve on the subnodes of this node. More... | |
setAmountOfPoints (int $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 (int $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 (int $a_status) | |
Set the status of this node. More... | |
setCompletionBy (int $a_id=null) | |
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 (int $a_usr_id=null) | |
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 (DateTime $a_timestamp) | |
Set the last change timestamp to the given time. More... | |
setAssignmentDate (DateTime $assignment_date) | |
Set the date of assignment. More... | |
getAssignmentDate () | |
Get the date of assignment. More... | |
setCompletionDate (DateTime $completion_date=null) | |
Set the timestamp of the complition of this progress. More... | |
getCompletionDate () | |
Get the timestamp of the complition of this progress. More... | |
getDeadline () | |
Get the deadline of this progress. More... | |
setDeadline (DateTime $deadline=null) | |
Set the deadline of this progress. More... | |
setValidityOfQualification (DateTime $date=null) | |
Set limited validity of qualification date. More... | |
getValidityOfQualification () | |
Get the limited validity of qualification date. More... | |
invalidate () | |
Toggle invalidated. More... | |
isInvalidated () | |
Data Fields | |
const | STATUS_IN_PROGRESS = 1 |
const | STATUS_COMPLETED = 2 |
const | STATUS_ACCREDITED = 3 |
const | STATUS_NOT_RELEVANT = 4 |
const | STATUS_FAILED = 5 |
const | DATE_TIME_FORMAT = 'Y-m-d H:i:s' |
const | DATE_FORMAT = 'Y-m-d' |
Static Public Attributes | |
static | $STATUS |
Protected Attributes | |
$id | |
$assignment_id | |
$prg_id | |
$usr_id | |
$points | |
$points_cur | |
$status | |
$completion_by | |
$last_change | |
$last_change_by | |
$assignment_date | |
$completion_date | |
$deadline | |
$vq_date | |
$invalidated = false | |
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.
Definition at line 20 of file class.ilStudyProgrammeProgress.php.
ilStudyProgrammeProgress::__construct | ( | int | $id | ) |
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.
Definition at line 225 of file class.ilStudyProgrammeProgress.php.
References $points.
Referenced by ilStudyProgrammeProgressDBRepository\update().
ilStudyProgrammeProgress::getAssignmentDate | ( | ) |
Get the date of assignment.
Definition at line 409 of file class.ilStudyProgrammeProgress.php.
References $assignment_date.
Referenced by ilStudyProgrammeProgressDBRepository\update().
ilStudyProgrammeProgress::getAssignmentId | ( | ) |
Get the assignment, this progress belongs to.
Definition at line 186 of file class.ilStudyProgrammeProgress.php.
References $assignment_id.
Referenced by ilStudyProgrammeProgressDBRepository\update().
ilStudyProgrammeProgress::getCompletionBy | ( | ) |
Get the id of object or user that lead to the successful completion of this node.
Definition at line 324 of file class.ilStudyProgrammeProgress.php.
References $completion_by.
Referenced by ilStudyProgrammeProgressDBRepository\update().
ilStudyProgrammeProgress::getCompletionDate | ( | ) |
Get the timestamp of the complition of this progress.
Definition at line 428 of file class.ilStudyProgrammeProgress.php.
References $completion_date.
Referenced by ilStudyProgrammeProgressDBRepository\update().
ilStudyProgrammeProgress::getCurrentAmountOfPoints | ( | ) |
Get the amount of points the user currently has achieved on the node.
Definition at line 253 of file class.ilStudyProgrammeProgress.php.
References $points_cur.
Referenced by ilStudyProgrammeProgressDBRepository\update().
ilStudyProgrammeProgress::getDeadline | ( | ) |
Get the deadline of this progress.
Definition at line 438 of file class.ilStudyProgrammeProgress.php.
References $deadline.
Referenced by ilStudyProgrammeProgressDBRepository\update().
ilStudyProgrammeProgress::getId | ( | ) |
Get the id of the progress.
Definition at line 178 of file class.ilStudyProgrammeProgress.php.
References $id.
Referenced by ilStudyProgrammeProgressDBRepository\update().
ilStudyProgrammeProgress::getLastChange | ( | ) |
Get the timestamp of the last change on this progress.
Definition at line 361 of file class.ilStudyProgrammeProgress.php.
Referenced by ilStudyProgrammeProgressDBRepository\update().
ilStudyProgrammeProgress::getLastChangeBy | ( | ) |
Get the id of the user who did the last change on this assignment.
Definition at line 333 of file class.ilStudyProgrammeProgress.php.
References $last_change_by.
Referenced by ilStudyProgrammeProgressDBRepository\update().
ilStudyProgrammeProgress::getNodeId | ( | ) |
Get the id of the program node this progress belongs to.
Definition at line 198 of file class.ilStudyProgrammeProgress.php.
References $prg_id.
Referenced by ilStudyProgrammeProgressDBRepository\update().
ilStudyProgrammeProgress::getStatus | ( | ) |
Get the status the user has on this node.
Definition at line 283 of file class.ilStudyProgrammeProgress.php.
References $status.
Referenced by ilStudyProgrammeProgressDBRepository\update().
ilStudyProgrammeProgress::getUserId | ( | ) |
Get the id of the user this progress is for.
Definition at line 210 of file class.ilStudyProgrammeProgress.php.
References $usr_id.
Referenced by ilStudyProgrammeProgressDBRepository\update().
ilStudyProgrammeProgress::getValidityOfQualification | ( | ) |
Get the limited validity of qualification date.
Definition at line 468 of file class.ilStudyProgrammeProgress.php.
References $vq_date.
Referenced by ilStudyProgrammeProgressDBRepository\update().
ilStudyProgrammeProgress::invalidate | ( | ) |
Toggle invalidated.
Definition at line 476 of file class.ilStudyProgrammeProgress.php.
Referenced by ilStudyProgrammeProgressDBRepository\buildByRow().
ilStudyProgrammeProgress::isInvalidated | ( | ) |
Definition at line 485 of file class.ilStudyProgrammeProgress.php.
References $invalidated.
Referenced by ilStudyProgrammeProgressDBRepository\update().
ilStudyProgrammeProgress::setAmountOfPoints | ( | int | $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.
Definition at line 237 of file class.ilStudyProgrammeProgress.php.
References updateLastChange().
ilStudyProgrammeProgress::setAssignmentDate | ( | DateTime | $assignment_date | ) |
Set the date of assignment.
Definition at line 400 of file class.ilStudyProgrammeProgress.php.
References $assignment_date.
ilStudyProgrammeProgress::setAssignmentId | ( | int | $a_id | ) |
Definition at line 190 of file class.ilStudyProgrammeProgress.php.
ilStudyProgrammeProgress::setCompletionBy | ( | int | $a_id = null | ) |
Set the completion_by field.
$a_id | int | null |
Definition at line 311 of file class.ilStudyProgrammeProgress.php.
References updateLastChange().
ilStudyProgrammeProgress::setCompletionDate | ( | DateTime | $completion_date = null | ) |
Set the timestamp of the complition of this progress.
Definition at line 417 of file class.ilStudyProgrammeProgress.php.
References $completion_date.
ilStudyProgrammeProgress::setCurrentAmountOfPoints | ( | int | $a_points | ) |
Set the amount of points the user currently has achieved on this node.
Throw when amount of points is smaller then zero.
ilException |
Definition at line 266 of file class.ilStudyProgrammeProgress.php.
References updateLastChange().
ilStudyProgrammeProgress::setDeadline | ( | DateTime | $deadline = null | ) |
Set the deadline of this progress.
DateTime | null | $deadline |
Definition at line 450 of file class.ilStudyProgrammeProgress.php.
References $deadline.
Referenced by ilStudyProgrammeUserProgress\setDeadline().
ilStudyProgrammeProgress::setLastChange | ( | DateTime | $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.
ilException |
Definition at line 391 of file class.ilStudyProgrammeProgress.php.
Referenced by updateLastChange().
ilStudyProgrammeProgress::setLastChangeBy | ( | int | $a_usr_id = null | ) |
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.
ilException |
Definition at line 346 of file class.ilStudyProgrammeProgress.php.
ilStudyProgrammeProgress::setNodeId | ( | int | $a_id | ) |
Definition at line 202 of file class.ilStudyProgrammeProgress.php.
ilStudyProgrammeProgress::setStatus | ( | int | $a_status | ) |
Set the status of this node.
Throws when status is none of ilStudyProgrammeProgress::STATUS_*.
Definition at line 293 of file class.ilStudyProgrammeProgress.php.
References updateLastChange().
ilStudyProgrammeProgress::setUserId | ( | int | $a_id | ) |
Definition at line 214 of file class.ilStudyProgrammeProgress.php.
ilStudyProgrammeProgress::setValidityOfQualification | ( | DateTime | $date = null | ) |
Set limited validity of qualification date.
Definition at line 459 of file class.ilStudyProgrammeProgress.php.
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.
Definition at line 376 of file class.ilStudyProgrammeProgress.php.
References setLastChange().
Referenced by setAmountOfPoints(), setCompletionBy(), setCurrentAmountOfPoints(), and setStatus().
|
protected |
Definition at line 138 of file class.ilStudyProgrammeProgress.php.
Referenced by getAssignmentDate(), and setAssignmentDate().
|
protected |
Definition at line 68 of file class.ilStudyProgrammeProgress.php.
Referenced by getAssignmentId().
|
protected |
Definition at line 115 of file class.ilStudyProgrammeProgress.php.
Referenced by getCompletionBy().
|
protected |
Definition at line 145 of file class.ilStudyProgrammeProgress.php.
Referenced by getCompletionDate(), and setCompletionDate().
|
protected |
Definition at line 152 of file class.ilStudyProgrammeProgress.php.
Referenced by getDeadline(), and setDeadline().
|
protected |
Definition at line 61 of file class.ilStudyProgrammeProgress.php.
Referenced by __construct(), and getId().
|
protected |
Definition at line 167 of file class.ilStudyProgrammeProgress.php.
Referenced by isInvalidated().
|
protected |
Definition at line 124 of file class.ilStudyProgrammeProgress.php.
|
protected |
Definition at line 131 of file class.ilStudyProgrammeProgress.php.
Referenced by getLastChangeBy().
|
protected |
Definition at line 91 of file class.ilStudyProgrammeProgress.php.
Referenced by getAmountOfPoints().
|
protected |
Definition at line 98 of file class.ilStudyProgrammeProgress.php.
Referenced by getCurrentAmountOfPoints().
|
protected |
Definition at line 75 of file class.ilStudyProgrammeProgress.php.
Referenced by getNodeId().
|
static |
Definition at line 40 of file class.ilStudyProgrammeProgress.php.
|
protected |
Definition at line 105 of file class.ilStudyProgrammeProgress.php.
Referenced by getStatus().
|
protected |
Definition at line 83 of file class.ilStudyProgrammeProgress.php.
Referenced by getUserId().
|
protected |
Definition at line 159 of file class.ilStudyProgrammeProgress.php.
Referenced by getValidityOfQualification().
const ilStudyProgrammeProgress::DATE_FORMAT = 'Y-m-d' |
Definition at line 48 of file class.ilStudyProgrammeProgress.php.
Referenced by ilStudyProgrammeProgressDBRepository\buildByRow(), ilStudyProgrammeProgressDBRepository\loadExpiredSuccessful(), ilStudyProgrammeProgressDBRepository\loadPassedDeadline(), ilStudyProgrammeProgressDBRepository\loadRiskyToFailInstance(), ilStudyProgrammeUserProgress\recalculateFailedToDeadline(), ilStudyProgrammeProgressRepositoryTest\test_query_ByIds(), ilStudyProgrammeProgressRepositoryTest\test_save_and_load(), and ilStudyProgrammeProgressDBRepository\update().
const ilStudyProgrammeProgress::DATE_TIME_FORMAT = 'Y-m-d H:i:s' |
Definition at line 47 of file class.ilStudyProgrammeProgress.php.
Referenced by ilStudyProgrammeProgressDBRepository\buildByRow(), and ilStudyProgrammeProgressDBRepository\update().
const ilStudyProgrammeProgress::STATUS_ACCREDITED = 3 |
Definition at line 34 of file class.ilStudyProgrammeProgress.php.
Referenced by ilStudyProgrammeChangeExpireDateGUI\buildFormElements(), ilObjStudyProgrammeAccess\checkCondition(), ilStudyProgrammeMembersTableGUI\fetchData(), ilStudyProgrammeDashboardViewGUI\findValidationValues(), ilStudyProgrammeIndividualPlanTableGUI\getManualStatusSelect(), ilStudyProgrammeUserProgress\getPossibleActions(), ilStudyProgrammeMembersTableGUI\getStatusOptions(), ilStudyProgrammeUserProgress\hasSuccessStatus(), ilStudyProgrammeUserProgress\invalidate(), ilStudyProgrammeUserProgress\isAccredited(), ilStudyProgrammeDashboardViewGUI\isCompleted(), ilStudyProgrammeUserProgress\isSuccessful(), ilStudyProgrammeProgressDBRepository\loadExpiredSuccessful(), ilStudyProgrammeProgressDBRepository\loadPassedDeadline(), ilStudyProgrammeProgressDBRepository\loadRiskyToFailInstance(), ilStudyProgrammeUserProgress\markAccredited(), ilStudyProgrammeUserProgress\markFailed(), ilObjStudyProgrammeMembersGUI\markRelevantMulti(), ilStudyProgrammeProgressTest\status(), ilStudyProgrammeUserProgressDB\statusToRepr(), ilStudyProgrammeMailTemplateContext\statusToRepr(), ilStudyProgrammeProgressRepositoryTest\test_query_ByIds(), ilStudyProgrammeProgressRepositoryTest\test_query_past_succsessful_1(), ilStudyProgrammeProgressRepositoryTest\test_query_past_succsessful_2(), ilPrgInvalidateExpiredProgressesCronJobTest\test_run(), ilStudyProgrammeProgressRepositoryTest\test_save_and_load(), ilStudyProgrammeUserProgressTest\testMarkAccredited(), ilStudyProgrammeUserProgressTest\testPossibleActions(), ilStudyProgrammeProgressCalculationTest\testProgress2(), ilStudyProgrammeUserProgress\unmarkAccredited(), ilObjStudyProgrammeMembersGUI\unmarkAccreditedMulti(), ilObjStudyProgrammeIndividualPlanGUI\updateStatus(), and ilStudyProgrammeUserProgress\updateStatus().
const ilStudyProgrammeProgress::STATUS_COMPLETED = 2 |
Definition at line 31 of file class.ilStudyProgrammeProgress.php.
Referenced by ilStudyProgrammeChangeExpireDateGUI\buildFormElements(), ilObjStudyProgrammeAccess\checkCondition(), ilStudyProgrammeMembersTableGUI\fetchData(), ilStudyProgrammeDashboardViewGUI\findValidationValues(), ilStudyProgrammeIndividualPlanTableGUI\getManualStatusSelect(), ilStudyProgrammeMembersTableGUI\getStatusOptions(), ilStudyProgrammeUserProgress\hasSuccessStatus(), ilStudyProgrammeUserProgress\invalidate(), ilStudyProgrammeDashboardViewGUI\isCompleted(), ilStudyProgrammeUserProgress\isSuccessful(), ilStudyProgrammeProgressDBRepository\loadExpiredSuccessful(), ilStudyProgrammeProgressDBRepository\loadRiskyToFailInstance(), ilStudyProgrammeUserProgress\markFailed(), ilStudyProgrammeUserProgress\setLPCompleted(), ilStudyProgrammeProgressTest\status(), ilStudyProgrammeUserProgressDB\statusToRepr(), ilStudyProgrammeMailTemplateContext\statusToRepr(), ilStudyProgrammeProgressRepositoryTest\test_query_past_succsessful_1(), ilPrgInvalidateExpiredProgressesCronJobTest\test_run(), ilStudyProgrammeProgressCalculationTest\testInitialProgressOnOptionalNodes(), ilStudyProgrammeUserProgressTest\testMarkAccredited(), ilStudyProgrammeProgressCalculationTest\testProgress1(), ilStudyProgrammeProgressCalculationTest\testProgress2(), ilStudyProgrammeProgressCalculationTest\testProgress3(), ilStudyProgrammeProgressCalculationTest\testProgress4(), ilStudyProgrammeUserProgress\updateFromProgramNode(), and ilStudyProgrammeUserProgress\updateStatus().
const ilStudyProgrammeProgress::STATUS_FAILED = 5 |
Definition at line 38 of file class.ilStudyProgrammeProgress.php.
Referenced by ilStudyProgrammeMembersTableGUI\getStatusOptions(), ilStudyProgrammeUserProgress\isFailed(), ilStudyProgrammeUserProgress\markFailed(), ilStudyProgrammeUserProgress\markNotFailed(), ilStudyProgrammeUserProgress\recalculateFailedToDeadline(), ilStudyProgrammeProgressTest\status(), ilStudyProgrammeUserProgressDB\statusToRepr(), ilStudyProgrammeMailTemplateContext\statusToRepr(), ilStudyProgrammeProgressRepositoryTest\test_query_past_succsessful_2(), ilStudyProgrammeUserProgressTest\testMarkFailed(), ilStudyProgrammeUserProgressTest\testMarkNotFailed(), ilStudyProgrammeUserAssignmentTest\testRstartAssignment(), and ilObjStudyProgrammeIndividualPlanGUI\updateStatus().
const ilStudyProgrammeProgress::STATUS_IN_PROGRESS = 1 |
Definition at line 28 of file class.ilStudyProgrammeProgress.php.
Referenced by ilStudyProgrammeProgressDBRepository\createFor(), ilStudyProgrammeUserProgress\getPossibleActions(), ilStudyProgrammeIndividualPlanTableGUI\getRequiredPointsInput(), ilStudyProgrammeMembersTableGUI\getStatusOptions(), ilStudyProgrammeDashboardViewGUI\isInProgress(), ilStudyProgrammeProgressDBRepository\loadPassedDeadline(), ilStudyProgrammeUserProgress\markNotFailed(), ilStudyProgrammeUserProgress\markRelevant(), ilObjStudyProgrammeMembersGUI\markRelevantMulti(), ilStudyProgrammeUserProgress\recalculateFailedToDeadline(), ilObjStudyProgramme\removeMemberFromProgrammes(), ilPrgUpdateProgressCronJob\run(), ilStudyProgrammeProgressTest\status(), ilStudyProgrammeUserProgressDB\statusToRepr(), ilStudyProgrammeMailTemplateContext\statusToRepr(), ilStudyProgrammeProgressRepositoryTest\test_create(), ilStudyProgrammeProgressRepositoryTest\test_save_and_load(), ilStudyProgrammeUserProgressTest\testInitialProgressActive(), ilStudyProgrammeUserProgressTest\testInitialProgressDraft(), ilStudyProgrammeProgressCalculationTest\testInitialProgressOnOptionalNodes(), ilStudyProgrammeUserProgressTest\testInitialProgressOutdated(), ilStudyProgrammeUserProgressTest\testMarkAccredited(), ilStudyProgrammeUserProgressTest\testMarkFailed(), ilStudyProgrammeUserProgressTest\testMarkNotFailed(), ilStudyProgrammeUserProgressTest\testMarkNotRelevant(), ilStudyProgrammeUserProgressTest\testPossibleActions(), ilStudyProgrammeProgressCalculationTest\testProgress4(), ilStudyProgrammeUserAssignmentTest\testRstartAssignment(), ilStudyProgrammeUserProgressTest\testUnmarkAccredited(), ilStudyProgrammeUserProgress\unmarkAccredited(), ilStudyProgrammeUserProgress\updateFromProgramNode(), ilObjStudyProgrammeIndividualPlanGUI\updateRequiredPoints(), ilObjStudyProgrammeIndividualPlanGUI\updateStatus(), and ilStudyProgrammeUserProgress\updateStatus().
const ilStudyProgrammeProgress::STATUS_NOT_RELEVANT = 4 |
Definition at line 36 of file class.ilStudyProgrammeProgress.php.
Referenced by ilObjStudyProgramme\addMissingProgresses(), ilObjStudyProgramme\assignUser(), ilObjStudyProgramme\canBeRemoved(), ilStudyProgrammeIndividualPlanTableGUI\getManualStatusSelect(), ilStudyProgrammeMembersTableGUI\getStatusOptions(), ilStudyProgrammeUserProgress\invalidate(), ilStudyProgrammeUserProgress\isRelevant(), ilStudyProgrammeUserProgress\markAccredited(), ilStudyProgrammeUserProgress\markFailed(), ilStudyProgrammeUserProgress\markNotRelevant(), ilStudyProgrammeUserProgress\markRelevant(), ilStudyProgrammeProgressTest\status(), ilStudyProgrammeUserProgressDB\statusToRepr(), ilStudyProgrammeMailTemplateContext\statusToRepr(), ilStudyProgrammeUserProgressTest\testInitialProgressDraft(), ilStudyProgrammeUserProgressTest\testInitialProgressOutdated(), ilStudyProgrammeUserProgressTest\testMarkNotRelevant(), ilStudyProgrammeUserProgressTest\testNewNodesAreNotRelevant(), ilStudyProgrammeUserProgressTest\testOutdatedNodesCantBeSetToRelevant(), ilStudyProgrammeUserProgressTest\testPossibleActions(), ilStudyProgrammeProgressCalculationTest\testProgress3(), ilStudyProgrammeProgressCalculationTest\testProgress4(), ilStudyProgrammeUserProgress\updateFromProgramNode(), ilObjStudyProgrammeIndividualPlanGUI\updateStatus(), and ilStudyProgrammeUserProgress\updateStatus().