Inheritance diagram for ILIAS\Test\Settings\MainSettings\SettingsFinishing:

Collaboration diagram for ILIAS\Test\Settings\MainSettings\SettingsFinishing:

Public Member Functions
	__construct (int $test_id, protected bool $show_answer_overview=false, protected bool $concluding_remarks_enabled=false, protected ?string $concluding_remarks_text='', protected ?int $concluding_remarks_page_id=null, protected int $redirection_mode=\ilObjTest::REDIRECT_NONE, protected ?string $redirection_url=null, protected int $mail_notification_content_type=0, protected bool $always_send_mail_notification=false)

	toForm (\ilLanguage $lng, FieldFactory $f, Refinery $refinery, ?array $environment=null)

	toStorage ()

	toLog (AdditionalInformationGenerator $additional_info)

	getShowAnswerOverview ()

	withShowAnswerOverview (bool $show_answer_overview)

	getConcludingRemarksEnabled ()

	withConcludingRemarksEnabled (bool $concluding_remarks_enabled)

	getConcludingRemarksText ()

	getConcludingRemarksPageId ()

	withConcludingRemarksPageId (?int $concluding_remarks_page_id)

	getRedirectionMode ()

	withRedirectionMode (int $redirection_mode)

	getRedirectionUrl ()

	withRedirectionUrl (?string $redirection_url)

	getMailNotificationContentType ()

	withMailNotificationContentType (int $mail_notification_content_type)

	getAlwaysSendMailNotification ()

	withAlwaysSendMailNotification (bool $always_send_mail_notification)

Public Member Functions inherited from ILIAS\Test\Settings\TestSettings
	__construct (int $test_id)

	getTestId ()

	withTestId (int $test_id)

	toForm (\ilLanguage $lng, FieldFactory $f, Refinery $refinery, ?array $environment=null)

	toStorage ()

	toLog (AdditionalInformationGenerator $additional_info)

Private Member Functions
	getRedirectionInputs (\ilLanguage $lng, FieldFactory $f, Refinery $refinery)

	getMailNotificationInputs (\ilLanguage $lng, FieldFactory $f, Refinery $refinery)

Additional Inherited Members
Protected Attributes inherited from ILIAS\Test\Settings\TestSettings
int	$test_id

Detailed Description

Definition at line 31 of file SettingsFinishing.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::__construct	(	int	$test_id,
		protected bool	$show_answer_overview = `false`,
		protected bool	$concluding_remarks_enabled = `false`,
		protected ?string	$concluding_remarks_text = `''`,
		protected ?int	$concluding_remarks_page_id = `null`,
		protected int	$redirection_mode = `\ilObjTest::REDIRECT_NONE`,
		protected ?string	$redirection_url = `null`,
		protected int	$mail_notification_content_type = `0`,
		protected bool	$always_send_mail_notification = `false`
	)

Definition at line 33 of file SettingsFinishing.php.

References ILIAS\GlobalScreen\Provider\__construct().

       {
         parent::__construct($test_id);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getAlwaysSendMailNotification()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::getAlwaysSendMailNotification ( )

Definition at line 318 of file SettingsFinishing.php.

Referenced by ilObjTest\addConcludingRemarksToSettingsFromImport(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\getMailNotificationInputs(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\toLog(), and ILIAS\Test\Settings\MainSettings\SettingsFinishing\toStorage().

                                                    : bool
     {
         return $this->always_send_mail_notification;
     }

Here is the caller graph for this function:

◆ getConcludingRemarksEnabled()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::getConcludingRemarksEnabled ( )

Definition at line 253 of file SettingsFinishing.php.

Referenced by ILIAS\Test\Settings\MainSettings\SettingsFinishing\toForm(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\toLog(), and ILIAS\Test\Settings\MainSettings\SettingsFinishing\toStorage().

                                                  : bool
     {
         return $this->concluding_remarks_enabled;
     }

Here is the caller graph for this function:

◆ getConcludingRemarksPageId()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::getConcludingRemarksPageId ( )

Definition at line 270 of file SettingsFinishing.php.

Referenced by ILIAS\Test\Settings\MainSettings\SettingsFinishing\toStorage().

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

Here is the caller graph for this function:

◆ getConcludingRemarksText()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::getConcludingRemarksText ( )

Definition at line 265 of file SettingsFinishing.php.

Referenced by ILIAS\Test\Settings\MainSettings\SettingsFinishing\toStorage().

                                               : string
     {
         return $this->concluding_remarks_text ?? '';
     }

Here is the caller graph for this function:

◆ getMailNotificationContentType()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::getMailNotificationContentType ( )

Definition at line 306 of file SettingsFinishing.php.

Referenced by ilObjTest\addConcludingRemarksToSettingsFromImport(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\getMailNotificationInputs(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\toLog(), and ILIAS\Test\Settings\MainSettings\SettingsFinishing\toStorage().

                                                     : int
     {
         return $this->mail_notification_content_type;
     }

Here is the caller graph for this function:

◆ getMailNotificationInputs()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::getMailNotificationInputs	(	\ilLanguage	$lng,
		FieldFactory	$f,
		Refinery	$refinery
	)

private

Definition at line 124 of file SettingsFinishing.php.

References ILIAS\Test\Settings\MainSettings\SettingsFinishing\getAlwaysSendMailNotification(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\getMailNotificationContentType(), null, ilLanguage\txt(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by ILIAS\Test\Settings\MainSettings\SettingsFinishing\toForm().

      : OptionalGroup {
         $notification_trafo = $refinery->custom()->transformation(
             static function (?array $v): array {
                 if ($v === null) {
                     return [
                         'notification_content_type' => 0,
                         'always_notify' => false
                     ];
                 }
 
                 return $v;
             }
         );
 
         $sub_inputs_finish_notification = [
             'notification_content_type' => $f->radio(
                 $lng->txt('tst_finish_notification_content_type')
             )->withOption(
                 '1',
                 $lng->txt('tst_finish_notification_simple')
             )->withOption(
                 '2',
                 $lng->txt('tst_finish_notification_advanced')
             )->withRequired(true)
             ->withValue('1')
             ->withAdditionalTransformation($refinery->kindlyTo()->int()),
             'always_notify' => $f->checkbox(
                 $lng->txt('mailnottype'),
                 $lng->txt('mailnottype_desc')
             )
         ];
 
         $mail_notification_inputs = $f->optionalGroup(
             $sub_inputs_finish_notification,
             $lng->txt('tst_finish_notification'),
             $lng->txt('tst_finish_notification_desc')
         )->withValue(null)
             ->withAdditionalTransformation($notification_trafo);
 
         if ($this->getMailNotificationContentType() === 0) {
             return $mail_notification_inputs;
         }
 
         return $mail_notification_inputs->withValue(
             [
                 'notification_content_type' => (string) $this->getMailNotificationContentType(),
                 'always_notify' => (bool) $this->getAlwaysSendMailNotification()
             ]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRedirectionInputs()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::getRedirectionInputs	(	\ilLanguage	$lng,
		FieldFactory	$f,
		Refinery	$refinery
	)

private

Definition at line 70 of file SettingsFinishing.php.

References ILIAS\Test\Settings\MainSettings\SettingsFinishing\getRedirectionMode(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\getRedirectionUrl(), null, ilObjTest\REDIRECT_ALWAYS, ilObjTest\REDIRECT_KIOSK, ilObjTest\REDIRECT_NONE, ilLanguage\txt(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by ILIAS\Test\Settings\MainSettings\SettingsFinishing\toForm().

      : OptionalGroup {
         $redirection_trafo = $refinery->custom()->transformation(
             static function (?array $v): array {
                 if ($v === null) {
                     return [
                         'redirect_mode' => \ilObjTest::REDIRECT_NONE,
                         'redirect_url' => ''
                     ];
                 }
 
                 return $v;
             }
         );
 
         $sub_inputs_redirect = [
             'redirect_mode' => $f->radio(
                 $lng->txt('redirect_after_finishing_rule')
             )->withOption(
                 (string) \ilObjTest::REDIRECT_ALWAYS,
                 $lng->txt('redirect_always')
             )->withOption(
                 (string) \ilObjTest::REDIRECT_KIOSK,
                 $lng->txt('redirect_in_kiosk_mode')
             )->withRequired(true)
             ->withAdditionalTransformation($refinery->kindlyTo()->int()),
             'redirect_url' => $f->text(
                 $lng->txt('redirection_url')
             )->withRequired(true)
             ->withAdditionalTransformation($refinery->string()->hasMaxLength(4000))
         ];
 
         $redirection_input = $f->optionalGroup(
             $sub_inputs_redirect,
             $lng->txt('redirect_after_finishing_tst'),
             $lng->txt('redirect_after_finishing_tst_desc')
         )->withValue(null)
             ->withAdditionalTransformation($redirection_trafo);
 
         if ($this->getRedirectionMode() === \ilObjTest::REDIRECT_NONE) {
             return $redirection_input;
         }
 
         return $redirection_input->withValue(
             [
                 'redirect_mode' => $this->getRedirectionMode(),
                 'redirect_url' => $this->getRedirectionUrl()
             ]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRedirectionMode()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::getRedirectionMode ( )

Definition at line 282 of file SettingsFinishing.php.

Referenced by ilObjTest\addConcludingRemarksToSettingsFromImport(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\getRedirectionInputs(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\toLog(), and ILIAS\Test\Settings\MainSettings\SettingsFinishing\toStorage().

                                         : int
     {
         return $this->redirection_mode;
     }

Here is the caller graph for this function:

◆ getRedirectionUrl()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::getRedirectionUrl ( )

Definition at line 294 of file SettingsFinishing.php.

Referenced by ilObjTest\addConcludingRemarksToSettingsFromImport(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\getRedirectionInputs(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\toLog(), and ILIAS\Test\Settings\MainSettings\SettingsFinishing\toStorage().

                                        : ?string
     {
         return $this->redirection_url;
     }

Here is the caller graph for this function:

◆ getShowAnswerOverview()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::getShowAnswerOverview ( )

Definition at line 241 of file SettingsFinishing.php.

Referenced by ilObjTest\addConcludingRemarksToSettingsFromImport(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\toForm(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\toLog(), and ILIAS\Test\Settings\MainSettings\SettingsFinishing\toStorage().

                                            : bool
     {
         return $this->show_answer_overview;
     }

Here is the caller graph for this function:

◆ toForm()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::toForm	(	\ilLanguage	$lng,
		FieldFactory	$f,
		Refinery	$refinery,
		?array	$environment = `null`
	)

Definition at line 47 of file SettingsFinishing.php.

References ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\Test\Settings\MainSettings\SettingsFinishing\getConcludingRemarksEnabled(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\getMailNotificationInputs(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\getRedirectionInputs(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\getShowAnswerOverview(), ilLanguage\txt(), and ILIAS\UI\Implementation\Component\Input\withValue().

      : FormInput {
         $inputs['show_answer_overview'] = $f->checkbox(
             $lng->txt('enable_examview'),
             $lng->txt('enable_examview_desc')
         )->withValue($this->getShowAnswerOverview());
 
         $inputs['show_concluding_remarks'] = $f->checkbox(
             $lng->txt('final_statement'),
             $lng->txt('final_statement_show_desc')
         )->withValue((bool) $this->getConcludingRemarksEnabled());
 
         $inputs['redirect_after_finish'] = $this->getRedirectionInputs($lng, $f, $refinery);
 
         $inputs['finish_notification'] = $this->getMailNotificationInputs($lng, $f, $refinery);
 
         return $f->section($inputs, $lng->txt('tst_final_information'));
     }

Here is the call graph for this function:

◆ toLog()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::toLog ( AdditionalInformationGenerator $additional_info )

Definition at line 193 of file SettingsFinishing.php.

                                                                           : array
     {
         $log_array = [
             AdditionalInformationGenerator::KEY_TEST_ANSWER_OVERVIEW_ENABLED => $additional_info
                 ->getEnabledDisabledTagForBool($this->getShowAnswerOverview()),
             AdditionalInformationGenerator::KEY_TEST_CONCLUDING_REMARKS_ENABLED => $additional_info
                 ->getEnabledDisabledTagForBool($this->getConcludingRemarksEnabled()),
             AdditionalInformationGenerator::KEY_TEST_REDIRECT_URL => $this->getRedirectionUrl(),
 
         ];
 
         switch ($this->getRedirectionMode()) {
             case \ilObjTest::REDIRECT_NONE:
                 $log_array[AdditionalInformationGenerator::KEY_TEST_REDIRECT_MODE] = $additional_info
                     ->getNoneTag();
                 break;
             case \ilObjTest::REDIRECT_ALWAYS:
                 $log_array[AdditionalInformationGenerator::KEY_TEST_REDIRECT_MODE] = $additional_info
                     ->getTagForLangVar('redirect_always');
                 break;
             case \ilObjTest::REDIRECT_KIOSK:
                 $log_array[AdditionalInformationGenerator::KEY_TEST_REDIRECT_MODE] = $additional_info
                     ->getTagForLangVar('redirect_in_kiosk_mode');
                 break;
         }
 
         switch ($this->getMailNotificationContentType()) {
             case 0:
                 $log_array[AdditionalInformationGenerator::KEY_TEST_MAIL_NOTIFICATION_CONTENT_TYPE] = $additional_info
                     ->getNoneTag();
                 break;
             case 1:
                 $log_array[AdditionalInformationGenerator::KEY_TEST_MAIL_NOTIFICATION_CONTENT_TYPE] = $additional_info
                     ->getTagForLangVar('tst_finish_notification_simple');
                 $log_array[AdditionalInformationGenerator::KEY_TEST_ALWAYS_SEND_NOTIFICATION] = $additional_info
                     ->getEnabledDisabledTagForBool($this->getAlwaysSendMailNotification());
                 break;
             case 2:
                 $log_array[AdditionalInformationGenerator::KEY_TEST_MAIL_NOTIFICATION_CONTENT_TYPE] = $additional_info
                     ->getTagForLangVar('tst_finish_notification_advanced');
                 $log_array[AdditionalInformationGenerator::KEY_TEST_ALWAYS_SEND_NOTIFICATION] = $additional_info
                     ->getEnabledDisabledTagForBool($this->getAlwaysSendMailNotification());
                 break;
         }
 
         return $log_array;
     }

Here is the call graph for this function:

◆ toStorage()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::toStorage ( )

Definition at line 179 of file SettingsFinishing.php.

References ILIAS\Test\Settings\MainSettings\SettingsFinishing\getAlwaysSendMailNotification(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\getConcludingRemarksEnabled(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\getConcludingRemarksPageId(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\getConcludingRemarksText(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\getMailNotificationContentType(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\getRedirectionMode(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\getRedirectionUrl(), ILIAS\Test\Settings\MainSettings\SettingsFinishing\getShowAnswerOverview(), and ILIAS\Repository\int().

                                : array
     {
         return [
             'enable_examview' => ['integer', (int) $this->getShowAnswerOverview()],
             'showfinalstatement' => ['integer', (int) $this->getConcludingRemarksEnabled()],
             'finalstatement' => ['text', $this->getConcludingRemarksText()],
             'concluding_remarks_page_id' => ['integer', $this->getConcludingRemarksPageId()],
             'redirection_mode' => ['integer', $this->getRedirectionMode()],
             'redirection_url' => ['text', $this->getRedirectionUrl()],
             'mailnotification' => ['integer', $this->getMailNotificationContentType()],
             'mailnottype' => ['integer', (int) $this->getAlwaysSendMailNotification()]
         ];
     }

Here is the call graph for this function:

◆ withAlwaysSendMailNotification()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::withAlwaysSendMailNotification ( bool $always_send_mail_notification )

Definition at line 323 of file SettingsFinishing.php.

                                                                                        : self
     {
         $clone = clone $this;
         $clone->always_send_mail_notification = $always_send_mail_notification;
         return $clone;
     }

◆ withConcludingRemarksEnabled()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::withConcludingRemarksEnabled ( bool $concluding_remarks_enabled )

Definition at line 258 of file SettingsFinishing.php.

                                                                                   : self
     {
         $clone = clone $this;
         $clone->concluding_remarks_enabled = $concluding_remarks_enabled;
         return $clone;
     }

◆ withConcludingRemarksPageId()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::withConcludingRemarksPageId ( ?int $concluding_remarks_page_id )

Definition at line 275 of file SettingsFinishing.php.

Referenced by ilObjTest\addConcludingRemarksToSettingsFromImport().

                                                                                  : self
     {
         $clone = clone $this;
         $clone->concluding_remarks_page_id = $concluding_remarks_page_id;
         return $clone;
     }

Here is the caller graph for this function:

◆ withMailNotificationContentType()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::withMailNotificationContentType ( int $mail_notification_content_type )

Definition at line 311 of file SettingsFinishing.php.

                                                                                         : self
     {
         $clone = clone $this;
         $clone->mail_notification_content_type = $mail_notification_content_type;
         return $clone;
     }

◆ withRedirectionMode()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::withRedirectionMode ( int $redirection_mode )

Definition at line 287 of file SettingsFinishing.php.

                                                               : self
     {
         $clone = clone $this;
         $clone->redirection_mode = $redirection_mode;
         return $clone;
     }

◆ withRedirectionUrl()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::withRedirectionUrl ( ?string $redirection_url )

Definition at line 299 of file SettingsFinishing.php.

                                                                 : self
     {
         $clone = clone $this;
         $clone->redirection_url = $redirection_url;
         return $clone;
     }

◆ withShowAnswerOverview()

ILIAS\Test\Settings\MainSettings\SettingsFinishing::withShowAnswerOverview ( bool $show_answer_overview )

Definition at line 246 of file SettingsFinishing.php.

Referenced by ILIAS\Test\Settings\MainSettings\SettingsMainGUI\getFinishingSettingsForStorage().

                                                                       : self
     {
         $clone = clone $this;
         $clone->show_answer_overview = $show_answer_overview;
         return $clone;
     }

Here is the caller graph for this function:

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

components/ILIAS/Test/src/Settings/MainSettings/SettingsFinishing.php

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAlwaysSendMailNotification()

◆ getConcludingRemarksEnabled()

◆ getConcludingRemarksPageId()

◆ getConcludingRemarksText()

◆ getMailNotificationContentType()

◆ getMailNotificationInputs()

◆ getRedirectionInputs()

◆ getRedirectionMode()

◆ getRedirectionUrl()

◆ getShowAnswerOverview()

◆ toForm()

◆ toLog()

◆ toStorage()

◆ withAlwaysSendMailNotification()

◆ withConcludingRemarksEnabled()

◆ withConcludingRemarksPageId()

◆ withMailNotificationContentType()

◆ withRedirectionMode()

◆ withRedirectionUrl()

◆ withShowAnswerOverview()