class.ilFileCommonSettingsGUI.php

Go to the documentation of this file.

<?php

class ilFileCommonSettingsGUI
{
    public const CMD_EDIT = 'editSettings';
    public const CMD_SAVE = 'saveSettings';
    private array $services = [
        ilObjectServiceSettingsGUI::CUSTOM_METADATA
    ];

    public function __construct(protected ilObjFile $object, protected ilCtrl $ctrl, protected ilGlobalTemplateInterface $tpl, protected ilLanguage $lng, protected ilObjectService $object_service)
    {
    }

    public function executeCommand(): void
    {
        $cmd = $this->ctrl->getCmd();
        match ($cmd) {
            self::CMD_EDIT => $this->editSettings(),
            self::CMD_SAVE => $this->saveSettings(),
            default => throw new Exception('Unknown command ' . $cmd),
        };
    }

    protected function editSettings(?ilPropertyFormGUI $form = null): void
    {
        if (is_null($form)) {
            $form = $this->buildForm();
        }
        $this->tpl->setContent($form->getHTML());
    }

    protected function buildForm(): ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->txt('obj_features'));
        $form->addCommandButton(self::CMD_SAVE, $this->txt('save'));
        $form->addCommandButton(self::CMD_EDIT, $this->txt('cancel'));

        $this->addServiceSettingsToForm($form);
        $this->addCommonFieldsToForm($form);

        return $form;
    }

    protected function addServiceSettingsToForm(ilPropertyFormGUI $form): void
    {
        ilObjectServiceSettingsGUI::initServiceSettingsForm(
            $this->object->getId(),
            $form,
            $this->services
        );
    }

    protected function addCommonFieldsToForm(ilPropertyFormGUI $form): void
    {
        //
    }

    protected function saveSettings(): void
    {
        $form = $this->buildForm();

        if (!$form->checkInput()) {
            $form->setValuesByPost();
            $this->editSettings($form);
            return;
        }

        ilObjectServiceSettingsGUI::updateServiceSettingsForm(
            $this->object->getId(),
            $form,
            $this->services
        );

        $this->tpl->setOnScreenMessage("success", $this->lng->txt('service_settings_saved'), true);
        $this->ctrl->redirect($this, self::CMD_EDIT);
    }

    protected function txt(string $code): string
    {
        return $this->lng->txt($code);
    }
}