Collaboration diagram for ilStudyProgrammeAutoMailSettings:

Public Member Functions
	__construct (bool $send_re_assigned_mail, ?int $reminder_not_restarted_by_user_days, ?int $processing_ends_not_successful_days)

	getSendReAssignedMail ()

	getReminderNotRestartedByUserDays ()

	getProcessingEndsNotSuccessfulDays ()

	withSendReAssignedMail (bool $do_it)

	withReminderNotRestartedByUserDays (?int $days)

	withProcessingEndsNotSuccessfulDays (?int $days)

	toFormInput (Field\Factory $input, \ilLanguage $ilLng, Refinery $refinery)

Protected Attributes
	$send_re_assigned_mail

	$reminder_not_restarted_by_user_days

	$processing_ends_not_successful_days

Detailed Description

Definition at line 10 of file class.ilStudyProgrammeAutoMailSettings.php.

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeAutoMailSettings::__construct	(	bool	$send_re_assigned_mail,
		?int	$reminder_not_restarted_by_user_days,
		?int	$processing_ends_not_successful_days
	)

Definition at line 27 of file class.ilStudyProgrammeAutoMailSettings.php.

References $processing_ends_not_successful_days, $reminder_not_restarted_by_user_days, and $send_re_assigned_mail.

       {
         if (
             !is_null($reminder_not_restarted_by_user_days) &&
             1 > $reminder_not_restarted_by_user_days
         ) {
             throw new InvalidArgumentException(
                 'Numbers less than 1 are not allowed'
             );
         }
 
         if (
             !is_null($processing_ends_not_successful_days) &&
             1 > $processing_ends_not_successful_days
         ) {
             throw new InvalidArgumentException(
                 'Numbers less than 1 are not allowed'
             );
         }
 
         $this->send_re_assigned_mail = $send_re_assigned_mail;
         $this->reminder_not_restarted_by_user_days = $reminder_not_restarted_by_user_days;
         $this->processing_ends_not_successful_days = $processing_ends_not_successful_days;
     }

Member Function Documentation

◆ getProcessingEndsNotSuccessfulDays()

ilStudyProgrammeAutoMailSettings::getProcessingEndsNotSuccessfulDays ( )

Definition at line 65 of file class.ilStudyProgrammeAutoMailSettings.php.

References $processing_ends_not_successful_days.

Referenced by toFormInput().

                                                          : ?int
     {
         return $this->processing_ends_not_successful_days;
     }

Here is the caller graph for this function:

◆ getReminderNotRestartedByUserDays()

ilStudyProgrammeAutoMailSettings::getReminderNotRestartedByUserDays ( )

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

References $reminder_not_restarted_by_user_days.

Referenced by toFormInput().

                                                         : ?int
     {
         return $this->reminder_not_restarted_by_user_days;
     }

Here is the caller graph for this function:

◆ getSendReAssignedMail()

ilStudyProgrammeAutoMailSettings::getSendReAssignedMail ( )

Definition at line 55 of file class.ilStudyProgrammeAutoMailSettings.php.

References $send_re_assigned_mail.

Referenced by toFormInput().

                                             : bool
     {
         return $this->send_re_assigned_mail;
     }

Here is the caller graph for this function:

◆ toFormInput()

ilStudyProgrammeAutoMailSettings::toFormInput	(	Field\Factory	$input,
		\ilLanguage	$ilLng,
		Refinery	$refinery
	)

Definition at line 104 of file class.ilStudyProgrammeAutoMailSettings.php.

References getProcessingEndsNotSuccessfulDays(), getReminderNotRestartedByUserDays(), getSendReAssignedMail(), and ilLanguage\txt().

                                                                                               : Field\Input
     {
         return $input->section(
             [
                 "send_re_assigned_mail" => $input->checkbox(
                     $ilLng->txt("send_re_assigned_mail"),
                     $ilLng->txt('send_re_assigned_mail_info')
                 )
                 ->withValue($this->getSendReAssignedMail()),
 
                 "prg_user_not_restarted_time_input" => $input->optionalGroup(
                     [$input->numeric(
                         $ilLng->txt('prg_user_not_restarted_time_input'),
                         $ilLng->txt('prg_user_not_restarted_time_input_info')
                     )->withAdditionalTransformation($refinery->int()->isGreaterThan(0))],
                     $ilLng->txt("send_info_to_re_assign_mail"),
                     $ilLng->txt("send_info_to_re_assign_mail_info")
                 )
                 ->withValue($this->getReminderNotRestartedByUserDays() !== null ? [$this->getReminderNotRestartedByUserDays()] : null),
 
                 "processing_ends_not_success" => $input->optionalGroup(
                     [$input->numeric(
                         $ilLng->txt('prg_processing_ends_no_success'),
                         $ilLng->txt('prg_processing_ends_no_success_info')
                     )->withAdditionalTransformation($refinery->int()->isGreaterThan(0))],
                     $ilLng->txt("send_risky_to_fail_mail"),
                     $ilLng->txt("send_risky_to_fail_mail_info")
                 )
                 ->withValue($this->getProcessingEndsNotSuccessfulDays() !== null ? [$this->getProcessingEndsNotSuccessfulDays()] : null)
             ],
             $ilLng->txt("prg_cron_job_configuration")
         )
         ->withAdditionalTransformation($refinery->custom()->transformation(function ($vals) {
             return new \ilStudyProgrammeAutoMailSettings(
                 $vals["send_re_assigned_mail"],
                 isset($vals["prg_user_not_restarted_time_input"]) ? (int) $vals["prg_user_not_restarted_time_input"][0] : null,
                 isset($vals["processing_ends_not_success"]) ? (int) $vals["processing_ends_not_success"][0] : null
             );
         }));
     }

Here is the call graph for this function:

◆ withProcessingEndsNotSuccessfulDays()

ilStudyProgrammeAutoMailSettings::withProcessingEndsNotSuccessfulDays ( ?int $days )

Definition at line 91 of file class.ilStudyProgrammeAutoMailSettings.php.

       : \ilStudyProgrammeAutoMailSettings {
         if (!is_null($days) && 1 > $days) {
             throw new InvalidArgumentException(
                 'Numbers less than 1 are not allowed'
             );
         }
         $clone = clone $this;
         $clone->processing_ends_not_successful_days = $days;
         return $clone;
     }

◆ withReminderNotRestartedByUserDays()

ilStudyProgrammeAutoMailSettings::withReminderNotRestartedByUserDays ( ?int $days )

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

       : \ilStudyProgrammeAutoMailSettings {
         if (!is_null($days) && 1 > $days) {
             throw new InvalidArgumentException(
                 'Numbers less than 1 are not allowed'
             );
         }
 
         $clone = clone $this;
         $clone->reminder_not_restarted_by_user_days = $days;
         return $clone;
     }

◆ withSendReAssignedMail()

ilStudyProgrammeAutoMailSettings::withSendReAssignedMail ( bool $do_it )

Definition at line 70 of file class.ilStudyProgrammeAutoMailSettings.php.

                                                         : \ilStudyProgrammeAutoMailSettings
     {
         $clone = clone $this;
         $clone->send_re_assigned_mail = $do_it;
         return $clone;
     }