ilObjTestSettingsFinishing Class Reference

Inheritance diagram for ilObjTestSettingsFinishing:

Collaboration diagram for ilObjTestSettingsFinishing:

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 ()
	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 TestSettings
	__construct (int $test_id)
	getTestId ()
	withTestId (int $test_id)
	toForm (\ilLanguage $lng, FieldFactory $f, Refinery $refinery, array $environment=null)
	toStorage ()

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

Additional Inherited Members
Protected Attributes inherited from TestSettings
int	$test_id

Detailed Description

Definition at line 26 of file ilObjTestSettingsFinishing.php.

Constructor & Destructor Documentation

__construct()

ilObjTestSettingsFinishing::__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 28 of file ilObjTestSettingsFinishing.php.

References ILIAS\MetaData\Repository\Validation\Data\__construct().

      {
        parent::__construct($test_id);
    }

Here is the call graph for this function:

Member Function Documentation

getAlwaysSendMailNotification()

ilObjTestSettingsFinishing::getAlwaysSendMailNotification

(

)

Definition at line 265 of file ilObjTestSettingsFinishing.php.

Referenced by ilObjTest\addConcludingRemarksToSettingsFromImport(), getMailNotificationInputs(), and toStorage().

                                                   : bool
    {
        return $this->always_send_mail_notification;
    }

Here is the caller graph for this function:

getConcludingRemarksEnabled()

ilObjTestSettingsFinishing::getConcludingRemarksEnabled

(

)

Definition at line 200 of file ilObjTestSettingsFinishing.php.

Referenced by toForm(), and toStorage().

                                                 : bool
    {
        return $this->concluding_remarks_enabled;
    }

Here is the caller graph for this function:

getConcludingRemarksPageId()

ilObjTestSettingsFinishing::getConcludingRemarksPageId

(

)

Definition at line 217 of file ilObjTestSettingsFinishing.php.

Referenced by toStorage().

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

Here is the caller graph for this function:

getConcludingRemarksText()

ilObjTestSettingsFinishing::getConcludingRemarksText

(

)

Definition at line 212 of file ilObjTestSettingsFinishing.php.

Referenced by toStorage().

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

Here is the caller graph for this function:

getMailNotificationContentType()

ilObjTestSettingsFinishing::getMailNotificationContentType

(

)

Definition at line 253 of file ilObjTestSettingsFinishing.php.

Referenced by ilObjTest\addConcludingRemarksToSettingsFromImport(), getMailNotificationInputs(), and toStorage().

                                                    : int
    {
        return $this->mail_notification_content_type;
    }

Here is the caller graph for this function:

getMailNotificationInputs()

ilObjTestSettingsFinishing::getMailNotificationInputs ( ilLanguage  $lng, FieldFactory  $f, Refinery  $refinery  )

private

Definition at line 119 of file ilObjTestSettingsFinishing.php.

References getAlwaysSendMailNotification(), getMailNotificationContentType(), ilLanguage\txt(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by 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()

ilObjTestSettingsFinishing::getRedirectionInputs ( ilLanguage  $lng, FieldFactory  $f, Refinery  $refinery  )

private

Definition at line 65 of file ilObjTestSettingsFinishing.php.

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

Referenced by 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()

ilObjTestSettingsFinishing::getRedirectionMode

(

)

Definition at line 229 of file ilObjTestSettingsFinishing.php.

Referenced by ilObjTest\addConcludingRemarksToSettingsFromImport(), getRedirectionInputs(), and toStorage().

                                        : int
    {
        return $this->redirection_mode;
    }

Here is the caller graph for this function:

getRedirectionUrl()

ilObjTestSettingsFinishing::getRedirectionUrl

(

)

Definition at line 241 of file ilObjTestSettingsFinishing.php.

Referenced by ilObjTest\addConcludingRemarksToSettingsFromImport(), getRedirectionInputs(), and toStorage().

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

Here is the caller graph for this function:

getShowAnswerOverview()

ilObjTestSettingsFinishing::getShowAnswerOverview

(

)

Definition at line 188 of file ilObjTestSettingsFinishing.php.

Referenced by ilObjTest\addConcludingRemarksToSettingsFromImport(), toForm(), and toStorage().

                                           : bool
    {
        return $this->show_answer_overview;
    }

Here is the caller graph for this function:

toForm()

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

Definition at line 42 of file ilObjTestSettingsFinishing.php.

References ILIAS\UI\Implementation\Component\Input\$inputs, getConcludingRemarksEnabled(), getMailNotificationInputs(), getRedirectionInputs(), 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:

toStorage()

ilObjTestSettingsFinishing::toStorage

(

)

Definition at line 174 of file ilObjTestSettingsFinishing.php.

References getAlwaysSendMailNotification(), getConcludingRemarksEnabled(), getConcludingRemarksPageId(), getConcludingRemarksText(), getMailNotificationContentType(), getRedirectionMode(), getRedirectionUrl(), 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()

ilObjTestSettingsFinishing::withAlwaysSendMailNotification

(

bool

$always_send_mail_notification

)

Definition at line 270 of file ilObjTestSettingsFinishing.php.

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

withConcludingRemarksEnabled()

ilObjTestSettingsFinishing::withConcludingRemarksEnabled

(

bool

$concluding_remarks_enabled

)

Definition at line 205 of file ilObjTestSettingsFinishing.php.

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

withConcludingRemarksPageId()

ilObjTestSettingsFinishing::withConcludingRemarksPageId

(

?int

$concluding_remarks_page_id

)

Definition at line 222 of file ilObjTestSettingsFinishing.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()

ilObjTestSettingsFinishing::withMailNotificationContentType

(

int

$mail_notification_content_type

)

Definition at line 258 of file ilObjTestSettingsFinishing.php.

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

withRedirectionMode()

ilObjTestSettingsFinishing::withRedirectionMode

(

int

$redirection_mode

)

Definition at line 234 of file ilObjTestSettingsFinishing.php.

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

withRedirectionUrl()

ilObjTestSettingsFinishing::withRedirectionUrl

(

?string

$redirection_url

)

Definition at line 246 of file ilObjTestSettingsFinishing.php.

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

withShowAnswerOverview()

ilObjTestSettingsFinishing::withShowAnswerOverview

(

bool

$show_answer_overview

)

Definition at line 193 of file ilObjTestSettingsFinishing.php.

Referenced by ilObjTestSettingsMainGUI\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:

• Modules/Test/classes/MainSettings/ilObjTestSettingsFinishing.php