ILIAS
release_5-4 Revision v5.4.26-12-gabc799a52e6
|
Handles everything about the state (current phase) of a user in an assignment using assignment, individual deadline, user and team information. More...
Public Member Functions | |
getIndividualDeadlineObject () | |
Get individual deadline object. More... | |
getGeneralStart () | |
Get general start. More... | |
getGeneralStartPresentation () | |
Get start presentation. More... | |
getIndividualStart () | |
Get individual start. More... | |
hasGenerallyStarted () | |
Has started. More... | |
getCalculatedDeadline () | |
Calculated deadline is only given, if a relative deadline is given and the user started the assignment. More... | |
getRelativeDeadline () | |
Get relative deadline. More... | |
getRelativeDeadlinePresentation () | |
Get relative deadline presentation. More... | |
getOfficialDeadline () | |
Get official deadline (individual deadline, fixed deadline or calculated deadline (using relative deadline and starting ts)) More... | |
getOfficialDeadlinePresentation () | |
Get official deadline presentation. More... | |
exceededOfficialDeadline () | |
Check if official deadline exists and has ended. More... | |
getRemainingTimePresentation () | |
Remaining time presentation (based on official deadline) More... | |
getIndividualDeadline () | |
Get individual deadline. More... | |
getIndividualDeadlinePresentation () | |
Get common deadline presentation. More... | |
getCommonDeadline () | |
Get common deadline (no individual deadline or grace period included) More... | |
getCommonDeadlinePresentation () | |
Get common deadline presentation. More... | |
getEffectiveDeadline () | |
Get effective deadline (max of official deadline and grace end period) for the user. More... | |
getPeerReviewDeadline () | |
Get peer review deadline. More... | |
getPeerReviewDeadlinePresentation () | |
Get common deadline presentation. More... | |
isPeerReviewAllowed () | |
Is submission currently allowed. More... | |
areInstructionsVisible () | |
Instructions visible. More... | |
inLateSubmissionPhase () | |
Get late submission warning. More... | |
hasSubmissionStarted () | |
Check if the submission phase has started for the current user. More... | |
hasSubmissionEnded () | |
Check if the submission phase has ended for the current user. More... | |
hasSubmissionEndedForAllUsers () | |
Has submission ended for all users. More... | |
isSubmissionAllowed () | |
Is submission currently allowed. More... | |
isGlobalFeedbackFileAccessible (ilExSubmission $submission) | |
Is global feedback file accessible? More... | |
Static Public Member Functions | |
static | getInstanceByIds ($a_ass_id, $a_user_id=0) |
Get instance by IDs (recommended for consumer code) More... | |
static | getInstance (ilExAssignment $a_ass, ilObjUser $a_user, ilExcIndividualDeadline $a_idl, $a_time, ilLanguage $lng, ilExAssignmentTeam $a_team=null) |
Get instance by dependencies. More... | |
Protected Member Functions | |
__construct (ilExAssignment $a_ass, ilObjUser $a_user, ilExcIndividualDeadline $a_idl, $a_time, ilLanguage $lng, ilExAssignmentTeam $a_team=null) | |
ilExcAssMemberState constructor. More... | |
getTimePresentation ($a_timestamp) | |
Get common deadline presentation. More... | |
Protected Attributes | |
$ass_id | |
$user_id | |
$assignment | |
$member_id | |
$team_id = 0 | |
$is_team = false | |
Handles everything about the state (current phase) of a user in an assignment using assignment, individual deadline, user and team information.
Definition at line 32 of file class.ilExcAssMemberState.php.
|
protected |
ilExcAssMemberState constructor.
int | $a_ass_id | assignment id |
int | $a_user_id | user id |
Definition at line 69 of file class.ilExcAssMemberState.php.
References $lng, ilExAssignment\getId(), ilObject\getId(), and ilExAssignment\TYPE_UPLOAD_TEAM.
ilExcAssMemberState::areInstructionsVisible | ( | ) |
Instructions visible.
Definition at line 439 of file class.ilExcAssMemberState.php.
References hasSubmissionStarted().
ilExcAssMemberState::exceededOfficialDeadline | ( | ) |
Check if official deadline exists and has ended.
Definition at line 280 of file class.ilExcAssMemberState.php.
References getOfficialDeadline().
ilExcAssMemberState::getCalculatedDeadline | ( | ) |
Calculated deadline is only given, if a relative deadline is given and the user started the assignment.
Definition at line 204 of file class.ilExcAssMemberState.php.
References ilExAssignment\DEADLINE_RELATIVE.
Referenced by getCommonDeadline(), and getOfficialDeadline().
ilExcAssMemberState::getCommonDeadline | ( | ) |
Get common deadline (no individual deadline or grace period included)
Definition at line 344 of file class.ilExcAssMemberState.php.
References ilExAssignment\DEADLINE_ABSOLUTE, and getCalculatedDeadline().
Referenced by getCommonDeadlinePresentation(), and getIndividualDeadline().
ilExcAssMemberState::getCommonDeadlinePresentation | ( | ) |
Get common deadline presentation.
Definition at line 358 of file class.ilExcAssMemberState.php.
References getCommonDeadline(), and getTimePresentation().
ilExcAssMemberState::getEffectiveDeadline | ( | ) |
Get effective deadline (max of official deadline and grace end period) for the user.
Definition at line 372 of file class.ilExcAssMemberState.php.
References getOfficialDeadline().
Referenced by hasSubmissionEnded(), and hasSubmissionEndedForAllUsers().
ilExcAssMemberState::getGeneralStart | ( | ) |
Get general start.
Definition at line 157 of file class.ilExcAssMemberState.php.
Referenced by getGeneralStartPresentation().
ilExcAssMemberState::getGeneralStartPresentation | ( | ) |
Get start presentation.
Definition at line 167 of file class.ilExcAssMemberState.php.
References getGeneralStart(), and getTimePresentation().
ilExcAssMemberState::getIndividualDeadline | ( | ) |
Get individual deadline.
Definition at line 316 of file class.ilExcAssMemberState.php.
References getCommonDeadline().
Referenced by getIndividualDeadlinePresentation().
ilExcAssMemberState::getIndividualDeadlineObject | ( | ) |
Get individual deadline object.
Definition at line 145 of file class.ilExcAssMemberState.php.
ilExcAssMemberState::getIndividualDeadlinePresentation | ( | ) |
Get common deadline presentation.
Definition at line 330 of file class.ilExcAssMemberState.php.
References getIndividualDeadline(), and getTimePresentation().
ilExcAssMemberState::getIndividualStart | ( | ) |
Get individual start.
Definition at line 180 of file class.ilExcAssMemberState.php.
References ilExAssignment\DEADLINE_RELATIVE.
Referenced by hasSubmissionStarted().
|
static |
Get instance by dependencies.
Usually you should prefer to use getInstanceByIds. If you use getInstance you need to ensure consistency (e.g. deadline needs to match user)
Definition at line 135 of file class.ilExcAssMemberState.php.
References $lng.
|
static |
Get instance by IDs (recommended for consumer code)
int | $a_ass_id | assignment id |
int | $a_user_id | user id |
Definition at line 99 of file class.ilExcAssMemberState.php.
References $DIC, $is_team, $lng, $member_id, $user, ilExcIndividualDeadline\getInstance(), ilExAssignmentTeam\getInstanceByUserId(), and ilExAssignment\TYPE_UPLOAD_TEAM.
Referenced by ilExSubmission\__construct(), ilCalendarScheduleFilterExercise\addCustomEvents(), ilExAssignmentGUI\addInstructions(), ilExAssignmentGUI\addPublicSubmissions(), ilExAssignmentGUI\addSchedule(), ilExAssignmentGUI\addSubmission(), ilAppointmentPresentationExerciseGUI\collectPropertiesAndActions(), ilExSubmissionGUI\downloadFileObject(), ilExSubmissionGUI\downloadGlobalFeedbackFileObject(), ilAppointmentExerciseFileHandler\getFiles(), ilExAssignmentGUI\getOverviewBody(), ilExSubmissionTeamGUI\getOverviewContent(), ilExPeerReviewGUI\getOverviewContent(), ilExAssignmentGUI\getOverviewHeader(), ilExAssignmentReminder\parsePeerReminders(), ilExAssignmentReminder\parseSubmissionReminders(), and ilObjExerciseGUI\startAssignmentObject().
ilExcAssMemberState::getOfficialDeadline | ( | ) |
Get official deadline (individual deadline, fixed deadline or calculated deadline (using relative deadline and starting ts))
Grace period is not taken into account here.
Definition at line 248 of file class.ilExcAssMemberState.php.
References ilExAssignment\DEADLINE_ABSOLUTE, and getCalculatedDeadline().
Referenced by exceededOfficialDeadline(), getEffectiveDeadline(), getOfficialDeadlinePresentation(), getRemainingTimePresentation(), and inLateSubmissionPhase().
ilExcAssMemberState::getOfficialDeadlinePresentation | ( | ) |
Get official deadline presentation.
Definition at line 266 of file class.ilExcAssMemberState.php.
References getOfficialDeadline(), and getTimePresentation().
ilExcAssMemberState::getPeerReviewDeadline | ( | ) |
Get peer review deadline.
Definition at line 382 of file class.ilExcAssMemberState.php.
Referenced by getPeerReviewDeadlinePresentation(), and isPeerReviewAllowed().
ilExcAssMemberState::getPeerReviewDeadlinePresentation | ( | ) |
Get common deadline presentation.
Definition at line 396 of file class.ilExcAssMemberState.php.
References getPeerReviewDeadline(), and getTimePresentation().
ilExcAssMemberState::getRelativeDeadline | ( | ) |
Get relative deadline.
Definition at line 220 of file class.ilExcAssMemberState.php.
References ilExAssignment\DEADLINE_RELATIVE.
Referenced by getRelativeDeadlinePresentation().
ilExcAssMemberState::getRelativeDeadlinePresentation | ( | ) |
Get relative deadline presentation.
Definition at line 233 of file class.ilExcAssMemberState.php.
References ilExAssignment\DEADLINE_RELATIVE, and getRelativeDeadline().
ilExcAssMemberState::getRemainingTimePresentation | ( | ) |
Remaining time presentation (based on official deadline)
Definition at line 295 of file class.ilExcAssMemberState.php.
References $lng, getOfficialDeadline(), IL_CAL_UNIX, and ilUtil\period2String().
|
protected |
Get common deadline presentation.
Definition at line 425 of file class.ilExcAssMemberState.php.
References ilDatePresentation\formatDate(), and IL_CAL_UNIX.
Referenced by getCommonDeadlinePresentation(), getGeneralStartPresentation(), getIndividualDeadlinePresentation(), getOfficialDeadlinePresentation(), and getPeerReviewDeadlinePresentation().
ilExcAssMemberState::hasGenerallyStarted | ( | ) |
Has started.
Definition at line 194 of file class.ilExcAssMemberState.php.
Referenced by hasSubmissionStarted().
ilExcAssMemberState::hasSubmissionEnded | ( | ) |
Check if the submission phase has ended for the current user.
Definition at line 507 of file class.ilExcAssMemberState.php.
References getEffectiveDeadline().
Referenced by isSubmissionAllowed().
ilExcAssMemberState::hasSubmissionEndedForAllUsers | ( | ) |
Has submission ended for all users.
Definition at line 525 of file class.ilExcAssMemberState.php.
References getEffectiveDeadline().
Referenced by isGlobalFeedbackFileAccessible(), and isPeerReviewAllowed().
ilExcAssMemberState::hasSubmissionStarted | ( | ) |
Check if the submission phase has started for the current user.
(if the assignment is generally started and for relative deadlines, if the user started the assignment)
Definition at line 493 of file class.ilExcAssMemberState.php.
References ilExAssignment\DEADLINE_ABSOLUTE, getIndividualStart(), and hasGenerallyStarted().
Referenced by areInstructionsVisible(), and isSubmissionAllowed().
ilExcAssMemberState::inLateSubmissionPhase | ( | ) |
Get late submission warning.
Definition at line 474 of file class.ilExcAssMemberState.php.
References getOfficialDeadline(), and isSubmissionAllowed().
ilExcAssMemberState::isGlobalFeedbackFileAccessible | ( | ilExSubmission | $submission | ) |
Is global feedback file accessible?
ilExSubmission | $submission |
Definition at line 560 of file class.ilExcAssMemberState.php.
References ilExAssignment\FEEDBACK_DATE_CUSTOM, ilExAssignment\FEEDBACK_DATE_DEADLINE, hasSubmissionEndedForAllUsers(), and ilExSubmission\hasSubmitted().
ilExcAssMemberState::isPeerReviewAllowed | ( | ) |
Is submission currently allowed.
Definition at line 410 of file class.ilExcAssMemberState.php.
References $time, getPeerReviewDeadline(), and hasSubmissionEndedForAllUsers().
ilExcAssMemberState::isSubmissionAllowed | ( | ) |
Is submission currently allowed.
Definition at line 547 of file class.ilExcAssMemberState.php.
References hasSubmissionEnded(), and hasSubmissionStarted().
Referenced by inLateSubmissionPhase().
|
protected |
Definition at line 37 of file class.ilExcAssMemberState.php.
|
protected |
Definition at line 47 of file class.ilExcAssMemberState.php.
|
protected |
Definition at line 62 of file class.ilExcAssMemberState.php.
Referenced by getInstanceByIds().
|
protected |
Definition at line 52 of file class.ilExcAssMemberState.php.
Referenced by getInstanceByIds().
|
protected |
Definition at line 57 of file class.ilExcAssMemberState.php.
|
protected |
Definition at line 42 of file class.ilExcAssMemberState.php.