ilExcAssMemberState Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilExcAssMemberState:

Public Member Functions
	getIndividualDeadlineObject ()
	getGeneralStart ()
	getGeneralStartPresentation ()
	getIndividualStart ()
	hasGenerallyStarted ()
	getCalculatedDeadline ()
	Calculated deadline is only given, if a relative deadline is given and the user started the assignment the value may be restricted by the last submission date for relative deadlines. More...
	getRelativeDeadlineStartLeadText ()
	getRemainingTimePresentationOfLastSubmissionOfRelativeDeadline ()
	Remaining time for last submission of relative deadline. More...
	getRelativeDeadline ()
	getLastSubmissionOfRelativeDeadline ()
	getRelativeDeadlinePresentation ()
	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. More...
	getOfficialDeadlinePresentation ()
	getLastSubmissionOfRelativeDeadlinePresentation ()
	exceededOfficialDeadline ()
	getRemainingTimePresentation ()
	Remaining time presentation (based on official deadline) More...
	getRemainingPeerReviewPresentation ()
	getRemainingTimeLeadText ()
	getPeerReviewLeadText ()
	getIndividualDeadline ()
	getIndividualDeadlinePresentation ()
	getCommonDeadline ()
	getCommonDeadlinePresentation ()
	getEffectiveDeadline ()
	getPeerReviewDeadline ()
	getPeerReviewDeadlinePresentation ()
	isPeerReviewAllowed ()
	isReceivedFeedbackAccessible ()
	areInstructionsVisible ()
	inLateSubmissionPhase ()
	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) More...
	hasSubmissionEnded ()
	hasEnded ()
	Check if assignment has ended for current user. More...
	isFuture ()
	hasSubmissionEndedForAllUsers ()
	isSubmissionAllowed ()
	isGlobalFeedbackFileAccessible (ilExSubmission $submission)
	needsIndividualDeadline ()
	hasRequestedIndividualDeadline ()

Static Public Member Functions
static	getInstanceByIds (int $a_ass_id, int $a_user_id=0)
static	getInstance (ilExAssignment $a_ass, ilObjUser $a_user, ilExcIndividualDeadline $a_idl, int $a_time, ilLanguage $lng, ?ilExAssignmentTeam $a_team=null)
	Usually you should prefer to use getInstanceByIds. More...

Protected Member Functions
	__construct (ilExAssignment $a_ass, ilObjUser $a_user, ilExcIndividualDeadline $a_idl, int $a_time, ilLanguage $lng, ?ilExAssignmentTeam $a_team=null)
	getTimePresentation ($a_timestamp)

Protected Attributes
int	$ass_id
int	$user_id
ilExAssignment	$assignment
int	$time
ilLanguage	$lng
int	$member_id
	either user id or team id, if this is a team assignment and the user is member of a team, in this case is_team is true More...
int	$team_id = 0
bool	$is_team = false
ilExcIndividualDeadline	$idl

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Handles everything about the state (current phase) of a user in an assignment using assignment, individual deadline, user and team information.

• General Start: As entered in settings. For absolute deadlines, this also starts the submission, for relative deadline this allows the user to start the submission period. (0 = immediately)
• Individual Start: TS when user hits "Start" button for an assignment using a relative deadline
• Submission Start: For absolute deadlines this is General Start, for relative deadlines Individual Start
• Deadline: absolute Deadline (e.g. 5.12.2017) as set in settings
• Relative Deadline: relative Deadline (e.g. 10 Days) as set in settings
• Last Submission for Relative Deadlines: As set in the settings
• Calculated Deadline: Min of (Starting Timestamp + Relative Deadline, Last Submission for Relative Deadlines)
• Individual Deadline: Set by tutor in "Submissions and Grade" screen
• Common Deadline: Deadline or Calculated Deadline Used for "Ended on" or "Edit Until" presentation
• Official Deadline: Max of (Deadline and Individual Deadline) or (Calculated Deadline and Individual Deadline)
• Effective Deadline: Max of official deadline and grace period end date
• Grace Period End Date: As being set in the settings of assignmet by tutor
• Grace Period: Period between Official Deadline and Grace Period End Date.
• Submission Period: From Submission Start (if not given immediately) to Max of (Official Deadline and Grace Period End Date)
• Late Submission Period: Submissions being handed in during Grace Period
• Peer Review Start: Max of (Official Deadline OF ALL USERS and Grace Period End Date)
• Peer Review Deadline: As being set in the settings of assignmet by tutor
• Peer Review Period: From Peer Feedback Start to Peer Feedback Deadline (may be infinite, if no deadline given)

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 46 of file class.ilExcAssMemberState.php.

Constructor & Destructor Documentation

__construct()

ilExcAssMemberState::__construct ( ilExAssignment  $a_ass, ilObjUser  $a_user, ilExcIndividualDeadline  $a_idl, int  $a_time, ilLanguage  $lng, ?ilExAssignmentTeam  $a_team = null  )

protected

Definition at line 63 of file class.ilExcAssMemberState.php.

References $lng, ilExAssignment\getId(), ilObject\getId(), ILIAS\Repository\lng(), and ilExAssignment\TYPE_UPLOAD_TEAM.

      {
        $this->time = $a_time;
        $this->ass_id = $a_ass->getId();
        $this->user_id = $a_user->getId();
        $this->member_id = $a_user->getId();
        $this->lng = $lng;

        $this->assignment = $a_ass;

        // check team status
        $this->is_team = false;
        if ($this->assignment->getType() == ilExAssignment::TYPE_UPLOAD_TEAM) {
            if ($a_team->getId()) {
                $this->member_id = $a_team->getId();
                $this->team_id = $a_team->getId();
                $this->is_team = true;
            }
        }

        $this->idl = $a_idl;
    }

Here is the call graph for this function:

Member Function Documentation

areInstructionsVisible()

ilExcAssMemberState::areInstructionsVisible

(

)

Definition at line 487 of file class.ilExcAssMemberState.php.

References hasSubmissionStarted().

                                            : bool
    {
        return $this->hasSubmissionStarted();
    }

Here is the call graph for this function:

exceededOfficialDeadline()

ilExcAssMemberState::exceededOfficialDeadline

(

)

Definition at line 308 of file class.ilExcAssMemberState.php.

References getOfficialDeadline().

Referenced by ilExAssignmentInfo\getScheduleInfo().

                                              : bool
    {
        $od = $this->getOfficialDeadline();
        if ($od && $od < time()) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCalculatedDeadline()

ilExcAssMemberState::getCalculatedDeadline

(

)

Calculated deadline is only given, if a relative deadline is given and the user started the assignment the value may be restricted by the last submission date for relative deadlines.

Definition at line 177 of file class.ilExcAssMemberState.php.

References ilExAssignment\DEADLINE_RELATIVE.

Referenced by getCommonDeadline(), and getOfficialDeadline().

                                           : int
    {
        $calculated_deadline = 0;
        if ($this->assignment->getDeadlineMode() == ilExAssignment::DEADLINE_RELATIVE) {
            if ($this->idl->getStartingTimestamp() && $this->assignment->getRelativeDeadline()) {
                $calculated_deadline = $this->idl->getStartingTimestamp() + ($this->assignment->getRelativeDeadline() * 24 * 60 * 60);
            }
            if ($this->assignment->getRelDeadlineLastSubmission() > 0 &&
                $calculated_deadline > $this->assignment->getRelDeadlineLastSubmission()) {
                $calculated_deadline = $this->assignment->getRelDeadlineLastSubmission();
            }
        }
        return $calculated_deadline;
    }

Here is the caller graph for this function:

getCommonDeadline()

ilExcAssMemberState::getCommonDeadline

(

)

Definition at line 395 of file class.ilExcAssMemberState.php.

References ilExAssignment\DEADLINE_ABSOLUTE, and getCalculatedDeadline().

Referenced by getCommonDeadlinePresentation(), getIndividualDeadline(), and ilExAssignmentInfo\getScheduleInfo().

                                       : int
    {
        if ($this->assignment->getDeadlineMode() == ilExAssignment::DEADLINE_ABSOLUTE) {        // absolute deadline
            return $this->assignment->getDeadline();
        }

        return $this->getCalculatedDeadline();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCommonDeadlinePresentation()

ilExcAssMemberState::getCommonDeadlinePresentation

(

)

Returns

string

Exceptions

ilDateTimeException

Definition at line 408 of file class.ilExcAssMemberState.php.

References getCommonDeadline(), and getTimePresentation().

Referenced by ilExAssignmentInfo\getScheduleInfo().

                                                   : string
    {
        if ($this->getCommonDeadline() > 0) {
            return $this->getTimePresentation($this->getCommonDeadline());
        }

        return "no deadline";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getEffectiveDeadline()

ilExcAssMemberState::getEffectiveDeadline

(

)

Definition at line 418 of file class.ilExcAssMemberState.php.

References getOfficialDeadline().

Referenced by hasSubmissionEnded(), and hasSubmissionEndedForAllUsers().

                                          : int
    {
        return max($this->getOfficialDeadline(), $this->assignment->getExtendedDeadline());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getGeneralStart()

ilExcAssMemberState::getGeneralStart

(

)

Definition at line 142 of file class.ilExcAssMemberState.php.

Referenced by getGeneralStartPresentation(), and ilExAssignmentInfo\getScheduleInfo().

                                     : ?int
    {
        return $this->assignment->getStartTime();
    }

Here is the caller graph for this function:

getGeneralStartPresentation()

ilExcAssMemberState::getGeneralStartPresentation

(

)

Returns

string

Exceptions

ilDateTimeException

Definition at line 151 of file class.ilExcAssMemberState.php.

References getGeneralStart(), and getTimePresentation().

Referenced by ilExAssignmentInfo\getScheduleInfo().

                                                 : string
    {
        if ($this->getGeneralStart()) {
            return $this->getTimePresentation($this->getGeneralStart());
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getIndividualDeadline()

ilExcAssMemberState::getIndividualDeadline

(

)

Definition at line 373 of file class.ilExcAssMemberState.php.

References getCommonDeadline().

Referenced by getIndividualDeadlinePresentation().

                                           : int
    {
        if ($this->idl->getIndividualDeadline() > $this->getCommonDeadline()) {
            return $this->idl->getIndividualDeadline();
        }
        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getIndividualDeadlineObject()

ilExcAssMemberState::getIndividualDeadlineObject

(

)

Definition at line 137 of file class.ilExcAssMemberState.php.

References $idl.

                                                 : ilExcIndividualDeadline
    {
        return $this->idl;
    }

getIndividualDeadlinePresentation()

ilExcAssMemberState::getIndividualDeadlinePresentation

(

)

Returns

string

Exceptions

ilDateTimeException

Definition at line 385 of file class.ilExcAssMemberState.php.

References getIndividualDeadline(), and getTimePresentation().

                                                       : string
    {
        if ($this->getIndividualDeadline() > 0) {
            return $this->getTimePresentation($this->getIndividualDeadline());
        }

        return "";
    }

Here is the call graph for this function:

getIndividualStart()

ilExcAssMemberState::getIndividualStart

(

)

Definition at line 159 of file class.ilExcAssMemberState.php.

References ilExAssignment\DEADLINE_RELATIVE.

Referenced by hasSubmissionStarted().

                                        : int
    {
        if ($this->assignment->getDeadlineMode() == ilExAssignment::DEADLINE_RELATIVE) {
            return $this->idl->getStartingTimestamp();
        }
        return 0;
    }

Here is the caller graph for this function:

getInstance()

static ilExcAssMemberState::getInstance ( ilExAssignment  $a_ass, ilObjUser  $a_user, ilExcIndividualDeadline  $a_idl, int  $a_time, ilLanguage  $lng, ?ilExAssignmentTeam  $a_team = null  )

static

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 126 of file class.ilExcAssMemberState.php.

References $lng.

     : ilExcAssMemberState {
        return new self($a_ass, $a_user, $a_idl, $a_time, $lng, $a_team);
    }

getInstanceByIds()

static ilExcAssMemberState::getInstanceByIds ( int  $a_ass_id, int  $a_user_id = 0  )

static

Definition at line 93 of file class.ilExcAssMemberState.php.

References $DIC, ilExcIndividualDeadline\getInstance(), ilExAssignmentTeam\getInstanceByUserId(), null, and ilExAssignment\TYPE_UPLOAD_TEAM.

Referenced by ilExAssignmentInfo\__construct(), ilExSubmission\__construct(), ilCalendarScheduleFilterExercise\addCustomEvents(), ILIAS\Exercise\Assignment\PropertyAndActionBuilderUI\build(), ilAppointmentPresentationExerciseGUI\collectPropertiesAndActions(), ilExSubmissionGUI\downloadFileObject(), ilExSubmissionGUI\downloadGlobalFeedbackFileObject(), ilExPeerReviewGUI\editPeerReviewItemObject(), ilAppointmentExerciseFileHandler\getFiles(), ilExSubmissionTeamGUI\getOverviewContent(), ilExPeerReviewGUI\getOverviewContent(), ilExAssignmentReminder\getReminders(), ilBlogExerciseGUI\getSubmitButton(), ilPortfolioExerciseGUI\getSubmitButton(), ilExerciseDerivedTaskProvider\getTasks(), ilExAssignmentReminder\parsePeerReminders(), and ilObjExerciseGUI\startAssignmentObject().

     : ilExcAssMemberState {
        global $DIC;

        $lng = $DIC->language();
        $user = ($a_user_id > 0)
            ? new ilObjUser($a_user_id)
            : $DIC->user();

        $ass = new ilExAssignment($a_ass_id);

        $member_id = $user->getId();
        $is_team = false;
        $team = null;
        if ($ass->getType() == ilExAssignment::TYPE_UPLOAD_TEAM) {              // better move this to ilExcIndividualDeadline
            $team = ilExAssignmentTeam::getInstanceByUserId($a_ass_id, $user->getId());
            if ($team->getId()) {
                $member_id = $team->getId();
                $is_team = true;
            }
        }

        // note: team may be not null, but is_team still false
        $idl = ilExcIndividualDeadline::getInstance($a_ass_id, $member_id, $is_team);

        return self::getInstance($ass, $user, $idl, time(), $lng, $team);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLastSubmissionOfRelativeDeadline()

ilExcAssMemberState::getLastSubmissionOfRelativeDeadline

(

)

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

References ilExAssignment\DEADLINE_RELATIVE.

Referenced by getLastSubmissionOfRelativeDeadlinePresentation().

                                                         : int
    {
        if ($this->assignment->getDeadlineMode() == ilExAssignment::DEADLINE_RELATIVE) {
            return $this->assignment->getRelDeadlineLastSubmission();
        }
        return 0;
    }

Here is the caller graph for this function:

getLastSubmissionOfRelativeDeadlinePresentation()

ilExcAssMemberState::getLastSubmissionOfRelativeDeadlinePresentation

(

)

Returns

string

Exceptions

ilDateTimeException

Definition at line 298 of file class.ilExcAssMemberState.php.

References getLastSubmissionOfRelativeDeadline(), and getTimePresentation().

Referenced by getRelativeDeadlineStartLeadText().

                                                                     : string
    {
        if ($this->getLastSubmissionOfRelativeDeadline() > 0) {
            return $this->getTimePresentation($this->getLastSubmissionOfRelativeDeadline());
        }

        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOfficialDeadline()

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 269 of file class.ilExcAssMemberState.php.

References ilExAssignment\DEADLINE_ABSOLUTE, and getCalculatedDeadline().

Referenced by exceededOfficialDeadline(), getEffectiveDeadline(), getOfficialDeadlinePresentation(), getRemainingTimePresentation(), ilExAssignmentInfo\getScheduleInfo(), and inLateSubmissionPhase().

                                         : int
    {
        $dl = $this->idl->getIndividualDeadline();              // team or user individual deadline

        if ($this->assignment->getDeadlineMode() == ilExAssignment::DEADLINE_ABSOLUTE) {        // absolute deadline
            return max($this->assignment->getDeadline(), $dl);                          // take what's greater: idl or abs deadline
        }

        // relative deadline: take max idl or calculated deadline
        return max($this->getCalculatedDeadline(), $dl);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOfficialDeadlinePresentation()

ilExcAssMemberState::getOfficialDeadlinePresentation

(

)

Returns

string

Exceptions

ilDateTimeException

Definition at line 285 of file class.ilExcAssMemberState.php.

References getOfficialDeadline(), and getTimePresentation().

Referenced by ilExAssignmentInfo\getScheduleInfo().

                                                     : string
    {
        if ($this->getOfficialDeadline() > 0) {
            return $this->getTimePresentation($this->getOfficialDeadline());
        }

        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPeerReviewDeadline()

ilExcAssMemberState::getPeerReviewDeadline

(

)

Definition at line 423 of file class.ilExcAssMemberState.php.

Referenced by getPeerReviewDeadlinePresentation(), getRemainingPeerReviewPresentation(), hasEnded(), and isPeerReviewAllowed().

                                           : int
    {
        if ($this->assignment->getPeerReview() &&
            $this->assignment->getPeerReviewDeadline()) {
            return $this->assignment->getPeerReviewDeadline();
        }
        return 0;
    }

Here is the caller graph for this function:

getPeerReviewDeadlinePresentation()

ilExcAssMemberState::getPeerReviewDeadlinePresentation

(

)

Returns

string

Exceptions

ilDateTimeException

Definition at line 436 of file class.ilExcAssMemberState.php.

References getPeerReviewDeadline(), and getTimePresentation().

                                                       : string
    {
        if ($this->getPeerReviewDeadline() > 0) {
            return $this->getTimePresentation($this->getPeerReviewDeadline());
        }

        return "no peer review deadline";
    }

Here is the call graph for this function:

getPeerReviewLeadText()

ilExcAssMemberState::getPeerReviewLeadText

(

)

Definition at line 360 of file class.ilExcAssMemberState.php.

References $lng, getRemainingPeerReviewPresentation(), and ILIAS\Repository\lng().

                                           : string
    {
        $lng = $this->lng;
        if ($this->assignment->getPeerReviewDeadline() > 0) {
            return sprintf(
                $this->lng->txt("exc_peer_reviews_in_lead_text"),
                $this->getRemainingPeerReviewPresentation()
            );
        } else {
            return $this->lng->txt("exc_review_anytime");
        }
    }

Here is the call graph for this function:

getRelativeDeadline()

ilExcAssMemberState::getRelativeDeadline

(

)

Definition at line 240 of file class.ilExcAssMemberState.php.

References ilExAssignment\DEADLINE_RELATIVE.

Referenced by getRelativeDeadlinePresentation(), and ilExAssignmentInfo\getScheduleInfo().

                                         : int
    {
        if ($this->assignment->getDeadlineMode() == ilExAssignment::DEADLINE_RELATIVE) {
            return $this->assignment->getRelativeDeadline();
        }
        return 0;
    }

Here is the caller graph for this function:

getRelativeDeadlinePresentation()

ilExcAssMemberState::getRelativeDeadlinePresentation

(

)

Definition at line 256 of file class.ilExcAssMemberState.php.

References ilExAssignment\DEADLINE_RELATIVE, getRelativeDeadline(), and ILIAS\Repository\lng().

Referenced by ilExAssignmentInfo\getScheduleInfo().

                                                     : string
    {
        if ($this->assignment->getDeadlineMode() == ilExAssignment::DEADLINE_RELATIVE) {
            return $this->getRelativeDeadline() . " " . $this->lng->txt("days");
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRelativeDeadlineStartLeadText()

ilExcAssMemberState::getRelativeDeadlineStartLeadText

(

)

Definition at line 192 of file class.ilExcAssMemberState.php.

References getLastSubmissionOfRelativeDeadlinePresentation(), getRemainingTimePresentationOfLastSubmissionOfRelativeDeadline(), and ILIAS\Repository\lng().

                                                      : string
    {
        $start_in_time = true;
        if ($this->assignment->getRelDeadlineLastSubmission() > 0) {
            $starting_now = time() + ($this->assignment->getRelativeDeadline() * 24 * 60 * 60);
            if ($starting_now > $this->assignment->getRelDeadlineLastSubmission()) {
                $start_in_time = false;
            }
        }
        if ($start_in_time) {
            $lead_text = sprintf(
                $this->lng->txt("exc_rel_start_lead_text"),
                $this->assignment->getRelativeDeadline()
            );
            if ($this->assignment->getRelDeadlineLastSubmission() > 0) {
                $lead_text .= ", <br>" . sprintf(
                    $this->lng->txt("exc_rel_start_latest_lead_text"),
                    $this->getLastSubmissionOfRelativeDeadlinePresentation()
                );
            }
        } else {
            return sprintf(
                $this->lng->txt("exc_hand_in_lead_text"),
                $this->getRemainingTimePresentationOfLastSubmissionOfRelativeDeadline()
            );
        }
        return $lead_text;
    }

Here is the call graph for this function:

getRemainingPeerReviewPresentation()

ilExcAssMemberState::getRemainingPeerReviewPresentation

(

)

Definition at line 338 of file class.ilExcAssMemberState.php.

References $lng, getPeerReviewDeadline(), IL_CAL_UNIX, ilLegacyFormElementsUtil\period2String(), and ilLanguage\txt().

Referenced by getPeerReviewLeadText().

                                                        : string
    {
        $lng = $this->lng;
        $official_deadline = $this->getPeerReviewDeadline();
        if ($official_deadline == 0) {
            return $lng->txt("exc_no_deadline_specified");
        }
        if ($official_deadline - $this->time <= 0) {
            $time_str = $lng->txt("exc_time_over_short");
        } else {
            $time_str = ilLegacyFormElementsUtil::period2String(new ilDateTime($official_deadline, IL_CAL_UNIX));
        }

        return $time_str;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRemainingTimeLeadText()

ilExcAssMemberState::getRemainingTimeLeadText

(

)

Definition at line 354 of file class.ilExcAssMemberState.php.

References $lng, getRemainingTimePresentation(), and ILIAS\Repository\lng().

                                              : string
    {
        $lng = $this->lng;
        return sprintf($this->lng->txt("exc_hand_in_lead_text"), $this->getRemainingTimePresentation());
    }

Here is the call graph for this function:

getRemainingTimePresentation()

ilExcAssMemberState::getRemainingTimePresentation

(

)

Remaining time presentation (based on official deadline)

Returns

string

Exceptions

ilDateTimeException

Definition at line 322 of file class.ilExcAssMemberState.php.

References $lng, getOfficialDeadline(), IL_CAL_UNIX, ilLegacyFormElementsUtil\period2String(), and ilLanguage\txt().

Referenced by getRemainingTimeLeadText(), and ilExAssignmentInfo\getScheduleInfo().

                                                  : string
    {
        $lng = $this->lng;
        $official_deadline = $this->getOfficialDeadline();
        if ($official_deadline == 0) {
            return $lng->txt("exc_no_deadline_specified");
        }
        if ($official_deadline - $this->time <= 0) {
            $time_str = $lng->txt("exc_time_over_short");
        } else {
            $time_str = ilLegacyFormElementsUtil::period2String(new ilDateTime($official_deadline, IL_CAL_UNIX));
        }

        return $time_str;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRemainingTimePresentationOfLastSubmissionOfRelativeDeadline()

ilExcAssMemberState::getRemainingTimePresentationOfLastSubmissionOfRelativeDeadline

(

)

Remaining time for last submission of relative deadline.

Returns

string

Exceptions

ilDateTimeException

Definition at line 226 of file class.ilExcAssMemberState.php.

References $lng, IL_CAL_UNIX, ilLegacyFormElementsUtil\period2String(), and ilLanguage\txt().

Referenced by getRelativeDeadlineStartLeadText().

                                                                                    : string
    {
        $lng = $this->lng;
        $last_deadline = $this->assignment->getRelDeadlineLastSubmission();
        if ($last_deadline - $this->time <= 0) {
            $time_str = $lng->txt("exc_time_over_short");
        } else {
            $time_str = ilLegacyFormElementsUtil::period2String(new ilDateTime($last_deadline, IL_CAL_UNIX));
        }

        return $time_str;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTimePresentation()

ilExcAssMemberState::getTimePresentation (   $a_timestamp )

protected

Parameters

$a_timestamp

Returns

string

Exceptions

ilDateTimeException

Definition at line 478 of file class.ilExcAssMemberState.php.

References ilDatePresentation\formatDate(), and IL_CAL_UNIX.

Referenced by getCommonDeadlinePresentation(), getGeneralStartPresentation(), getIndividualDeadlinePresentation(), getLastSubmissionOfRelativeDeadlinePresentation(), getOfficialDeadlinePresentation(), and getPeerReviewDeadlinePresentation().

                                                        : string
    {
        if ($a_timestamp > 0) {
            return ilDatePresentation::formatDate(new ilDateTime($a_timestamp, IL_CAL_UNIX));
        }

        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasEnded()

ilExcAssMemberState::hasEnded

(

)

Check if assignment has ended for current user.

Definition at line 545 of file class.ilExcAssMemberState.php.

References $time, getPeerReviewDeadline(), and hasSubmissionEnded().

                              : bool
    {
        if ($this->hasSubmissionEnded()) {
            if (!$this->assignment->getPeerReview() || ($this->getPeerReviewDeadline() !== 0 && $this->getPeerReviewDeadline() < $this->time)) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

hasGenerallyStarted()

ilExcAssMemberState::hasGenerallyStarted

(

)

Definition at line 167 of file class.ilExcAssMemberState.php.

Referenced by hasSubmissionStarted(), and isFuture().

                                         : bool
    {
        return !$this->assignment->notStartedYet();
    }

Here is the caller graph for this function:

hasRequestedIndividualDeadline()

ilExcAssMemberState::hasRequestedIndividualDeadline

(

)

Definition at line 610 of file class.ilExcAssMemberState.php.

                                                    : bool
    {
        return $this->idl->getRequested();
    }

hasSubmissionEnded()

ilExcAssMemberState::hasSubmissionEnded

(

)

Definition at line 530 of file class.ilExcAssMemberState.php.

References getEffectiveDeadline().

Referenced by hasEnded(), and isSubmissionAllowed().

                                        : bool
    {
        if ($this->getEffectiveDeadline() == 0) {
            return false;
        }

        if ($this->time > $this->getEffectiveDeadline()) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasSubmissionEndedForAllUsers()

ilExcAssMemberState::hasSubmissionEndedForAllUsers

(

)

Definition at line 561 of file class.ilExcAssMemberState.php.

References getEffectiveDeadline().

Referenced by isGlobalFeedbackFileAccessible(), and isPeerReviewAllowed().

                                                   : bool
    {
        $global_subm_end = max($this->getEffectiveDeadline(), $this->assignment->getLastPersonalDeadline());

        if ($global_subm_end == 0) {
            return false;
        }

        if ($this->time > $global_subm_end) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasSubmissionStarted()

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 509 of file class.ilExcAssMemberState.php.

References ilExAssignment\DEADLINE_ABSOLUTE, ilExAssignment\DEADLINE_ABSOLUTE_INDIVIDUAL, ilExAssignment\DEADLINE_RELATIVE, getIndividualStart(), and hasGenerallyStarted().

Referenced by areInstructionsVisible(), ilExAssignmentInfo\getScheduleInfo(), and isSubmissionAllowed().

                                          : bool
    {
        $deadline_type_specific_started = false;
        switch ($this->assignment->getDeadlineMode()) {
            case ilExAssignment::DEADLINE_ABSOLUTE:
                $deadline_type_specific_started = true;
                break;
            case ilExAssignment::DEADLINE_RELATIVE:
                $deadline_type_specific_started = ($this->getIndividualStart() > 0);
                break;
            case ilExAssignment::DEADLINE_ABSOLUTE_INDIVIDUAL:
                $deadline_type_specific_started = ($this->idl->getIndividualDeadline() > 0);
                break;
        }
        if ($deadline_type_specific_started && $this->hasGenerallyStarted()) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

inLateSubmissionPhase()

ilExcAssMemberState::inLateSubmissionPhase

(

)

Definition at line 492 of file class.ilExcAssMemberState.php.

References getOfficialDeadline(), and isSubmissionAllowed().

Referenced by ilExAssignmentInfo\getScheduleInfo().

                                           : bool
    {
        // official deadline is done, but submission still allowed
        if ($this->getOfficialDeadline() &&
            $this->getOfficialDeadline() < $this->time &&
            $this->isSubmissionAllowed()) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isFuture()

ilExcAssMemberState::isFuture

(

)

Definition at line 555 of file class.ilExcAssMemberState.php.

References hasGenerallyStarted().

                              : bool
    {
        return !$this->hasGenerallyStarted();
    }

Here is the call graph for this function:

isGlobalFeedbackFileAccessible()

ilExcAssMemberState::isGlobalFeedbackFileAccessible

(

ilExSubmission

$submission

)

Definition at line 584 of file class.ilExcAssMemberState.php.

References ilExAssignment\FEEDBACK_DATE_CUSTOM, ilExAssignment\FEEDBACK_DATE_DEADLINE, hasSubmissionEndedForAllUsers(), and ilExSubmission\hasSubmitted().

                                                                              : bool
    {
        if (!$this->assignment->getFeedbackFile()) {
            return false;
        }

        // global feedback / sample solution
        if ($this->assignment->getFeedbackDate() == ilExAssignment::FEEDBACK_DATE_DEADLINE) {
            $access = $this->hasSubmissionEndedForAllUsers();
        } elseif ($this->assignment->getFeedbackDate() == ilExAssignment::FEEDBACK_DATE_CUSTOM) {
            $access = $this->assignment->afterCustomDate();
        } else {
            $access = $submission->hasSubmitted();
        }

        return $access;
    }

Here is the call graph for this function:

isPeerReviewAllowed()

ilExcAssMemberState::isPeerReviewAllowed

(

)

Definition at line 446 of file class.ilExcAssMemberState.php.

References $time, getPeerReviewDeadline(), and hasSubmissionEndedForAllUsers().

Referenced by isReceivedFeedbackAccessible().

                                         : bool
    {
        if ($this->assignment->getPeerReview() && $this->hasSubmissionEndedForAllUsers()
            && ($this->getPeerReviewDeadline() == 0 || $this->getPeerReviewDeadline() > $this->time)) {
            return true;
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isReceivedFeedbackAccessible()

ilExcAssMemberState::isReceivedFeedbackAccessible

(

)

Definition at line 456 of file class.ilExcAssMemberState.php.

References ILIAS\Repository\int(), and isPeerReviewAllowed().

                                                  : bool
    {
        if (!$this->isPeerReviewAllowed()) {
            return false;
        }
        $submission = new ilExSubmission($this->assignment, $this->user_id);
        $nr_missing_fb = (int) $submission->getPeerReview()?->getNumberOfMissingFeedbacksForReceived();
        if ((!$this->assignment->getPeerReviewDeadline() ||
            $this->assignment->getPeerReviewDeadline() < time())) {

            if ($nr_missing_fb <= 0) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

isSubmissionAllowed()

ilExcAssMemberState::isSubmissionAllowed

(

)

Definition at line 575 of file class.ilExcAssMemberState.php.

References hasSubmissionEnded(), and hasSubmissionStarted().

Referenced by inLateSubmissionPhase().

                                         : bool
    {
        if ($this->hasSubmissionStarted() && !$this->hasSubmissionEnded()) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

needsIndividualDeadline()

ilExcAssMemberState::needsIndividualDeadline

(

)

Definition at line 602 of file class.ilExcAssMemberState.php.

References ilExAssignment\DEADLINE_ABSOLUTE_INDIVIDUAL.

                                             : bool
    {
        if ($this->assignment->getDeadlineMode() === ilExAssignment::DEADLINE_ABSOLUTE_INDIVIDUAL && $this->idl->getIndividualDeadline() === 0) {
            return true;
        }
        return false;
    }

Field Documentation

$ass_id

int ilExcAssMemberState::$ass_id

protected

Definition at line 48 of file class.ilExcAssMemberState.php.

$assignment

ilExAssignment ilExcAssMemberState::$assignment

protected

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

$idl

ilExcIndividualDeadline ilExcAssMemberState::$idl

protected

Definition at line 61 of file class.ilExcAssMemberState.php.

Referenced by getIndividualDeadlineObject().

$is_team

bool ilExcAssMemberState::$is_team = false

protected

Definition at line 60 of file class.ilExcAssMemberState.php.

$lng

ilLanguage ilExcAssMemberState::$lng

protected

Definition at line 52 of file class.ilExcAssMemberState.php.

Referenced by __construct(), getInstance(), getPeerReviewLeadText(), getRemainingPeerReviewPresentation(), getRemainingTimeLeadText(), getRemainingTimePresentation(), and getRemainingTimePresentationOfLastSubmissionOfRelativeDeadline().

$member_id

int ilExcAssMemberState::$member_id

protected

either user id or team id, if this is a team assignment and the user is member of a team, in this case is_team is true

Definition at line 58 of file class.ilExcAssMemberState.php.

$team_id

int ilExcAssMemberState::$team_id = 0

protected

Definition at line 59 of file class.ilExcAssMemberState.php.

$time

int ilExcAssMemberState::$time

protected

Definition at line 51 of file class.ilExcAssMemberState.php.

Referenced by hasEnded(), and isPeerReviewAllowed().

$user_id

int ilExcAssMemberState::$user_id

protected

Definition at line 49 of file class.ilExcAssMemberState.php.

---

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

• components/ILIAS/Exercise/AssMemberState/classes/class.ilExcAssMemberState.php