class.ilObjStudyProgrammeSettingsGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

/* Copyright (c) 2015 Richard Klees <richard.klees@concepts-and-training.de> Extended GPL, see docs/LICENSE */
/* Copyright (c) 2020 Stefan Hecken <stefan.hecken@concepts-and-training.de> Extended GPL, see docs/LICENSE */

use GuzzleHttp\Psr7\ServerRequest;
use ILIAS\UI\Component\Input\Factory;
use ILIAS\UI\Implementation\Component\Input\Field\Factory as InputFieldFactory;
use ILIAS\UI\Renderer;

class ilObjStudyProgrammeSettingsGUI
{
    const TAB_SETTINGS = 'settings';
    const TAB_COMMON_SETTINGS = 'commonSettings';

    const PROP_TITLE = "title";
    const PROP_DESC = "desc";
    const PROP_DEADLINE = "deadline";
    const PROP_VALIDITY_OF_QUALIFICATION = "validity_qualification";
    const PROP_ACCESS_CONTROL_BY_ORGU_POSITION = "access_ctr_by_orgu_position";

    const OPT_NO_DEADLINE = 'opt_no_deadline';
    const OPT_DEADLINE_PERIOD = "opt_deadline_period";
    const OPT_DEADLINE_DATE = "opt_deadline_date";

    const OPT_NO_VALIDITY_OF_QUALIFICATION = 'opt_no_validity_qualification';
    const OPT_VALIDITY_OF_QUALIFICATION_PERIOD = "opt_validity_qualification_period";
    const OPT_VALIDITY_OF_QUALIFICATION_DATE = "opt_validity_qualification_date";


    public $ctrl;

    public $tpl;

    public $object;

    public $lng;

    protected $tmp_heading;

    protected $input_factory;

    protected $renderer;

    protected $request;

    protected $refinery_factory;

    protected $ref_id;

    protected $data_factory;

    protected $type_repository;

    protected $common_settings_gui;

    protected $tabs;

    public function __construct(
        \ilGlobalTemplateInterface $tpl,
        \ilCtrl $ilCtrl,
        \ilLanguage $lng,
        Factory $input_factory,
        Renderer $renderer,
        ServerRequest $request,
        \ILIAS\Refinery\Factory $refinery_factory,
        \ILIAS\Data\Factory $data_factory,
        ilStudyProgrammeTypeRepository $type_repository,
        ilStudyProgrammeCommonSettingsGUI $common_settings_gui,
        ilTabsGUI $tabs
    ) {
        $this->tpl = $tpl;
        $this->ctrl = $ilCtrl;
        $this->lng = $lng;
        $this->input_factory = $input_factory;
        $this->renderer = $renderer;
        $this->request = $request;
        $this->refinery_factory = $refinery_factory;
        $this->data_factory = $data_factory;
        $this->type_repository = $type_repository;
        $this->object = null;
        $this->common_settings_gui = $common_settings_gui;
        $this->tabs = $tabs;

        $lng->loadLanguageModule("prg");
    }

    public function setRefId($a_ref_id)
    {
        $this->ref_id = $a_ref_id;
    }

    public function executeCommand()
    {
        $next_class = $this->ctrl->getNextClass();
        switch ($next_class) {
            case 'ilstudyprogrammecommonsettingsgui':
                $this->tabs->activateSubTab(self::TAB_COMMON_SETTINGS);
                $this->common_settings_gui->setObject($this->getObject());
                $content = $this->ctrl->forwardCommand($this->common_settings_gui);
                break;
            default:
                $cmd = $this->ctrl->getCmd();
                if ($cmd == "") {
                    $cmd = "view";
                }
                switch ($cmd) {
                    case "view":
                        $content = $this->view();
                        break;
                    case "update":
                        $content = $this->$cmd();
                        break;
                    default:
                        throw new ilException(
                            "ilObjStudyProgrammeSettingsGUI: " . "Command not supported: $cmd"
                        );
                }
        }

        if (!$this->ctrl->isAsynch()) {
            $this->tpl->setContent($content);
        } else {
            $output_handler = new ilAsyncOutputHandler();
            $heading = $this->lng->txt("prg_async_" . $this->ctrl->getCmd());
            if (isset($this->tmp_heading)) {
                $heading = $this->tmp_heading;
            }
            $output_handler->setHeading($heading);
            $output_handler->setContent($content);
            $output_handler->terminate();
        }
    }

    protected function view()
    {
        $this->buildModalHeading($this->lng->txt('prg_async_settings'), isset($_GET["currentNode"]));

        $form = $this->buildForm($this->getObject(), $this->ctrl->getFormAction($this, "update"));
        return $this->renderer->render($form);
    }

    protected function update()
    {
        $form = $this
            ->buildForm($this->getObject(), $this->ctrl->getFormAction($this, "update"))
            ->withRequest($this->request);

        $result = $form->getInputGroup()->getContent();

        // This could further improved by providing a new container for asynch-forms in the
        // UI-Framework.

        if ($result->isOK()) {
            $result->value()->update();
            ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"), true);

            if ($this->ctrl->isAsynch()) {
                $response = ilAsyncOutputHandler::encodeAsyncResponse(
                    array(
                    "success" => true,
                    "message" => $this->lng->txt("msg_obj_modified"))
                );
                return ilAsyncOutputHandler::handleAsyncOutput($form->getHTML(), $response, false);
            } else {
                $this->ctrl->redirect($this);
            }
        } else {
            ilUtil::sendFailure($this->lng->txt("msg_form_save_error"));

            if ($this->ctrl->isAsynch()) {
                $response = ilAsyncOutputHandler::encodeAsyncResponse(
                    array(
                    "success" => false,
                    "errors" => $form->getErrors())
                );
                return ilAsyncOutputHandler::handleAsyncOutput($form->getHTML(), $response, false);
            } else {
                return $this->renderer->render($form);
            }
        }
    }

    protected function buildModalHeading($label, $current_node)
    {
        if (!$current_node) {
            $this->ctrl->saveParameterByClass('ilobjstudyprogrammesettingsgui', 'ref_id');
            $heading_button = ilLinkButton::getInstance();
            $heading_button->setCaption('prg_open_node');
            $heading_button->setUrl(
                $this->ctrl->getLinkTargetByClass(
                    'ilobjstudyprogrammetreegui',
                    'view'
            )
            );

            $heading =
                "<div class=''>" .
                $label .
                "<div class='pull-right'>" .
                $heading_button->render() .
                "</div></div>"
            ;
            $this->tmp_heading = $heading;
        } else {
            $this->tmp_heading = "<div class=''>" . $label . "</div>";
        }
    }

    protected function buildForm(
        \ilObjStudyProgramme $prg,
        string $submit_action
    ) : ILIAS\UI\Component\Input\Container\Form\Form {
        $trans = $prg->getObjectTranslation();
        $ff = $this->input_factory->field();
        $sp_types = $this->type_repository->readAllTypesArray();

        return $this->input_factory->container()->form()->standard(
            $submit_action,
            $this->buildFormElements(
                $ff,
                $trans,
                $sp_types,
                $prg
            )
        )->withAdditionalTransformation(
            $this->refinery_factory->custom()->transformation(
                function ($values) use ($prg) {
                    // to the section they originated from.
                    $object_data = $values[0];
                    $prg->setTitle($object_data[self::PROP_TITLE]);
                    $prg->setDescription($object_data[self::PROP_DESC]);

                    $type_settings = $values['prg_type'];
                    $type = $type_settings->getTypeId();
                    if ($prg->getTypeSettings()->getTypeId() != $type) {
                        $prg->setTypeSettings($type_settings);
                        $prg->updateCustomIcon();
                    }

                    $prg->setAssessmentSettings($values['prg_assessment']);
                    $prg->setDeadlineSettings($values['prg_deadline']);
                    $prg->setValidityOfQualificationSettings(
                        $values['prg_validity_of_qualification']
                    );

                    $prg->setAutoMailSettings($values["automail_settings"]);

                    return $prg;
                }
            )
        );
    }

    protected function buildFormElements(
        InputFieldFactory $ff,
        ilObjectTranslation $trans,
        array $sp_types,
        ilObjStudyProgramme $prg
    ) : array {
        global $DIC;
        $ilLng = $DIC->language();
        $refinery = $DIC["refinery"];

        $return = [
            $this->getEditSection($ff, $trans),
            "prg_type" => $prg
                ->getTypeSettings()
                ->toFormInput($ff, $ilLng, $refinery, $sp_types)
            ,
            "prg_assessment" => $prg
                ->getAssessmentSettings()
                ->toFormInput($ff, $ilLng, $refinery)
            ,
            "prg_deadline" => $prg
                ->getDeadlineSettings()
                ->toFormInput($ff, $ilLng, $refinery, $this->data_factory)
            ,
            "prg_validity_of_qualification" => $prg
                ->getValidityOfQualificationSettings()
                ->toFormInput($ff, $ilLng, $refinery, $this->data_factory)
            ,
            "automail_settings" => $prg
                ->getAutoMailSettings()
                ->toFormInput($ff, $ilLng, $refinery)
        ];

        return $return;
    }

    protected function getEditSection(
        InputFieldFactory $ff,
        ilObjectTranslation $trans
    ) {
        $languages = ilMDLanguageItem::_getLanguages();
        return $ff->section(
            [
                self::PROP_TITLE =>
                    $ff->text($this->txt("title"))
                       ->withValue($trans->getDefaultTitle())
                       ->withRequired(true),
                self::PROP_DESC =>
                    $ff->textarea($this->txt("description"))
                       ->withValue($trans->getDefaultDescription() ?? "")
            ],
            $this->txt("prg_edit"),
            $this->txt("language") . ": " . $languages[$trans->getDefaultLanguage()] .
            ' <a href="' . $this->ctrl->getLinkTargetByClass("ilobjecttranslationgui", "") .
            '">&raquo; ' . $this->txt("obj_more_translations") . '</a>'
        );
    }

    protected function getObject() : ilObjStudyProgramme
    {
        if ($this->object === null) {
            $this->object = ilObjStudyProgramme::getInstanceByRefId($this->ref_id);
        }
        return $this->object;
    }

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