Re-assign users (according to restart-date). More...

Inheritance diagram for ilPrgRestartAssignmentsCronJob:

Collaboration diagram for ilPrgRestartAssignmentsCronJob:

Public Member Functions
	__construct ()

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	getId ()
	Get id. More...

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

	run ()

Public Member Functions inherited from ilCronJob
	isActive ($a_ts_last_run, $a_schedule_type, $a_schedule_value, $a_manual=false)
	Is job currently active? More...

	getScheduleType ()
	Get current schedule type (if flexible) More...

	getScheduleValue ()
	Get current schedule value (if flexible) More...

	setSchedule ($a_type, $a_value)
	Update current schedule (if flexible) More...

	getAllScheduleTypes ()
	Get all available schedule types. More...

	getScheduleTypesWithValues ()

	getValidScheduleTypes ()
	Returns a collection of all valid schedule types for a specific job. More...

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	isManuallyExecutable ()
	Defines whether or not a cron job can be started manually. More...

	hasCustomSettings ()
	Has cron job any custom setting which can be edited? More...

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	Add custom settings to form. More...

	saveCustomSettings (ilPropertyFormGUI $a_form)
	Save custom settings. More...

	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	Add external settings to form. More...

	activationWasToggled ($a_currently_active)
	Cron job status was changed. More...

	getId ()
	Get id. More...

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

	run ()
	Run job. More...

Data Fields
const	ID = 'prg_restart_assignments_temporal_progress'

const	ACTING_USR_ID = -1

Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1

const	SCHEDULE_TYPE_IN_MINUTES = 2

const	SCHEDULE_TYPE_IN_HOURS = 3

const	SCHEDULE_TYPE_IN_DAYS = 4

const	SCHEDULE_TYPE_WEEKLY = 5

const	SCHEDULE_TYPE_MONTHLY = 6

const	SCHEDULE_TYPE_QUARTERLY = 7

const	SCHEDULE_TYPE_YEARLY = 8

Protected Member Functions
	getNow ()

	getSettingsRepository ()

	getProgressRepository ()

	getAssignmentRepository ()

	getEvents ()

	log (string $msg)

Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Protected Attributes
	$user_assignments_db

	$log

	$lng

Detailed Description

Re-assign users (according to restart-date).

This will result in a new/additional assignment

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

Constructor & Destructor Documentation

◆ __construct()

ilPrgRestartAssignmentsCronJob::__construct ( )

Definition at line 32 of file class.ilPrgRestartAssignmentsCronJob.php.

References $DIC, ilStudyProgrammeDIC\dic(), and log().

     {
         global $DIC;
         $this->log = $DIC['ilLog'];
         $this->lng = $DIC['lng'];
         $this->lng->loadLanguageModule('prg');
 
         $this->dic = ilStudyProgrammeDIC::dic();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getAssignmentRepository()

ilPrgRestartAssignmentsCronJob::getAssignmentRepository ( )

protected

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

Referenced by run().

                                                  : ilStudyProgrammeAssignmentDBRepository
     {
         return $this->dic['ilStudyProgrammeUserAssignmentDB'];
     }

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ilPrgRestartAssignmentsCronJob::getDefaultScheduleType ( )

Get schedule type.

Returns: int

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

     {
         return self::SCHEDULE_TYPE_IN_DAYS;
     }

◆ getDefaultScheduleValue()

ilPrgRestartAssignmentsCronJob::getDefaultScheduleValue ( )

Get schedule value.

Returns: int|array

Definition at line 107 of file class.ilPrgRestartAssignmentsCronJob.php.

     {
         return 1;
     }

◆ getDescription()

ilPrgRestartAssignmentsCronJob::getDescription ( )

Get description.

Returns: string

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

     {
         return $this->lng->txt('prg_restart_assignments_temporal_progress_desc');
     }

◆ getEvents()

ilPrgRestartAssignmentsCronJob::getEvents ( )

protected

Definition at line 203 of file class.ilPrgRestartAssignmentsCronJob.php.

Referenced by run().

     {
         return $this->dic['ilStudyProgrammeEvents'];
     }

Here is the caller graph for this function:

◆ getId()

ilPrgRestartAssignmentsCronJob::getId ( )

Get id.

Returns: string

Definition at line 67 of file class.ilPrgRestartAssignmentsCronJob.php.

     {
         return self::ID;
     }

◆ getNow()

ilPrgRestartAssignmentsCronJob::getNow ( )

protected

Definition at line 183 of file class.ilPrgRestartAssignmentsCronJob.php.

Referenced by run().

                                 : \DateTimeImmutable
     {
         return new DateTimeImmutable();
     }

Here is the caller graph for this function:

◆ getProgressRepository()

ilPrgRestartAssignmentsCronJob::getProgressRepository ( )

protected

Definition at line 193 of file class.ilPrgRestartAssignmentsCronJob.php.

Referenced by run().

                                                : ilStudyProgrammeProgressDBRepository
     {
         return $this->dic['ilStudyProgrammeUserProgressDB'];
     }

Here is the caller graph for this function:

◆ getSettingsRepository()

ilPrgRestartAssignmentsCronJob::getSettingsRepository ( )

protected

Definition at line 188 of file class.ilPrgRestartAssignmentsCronJob.php.

Referenced by run().

                                                : ilStudyProgrammeSettingsDBRepository
     {
         return $this->dic['model.Settings.ilStudyProgrammeSettingsRepository'];
     }

Here is the caller graph for this function:

◆ getTitle()

ilPrgRestartAssignmentsCronJob::getTitle ( )

Get title.

Returns: string

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

     {
         return $this->lng->txt('prg_restart_assignments_temporal_progress_title');
     }

◆ hasAutoActivation()

ilPrgRestartAssignmentsCronJob::hasAutoActivation ( )

Is to be activated on "installation".

Returns: boolean

Definition at line 77 of file class.ilPrgRestartAssignmentsCronJob.php.

     {
         return true;
     }

◆ hasFlexibleSchedule()

ilPrgRestartAssignmentsCronJob::hasFlexibleSchedule ( )

Can the schedule be configured?

Returns: boolean

Definition at line 87 of file class.ilPrgRestartAssignmentsCronJob.php.

     {
         return true;
     }

◆ log()

ilPrgRestartAssignmentsCronJob::log ( string $msg )

protected

Definition at line 208 of file class.ilPrgRestartAssignmentsCronJob.php.

Referenced by __construct(), and run().

                                         : void
     {
         $this->log->write($msg);
     }

Here is the caller graph for this function:

◆ run()

ilPrgRestartAssignmentsCronJob::run ( )

Returns: ilCronJobResult

Definition at line 115 of file class.ilPrgRestartAssignmentsCronJob.php.

References $result, getAssignmentRepository(), getEvents(), ilObjStudyProgramme\getInstanceByObjId(), getNow(), getProgressRepository(), getSettingsRepository(), log(), ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

     {
         $result = new ilCronJobResult();
         $result->setStatus(ilCronJobResult::STATUS_NO_ACTION);
 
         $programmes_to_reassign = $this->getSettingsRepository()
             ->getProgrammeIdsWithReassignmentForExpiringValidity();
 
         if (count($programmes_to_reassign) == 0) {
             return $result;
         }
 
         $today = $this->getNow();
         $programmes_and_due = [];
 
         foreach ($programmes_to_reassign as $programme_obj_id => $days_offset) {
             $interval = new DateInterval('P' . $days_offset . 'D');
             $due = $today->add($interval);
             $programmes_and_due[$programme_obj_id] = $due;
         }
 
         //TODO: expire for assignment, not progress!!!
         $progresses = $this->getProgressRepository()
             ->getAboutToExpire($programmes_and_due, false);
 
         if (count($progresses) == 0) {
             return $result;
         }
     
         $events = $this->getEvents();
         $assignment_repo = $this->getAssignmentRepository();
         foreach ($progresses as $progress) {
             $ass = $assignment_repo->get($progress->getAssignmentId());
             if ($ass->getRestartedAssignmentId() < 0) {
                 if ($ass->getRootId() != $progress->getNodeId()) {
                     $this->log(
                         sprintf(
                             'PRG, RestartAssignments: progress %s is not root of assignment %s. skipping.',
                             $progress->getId(),
                             $ass->getId()
                         )
                     );
                     continue;
                 }
 
                 $this->log(
                     sprintf(
                         'PRG, RestartAssignments: user %s\'s assignment %s is being restarted (Programme %s)',
                         $progress->getUserId(),
                         $ass->getId(),
                         $progress->getNodeId()
                     )
                 );
             
                 $prg = ilObjStudyProgramme::getInstanceByObjId($ass->getRootId());
                 $restarted = $prg->assignUser($ass->getUserId(), self::ACTING_USR_ID);
                 $ass = $ass->withRestarted($restarted->getId(), $today);
                
                 $assignment_repo->update($ass);
 
                 $events->userReAssigned($restarted);
                 $result->setStatus(ilCronJobResult::STATUS_OK);
             }
         }
 
         return $result;
     }