Collaboration diagram for ilObjLearningSequenceSettingsGUI:

Public Member Functions
	__construct (protected ilObjLearningSequence $obj, protected ilCtrl $ctrl, protected ilLanguage $lng, protected ilGlobalTemplateInterface $tpl, protected ILIAS\Refinery\Factory $refinery, protected ILIAS\UI\Factory $ui_factory, protected ILIAS\UI\Renderer $renderer, protected Psr\Http\Message\ServerRequestInterface $request)

	executeCommand ()

Data Fields
const	PROP_TITLE = 'title'

const	PROP_DESC = 'desc'

const	PROP_ONLINE = 'online'

const	PROP_AVAIL_FROM = 'start'

const	PROP_AVAIL_TO = 'end'

const	PROP_GALLERY = 'gallery'

const	CMD_EDIT = "settings"

const	CMD_SAVE = "update"

const	CMD_CANCEL = "cancel"

Protected Member Functions
	settings ()

	cancel ()

	buildForm (ilObjLearningSequence $lso, string $submit_action)

	buildFormElements (ilObjLearningSequence $lso, ILIAS\UI\Component\Input\Factory $if)

	update ()

Detailed Description

Definition at line 24 of file class.ilObjLearningSequenceSettingsGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjLearningSequenceSettingsGUI::__construct	(	protected ilObjLearningSequence	$obj,
		protected ilCtrl	$ctrl,
		protected ilLanguage	$lng,
		protected ilGlobalTemplateInterface	$tpl,
		protected ILIAS\Refinery\Factory	$refinery,
		protected ILIAS\UI\Factory	$ui_factory,
		protected ILIAS\UI\Renderer	$renderer,
		protected Psr\Http\Message\ServerRequestInterface	$request
	)

Definition at line 37 of file class.ilObjLearningSequenceSettingsGUI.php.

      {
        $this->lng->loadLanguageModule('content');
        $this->lng->loadLanguageModule('obj');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ buildForm()

ilObjLearningSequenceSettingsGUI::buildForm	(	ilObjLearningSequence	$lso,
		string	$submit_action
	)

protected

Definition at line 81 of file class.ilObjLearningSequenceSettingsGUI.php.

     : ILIAS\UI\Component\Input\Container\Form\Standard {
        $if = $this->ui_factory->input();
 
        $form = $if->container()->form()->standard(
            $submit_action,
            $this->buildFormElements(
                $lso,
                $if
            )
        );
 
        return $form;
    }

Referenced by settings().

Here is the caller graph for this function:

◆ buildFormElements()

ilObjLearningSequenceSettingsGUI::buildFormElements	(	ilObjLearningSequence	$lso,
		ILIAS\UI\Component\Input\Factory	$if
	)

protected

Definition at line 98 of file class.ilObjLearningSequenceSettingsGUI.php.

      {
        $txt = fn($id) => $this->lng->txt($id);
        $settings = $lso->getLSSettings();
        $activation = $lso->getLSActivation();
        $formElements = [];
 
        // Title & Description
        $title = $if->field()->text($txt("title"))
            ->withRequired(true)
            ->withValue($lso->getTitle());
        $description = $if->field()->text($txt("description"))
            ->withValue($lso->getLongDescription());
        $section_object = $if->field()->section(
            [
                self::PROP_TITLE => $title,
                self::PROP_DESC => $description
            ],
            $txt('lso_edit')
        );
        $formElements['object'] = $section_object;
 
        // Online status
        $online = $if->field()->checkbox(
            $txt('online'),
            $txt('lso_activation_online_info')
        )->withValue($activation->getIsOnline());
        $online_start = $if->field()->dateTime($txt('from'))
            ->withUseTime(true)
            ->withValue(($activation->getActivationStart()) ? $activation->getActivationStart()->format('Y-m-d H:i') : '');
        $online_end = $if->field()->dateTime($txt('to'))
            ->withUseTime(true)
            ->withValue(($activation->getActivationEnd()) ? $activation->getActivationEnd()->format('Y-m-d H:i') : '');
        $section_online = $if->field()->section(
            [
                self::PROP_ONLINE => $online,
                self::PROP_AVAIL_FROM => $online_start,
                self::PROP_AVAIL_TO => $online_end
            ],
            $txt('lso_settings_availability')
        )->withAdditionalTransformation(
            $this->refinery->custom()->constraint(
                function ($values) {
                    $start = $values[self::PROP_AVAIL_FROM] ?? '';
                    $end = $values[self::PROP_AVAIL_TO] ?? '';
                    if (($start !== '' && $end !== '') && ($end < $start)) {
                        return false;
                    }
                    return true;
                },
                $txt('lso_settings_availability_error')
            )
        );
        $formElements['online'] = $section_online;
 
        // Member gallery
        $gallery = $if->field()->checkbox($txt("members_gallery"), $txt('lso_show_members_info'))
            ->withValue($settings->getMembersGallery())
            ->withAdditionalTransformation(
                $this->refinery->byTrying([
                    $this->refinery->kindlyTo()->bool(),
                    $this->refinery->always(false)
                ])
            );
        $section_additional = $if->field()->section(
            [
                self::PROP_GALLERY => $gallery
            ],
            $txt('obj_features')
        );
        $formElements['additional'] = $section_additional;
 
        // Common properties
        $title_icon = $lso->getObjectProperties()->getPropertyTitleAndIconVisibility()->toForm(
            $this->lng,
            $if->field(),
            $this->refinery
        );
        $header_actions = $lso->getObjectProperties()->getPropertyHeaderActionVisibility()->toForm(
            $this->lng,
            $if->field(),
            $this->refinery
        );
        $custom_icon = $lso->getObjectProperties()->getPropertyIcon()->toForm(
            $this->lng,
            $if->field(),
            $this->refinery
        );
        $image = $lso->getObjectProperties()->getPropertyTileImage()->toForm(
            $this->lng,
            $if->field(),
            $this->refinery
        );
        $section_common = $if->field()->section(
            array_filter([
                'icon' => $title_icon,
                'header_actions' => $header_actions,
                'custom_icon' => $custom_icon,
                'image' => $image
            ]),
            $txt('cont_presentation')
        );
        $formElements['common'] = $section_common;
 
        return $formElements;
    }

References $id, ILIAS\UI\examples\Layout\Page\Standard\$refinery, $txt, ilObject\getLongDescription(), ilObjLearningSequence\getLSActivation(), ilObjLearningSequence\getLSSettings(), ilObject\getObjectProperties(), ilObject\getTitle(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation(), and ILIAS\UI\Implementation\Component\Input\withValue().

Here is the call graph for this function:

◆ cancel()

ilObjLearningSequenceSettingsGUI::cancel ( )

protected

Definition at line 76 of file class.ilObjLearningSequenceSettingsGUI.php.

                               : void
    {
        $this->ctrl->redirectByClass(ilObjLearningSequenceGUI::class);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ executeCommand()

ilObjLearningSequenceSettingsGUI::executeCommand ( )

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

                                    : void
    {
        $cmd = $this->ctrl->getCmd('settings');
 
        switch ($cmd) {
            case self::CMD_EDIT:
            case self::CMD_SAVE:
            case self::CMD_CANCEL:
                $content = $this->$cmd();
                break;
 
            default:
                throw new ilException("ilObjLearningSequenceSettingsGUI: Command not supported: $cmd");
        }
        $this->tpl->setContent($content);
    }

References CMD_CANCEL, CMD_EDIT, CMD_SAVE, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ settings()

ilObjLearningSequenceSettingsGUI::settings ( )

protected

Definition at line 68 of file class.ilObjLearningSequenceSettingsGUI.php.

                                 : string
    {
        return $this->renderer->render($this->buildForm(
            $this->obj,
            $this->ctrl->getFormAction($this, self::CMD_SAVE)
        ));
    }

References buildForm(), ILIAS\Repository\ctrl(), and renderer().

Here is the call graph for this function:

◆ update()

ilObjLearningSequenceSettingsGUI::update ( )

protected

Definition at line 207 of file class.ilObjLearningSequenceSettingsGUI.php.

                               : ?string
    {
        $form = $this
            ->buildForm($this->obj, $this->ctrl->getFormAction($this, self::CMD_SAVE))
            ->withRequest($this->request);
 
        $result = $form->getInputGroup()->getContent();
 
        if ($result->isOK()) {
            $values = $result->value();
            $lso = $this->obj;
 
            $lso->setTitle($values['object'][self::PROP_TITLE]);
            $lso->setDescription($values['object'][self::PROP_DESC]);
 
            $settings = $lso->getLSSettings()
                ->withMembersGallery($values['additional'][self::PROP_GALLERY]);
            $lso->updateSettings($settings);
 
            $activation = $lso->getLSActivation()
                ->withIsOnline($values['online'][self::PROP_ONLINE])
                ->withActivationStart(null)
                ->withActivationEnd(null);
            if ($values['online'][self::PROP_AVAIL_FROM] !== null) {
                $activation = $activation
                    ->withActivationStart(
                        DateTime::createFromImmutable($values['online'][self::PROP_AVAIL_FROM])
                    );
            }
            if ($values['online'][self::PROP_AVAIL_TO] !== null) {
                $activation = $activation
                    ->withActivationEnd(
                        DateTime::createFromImmutable($values['online'][self::PROP_AVAIL_TO])
                    );
            }
            $lso->updateActivation($activation);
 
            $status = ilObjLearningSequenceAccess::isOffline($lso->getRefId());
            $lso->getObjectProperties()->storePropertyIsOnline(
                new Online(! $status)
            );
 
            $lso->getObjectProperties()->storePropertyTitleAndIconVisibility($values['common']['icon']);
            $lso->getObjectProperties()->storePropertyHeaderActionVisibility($values['common']['header_actions']);
            if (array_key_exists('custom_icon', $values['common'])) {
                $lso->getObjectProperties()->storePropertyIcon($values['common']['custom_icon']);
            }
 
            $lso->getObjectProperties()->storePropertyTileImage($values['common']['image']);
 
            $lso->update();
 
            $this->tpl->setOnScreenMessage("success", $this->lng->txt("msg_obj_modified"), true);
            $this->ctrl->redirect($this);
            return null;
        } else {
            $this->tpl->setOnScreenMessage("failure", $this->lng->txt("msg_form_save_error"));
            return $this->renderer->render($form);
        }
    }