Manages random mandatory assignments of an exercise. More...

Collaboration diagram for ilExcRandomAssignmentManager:

Public Member Functions
	__construct (ilObjExercise $exc, ilExcRandomAssignmentDBRepository $rand_ass_repo, ilObjUser $user=null, ilLanguage $lng=null)
	Constructor. More...

	canBeDeactivated ()
	Checks if the random assignment can be activated (if no learner has already submitted stuff) More...

	getDeniedDeactivationReasons ()
	Get reasons for denied deactivation. More...

	isActivated ()
	Is random assignment activated? More...

	getTotalNumberOfAssignments ()
	Get total number of assignments. More...

	getNumberOfMandatoryAssignments ()
	Get total number of mandatory assignments. More...

	needsStart ()
	Needs current user to start the exercise (by selecting the random assignments)? More...

	getMandatoryAssignmentsOfUser ($user_id)
	Get mandatory assignments of user. More...

	startExercise ()
	Start exercise. More...

	isAssignmentVisible (int $ass_id, int $user_id)
	Is assignment visible for user. More...

Data Fields
const	DENIED_SUBMISSIONS = "has_submissions"

const	DENIED_PEER_REVIEWS = "has_peer_reviews"

const	DENIED_TEAM_ASSIGNMENTS = "has_team_assignments"

Protected Member Functions
	getAssignmentSelection ()
	Get random assignment selection. More...

Protected Attributes
	$exc

	$exc_id

	$user

	$rand_ass_repo

	$lng

	$submission_repo

Detailed Description

Manages random mandatory assignments of an exercise.

(business logic)

Author: killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 12 of file class.ilExcRandomAssignmentManager.php.

Constructor & Destructor Documentation

◆ __construct()

ilExcRandomAssignmentManager::__construct	(	ilObjExercise	$exc,
		ilExcRandomAssignmentDBRepository	$rand_ass_repo,
		ilObjUser	$user = `null`,
		ilLanguage	$lng = `null`
	)

Constructor.

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

References $DIC, $exc, $lng, $rand_ass_repo, $user, ilExAssignment\getInstancesByExercise(), and user().

       {
         global $DIC;
 
         $this->exc = $exc;
         $this->exc_id = $this->exc->getId();
         $this->user = (is_null($user))
             ? $DIC->user()
             : $user;
         $this->rand_ass_repo = $rand_ass_repo;
         $this->lng = (is_null($lng))
             ? $DIC->language()
             : $lng;
 
         $this->submission_repo = new ilExcSubmissionRepository($DIC->database());
     }

Here is the call graph for this function:

Member Function Documentation

◆ canBeDeactivated()

ilExcRandomAssignmentManager::canBeDeactivated ( )

Checks if the random assignment can be activated (if no learner has already submitted stuff)

Returns: bool

Definition at line 126 of file class.ilExcRandomAssignmentManager.php.

     {
         return !$this->hasAnySubmission();
     }

◆ getAssignmentSelection()

ilExcRandomAssignmentManager::getAssignmentSelection ( )

protected

Get random assignment selection.

Definition at line 236 of file class.ilExcRandomAssignmentManager.php.

References $i, ilExAssignment\getInstancesByExercise(), and getNumberOfMandatoryAssignments().

Referenced by startExercise().

     {
         $ass_ids = array_map(function ($i) {
             return $i->getId();
         }, ilExAssignment::getInstancesByExercise($this->exc_id));
 
         $selected = [];
         for ($i = 0; $i < $this->getNumberOfMandatoryAssignments(); $i++) {
             $j = rand(0, count($ass_ids) - 1);
             $selected[] = current(array_splice($ass_ids, $j, 1));
         }
 
         return $selected;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDeniedDeactivationReasons()

ilExcRandomAssignmentManager::getDeniedDeactivationReasons ( )

Get reasons for denied deactivation.

Returns: string[]

Definition at line 136 of file class.ilExcRandomAssignmentManager.php.

References $lng.

     {
         $lng = $this->lng;
         $lng->loadLanguageModule("exc");
         $reasons = [];
         if ($this->hasAnySubmission()) {
             $reasons[self::DENIED_SUBMISSIONS] = $lng->txt("exc_denied_has_submissions");
         }
         return $reasons;
     }

◆ getMandatoryAssignmentsOfUser()

ilExcRandomAssignmentManager::getMandatoryAssignmentsOfUser ( $user_id )

Get mandatory assignments of user.

Parameters

int $user_id

Returns: int[] assignment ids

Definition at line 213 of file class.ilExcRandomAssignmentManager.php.

Referenced by isAssignmentVisible().

     {
         return $this->rand_ass_repo->getAssignmentsOfUser($user_id, $this->exc_id);
     }

Here is the caller graph for this function:

◆ getNumberOfMandatoryAssignments()

ilExcRandomAssignmentManager::getNumberOfMandatoryAssignments ( )

Get total number of mandatory assignments.

Returns: int

Definition at line 172 of file class.ilExcRandomAssignmentManager.php.

References ilExAssignment\getInstancesByExercise().

Referenced by getAssignmentSelection().

     {
         return $this->exc->getNrMandatoryRandom();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTotalNumberOfAssignments()

ilExcRandomAssignmentManager::getTotalNumberOfAssignments ( )

Get total number of assignments.

Returns: int

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

References ilExAssignment\getInstancesByExercise().

     {
         return count(ilExAssignment::getInstancesByExercise($this->exc_id));
     }

Here is the call graph for this function:

◆ isActivated()

ilExcRandomAssignmentManager::isActivated ( )

Is random assignment activated?

Returns: bool

Definition at line 152 of file class.ilExcRandomAssignmentManager.php.

References ilObjExercise\PASS_MODE_RANDOM.

Referenced by isAssignmentVisible(), and needsStart().

     {
         return ($this->exc->getPassMode() == ilObjExercise::PASS_MODE_RANDOM);
     }

Here is the caller graph for this function:

◆ isAssignmentVisible()

ilExcRandomAssignmentManager::isAssignmentVisible	(	int	$ass_id,
		int	$user_id
	)

Is assignment visible for user.

Parameters

int	$ass_id
int	$user_id

Returns: bool

Definition at line 258 of file class.ilExcRandomAssignmentManager.php.

References getMandatoryAssignmentsOfUser(), and isActivated().

     {
         if ($this->isActivated() && !in_array($ass_id, $this->getMandatoryAssignmentsOfUser($user_id))) {
             return false;
         }
         return true;
     }

Here is the call graph for this function:

◆ needsStart()

ilExcRandomAssignmentManager::needsStart ( )

Needs current user to start the exercise (by selecting the random assignments)?

Returns: bool

Definition at line 196 of file class.ilExcRandomAssignmentManager.php.

References $exc_id, isActivated(), and user().

Referenced by startExercise().

     {
         if ($this->isActivated()) {
             $ass_of_user = $this->rand_ass_repo->getAssignmentsOfUser($this->user->getId(), $this->exc_id);
             if (count($ass_of_user) == 0) {
                 return true;
             }
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ startExercise()

ilExcRandomAssignmentManager::startExercise ( )

Start exercise.

Definition at line 222 of file class.ilExcRandomAssignmentManager.php.

References $exc_id, getAssignmentSelection(), needsStart(), and user().

     {
         if ($this->needsStart()) {
             $this->rand_ass_repo->saveAssignmentsOfUser(
                 $this->user->getId(),
                 $this->exc_id,
                 $this->getAssignmentSelection()
             );
         }
     }