class.ilMarkSchemaGUI.php

Go to the documentation of this file.

<?php

use ILIAS\HTTP\Wrapper\RequestWrapper;
use GuzzleHttp\Psr7\Request;
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\UI\Factory as UIFactory;
use ILIAS\UI\Renderer as UIRenderer;
use ILIAS\UI\Component\Button\Standard as StandardButton;
use ILIAS\UI\Component\Modal\Interruptive as InterruptiveModal;

class ilMarkSchemaGUI
{
    private const RESET_MARK_BUTTON_LABEL = 'tst_mark_reset_to_simple_mark_schema';
    private RequestWrapper $post_wrapper;
    private Request $request;
    private Refinery $refinery;

    protected $object;
    protected ilLanguage $lng;
    protected ilCtrl $ctrl;
    protected ilGlobalPageTemplate $tpl;
    protected ilToolbarGUI $toolbar;
    protected ilTabsGUI $tabs;
    protected UIFactory $ui_factory;
    protected UIRenderer $ui_renderer;

    public function __construct($object)
    {
        global $DIC;

        $this->ctrl = $DIC['ilCtrl'];
        $this->lng = $DIC['lng'];
        $this->tpl = $DIC['tpl'];
        $this->toolbar = $DIC['ilToolbar'];
        $this->object = $object;
        $this->post_wrapper = $DIC->http()->wrapper()->post();
        $this->request = $DIC->http()->request();
        $this->refinery = $DIC->refinery();
        $this->ui_factory = $DIC['ui.factory'];
        $this->ui_renderer = $DIC['ui.renderer'];
    }

    public function executeCommand(): void
    {
        global $DIC;

        $DIC->tabs()->activateTab(ilTestTabsManager::TAB_ID_SETTINGS);
        $cmd = $this->ctrl->getCmd('showMarkSchema');
        if ($cmd === self::RESET_MARK_BUTTON_LABEL) {
            $cmd = 'resetToSimpleMarkSchema';
        }
        $this->$cmd();
    }

    protected function ensureMarkSchemaCanBeEdited(): void
    {
        if (!$this->object->canEditMarks()) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            $this->ctrl->redirect($this, 'showMarkSchema');
        }
    }

    protected function ensureEctsGradesCanBeEdited(): void
    {
        if (!$this->object->canEditEctsGrades()) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            $this->ctrl->redirect($this, 'showMarkSchema');
        }
    }

    protected function addMarkStep(): void
    {
        $this->ensureMarkSchemaCanBeEdited();

        if ($this->saveMarkSchemaFormData()) {
            $this->object->getMarkSchema()->addMarkStep();
        } else {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('mark_schema_invalid'), true);
        }
        $this->showMarkSchema();
    }

    protected function saveMarkSchemaFormData(): bool
    {
        $no_save_error = true;
        $this->object->getMarkSchema()->flush();
        $postdata = $this->request->getParsedBody();
        foreach ($postdata as $key => $value) {
            if (preg_match('/mark_short_(\d+)/', $key, $matches)) {
                $passed = "0";
                if (isset($postdata["passed_$matches[1]"])) {
                    $passed = "1";
                }

                $percentage = str_replace(',', '.', ilUtil::stripSlashes($postdata["mark_percentage_$matches[1]"]));
                if (!is_numeric($percentage)
                    || (float) $percentage < 0.0
                    || (float) $percentage > 100.0) {
                    $percentage = 0;
                    $no_save_error = false;
                }

                $this->object->getMarkSchema()->addMarkStep(
                    ilUtil::stripSlashes($postdata["mark_short_$matches[1]"]),
                    ilUtil::stripSlashes($postdata["mark_official_$matches[1]"]),
                    (float) $percentage,
                    (int) ilUtil::stripSlashes($passed)
                );
            }
        }

        return $no_save_error;
    }

    protected function resetToSimpleMarkSchema(): void
    {
        $this->ensureMarkSchemaCanBeEdited();

        $this->object->getMarkSchema()->createSimpleSchema(
            $this->lng->txt('failed_short'),
            $this->lng->txt('failed_official'),
            0,
            0,
            $this->lng->txt('passed_short'),
            $this->lng->txt('passed_official'),
            50,
            1
        );
        $this->object->getMarkSchema()->saveToDb($this->object->getTestId());
        $this->showMarkSchema();
    }

    protected function deleteMarkSteps(): void
    {
        $marks_trafo = $this->refinery->custom()->transformation(
            function ($vs): ?array {
                if ($vs === null || !is_array($vs)) {
                    return null;
                }
                return $vs;
            }
        );
        $deleted_mark_steps = null;
        if ($this->post_wrapper->has('marks')) {
            $deleted_mark_steps = $this->post_wrapper->retrieve(
                'marks',
                $marks_trafo
            );
        }

        $this->ensureMarkSchemaCanBeEdited();
        if (!isset($deleted_mark_steps) || !is_array($deleted_mark_steps)) {
            $this->showMarkSchema();
            return;
        }

        // test delete
        $schema = clone $this->object->getMarkSchema();
        $schema->deleteMarkSteps($deleted_mark_steps);
        $check_result = $schema->checkMarks();
        if (is_string($check_result)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt($check_result), true);
            $this->showMarkSchema();
            return;
        }

        //  actual delete
        if (!empty($deleted_mark_steps)) {
            $this->object->getMarkSchema()->deleteMarkSteps($deleted_mark_steps);
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('tst_delete_missing_mark'));
        }
        $this->object->getMarkSchema()->saveToDb($this->object->getTestId());

        $this->showMarkSchema();
    }

    protected function saveMarks(): void
    {
        $this->ensureMarkSchemaCanBeEdited();

        if ($this->saveMarkSchemaFormData()) {
            $result = $this->object->checkMarks();
        } else {
            $result = 'mark_schema_invalid';
        }

        if (is_string($result)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt($result), true);
        } else {
            $this->object->getMarkSchema()->saveToDb($this->object->getMarkSchemaForeignId());
            $this->object->onMarkSchemaSaved();
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
            $this->object->getMarkSchema()->flush();
            $this->object->getMarkSchema()->loadFromDb($this->object->getTestId());
        }

        $this->showMarkSchema();
    }

    private function objectSupportsEctsGrades(): bool
    {
        require_once 'Modules/Test/interfaces/interface.ilEctsGradesEnabled.php';
        return $this->object instanceof ilEctsGradesEnabled;
    }

    protected function showMarkSchema(?ilPropertyFormGUI $ects_form = null): void
    {
        if (!$this->object->canEditMarks()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('cannot_edit_marks'));
        }

        $this->toolbar->setFormAction($this->ctrl->getFormAction($this, 'showMarkSchema'));

        require_once 'Modules/Test/classes/tables/class.ilMarkSchemaTableGUI.php';
        $mark_schema_table = new ilMarkSchemaTableGUI($this, 'showMarkSchema', '', $this->object);
        $mark_schema_table->setShowRowsSelector(false);

        $rendered_modal = '';
        if ($this->object->canEditMarks()) {
            $confirmation_modal = $this->ui_factory->modal()->interruptive(
                $this->lng->txt(self::RESET_MARK_BUTTON_LABEL),
                $this->lng->txt('tst_mark_reset_to_simple_mark_schema_confirmation'),
                $this->ctrl->getFormAction($this, 'resetToSimpleMarkSchema')
            )->withActionButtonLabel(self::RESET_MARK_BUTTON_LABEL);
            $this->populateToolbar($confirmation_modal, $mark_schema_table->getId());
            $rendered_modal = $this->ui_renderer->render($confirmation_modal);
        }

        $this->tpl->setContent(
            $mark_schema_table->getHTML() . $rendered_modal
        );
    }

    private function populateToolbar(InterruptiveModal $confirmation_modal, string $mark_schema_id): void
    {
        $create_simple_schema_button = $this->ui_factory->button()->standard(
            $this->lng->txt(self::RESET_MARK_BUTTON_LABEL),
            $confirmation_modal->getShowSignal()
        );
        $this->toolbar->addComponent($create_simple_schema_button);

        $create_step_button = $this->buildCreateStepButton($mark_schema_id);
        $this->toolbar->addComponent($create_step_button);
    }

    private function buildCreateStepButton(string $mark_schema_id): StandardButton
    {
        return $this->ui_factory->button()->standard(
            $this->lng->txt('tst_mark_create_new_mark_step'),
            ''
        )->withAdditionalOnLoadCode(
            fn (string $id): string =>
            "{$id}.addEventListener('click', "
            . ' (e) => {'
            . '     e.preventDefault();'
            . '     e.target.name = "cmd[addMarkStep]";'
            . "     let form = document.getElementById('form_{$mark_schema_id}');"
            . '     let submitter = e.target.cloneNode();'
            . '     submitter.style.visibility = "hidden";'
            . '     form.appendChild(submitter);'
            . '     form.requestSubmit(submitter);'
            . ' }'
            . ');'
        );
    }

    protected function populateEctsForm(ilPropertyFormGUI $form): void
    {
        $data = array();

        $data['ectcs_status'] = $this->object->getECTSOutput();
        $data['use_ects_fx'] = preg_match('/\d+/', $this->object->getECTSFX());
        $data['ects_fx_threshold'] = $this->object->getECTSFX();

        $ects_grades = $this->object->getECTSGrades();
        for ($i = ord('a'); $i <= ord('e'); $i++) {
            $mark = chr($i);
            $data['ects_grade_' . $mark] = $ects_grades[chr($i - 32)];
        }

        $form->setValuesByArray($data);
    }

    protected function getEctsForm(): ilPropertyFormGUI
    {
        require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';

        $disabled = !$this->object->canEditEctsGrades();

        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, 'saveEctsForm'));
        $form->setTitle($this->lng->txt('ects_output_of_ects_grades'));

        $allow_ects_marks = new ilCheckboxInputGUI($this->lng->txt('ects_allow_ects_grades'), 'ectcs_status');
        $allow_ects_marks->setDisabled($disabled);
        for ($i = ord('a'); $i <= ord('e'); $i++) {
            $mark = chr($i);

            $mark_step = new ilNumberInputGUI(chr($i - 32), 'ects_grade_' . $mark);
            $mark_step->setInfo(
                $this->lng->txt('ects_grade_desc_prefix') . ' ' . $this->lng->txt('ects_grade_' . $mark . '_desc')
            );
            $mark_step->setSize(5);
            $mark_step->allowDecimals(true);
            $mark_step->setMinValue(0, true);
            $mark_step->setMaxValue(100, true);
            $mark_step->setSuffix($this->lng->txt('percentile'));
            $mark_step->setRequired(true);
            $mark_step->setDisabled($disabled);
            $allow_ects_marks->addSubItem($mark_step);
        }

        $mark_step = new ilNonEditableValueGUI('F', 'ects_grade_f');
        $mark_step->setInfo(
            $this->lng->txt('ects_grade_desc_prefix') . ' ' . $this->lng->txt('ects_grade_f_desc')
        );
        $allow_ects_marks->addSubItem($mark_step);

        $use_ects_fx = new ilCheckboxInputGUI($this->lng->txt('use_ects_fx'), 'use_ects_fx');
        $use_ects_fx->setDisabled($disabled);
        $allow_ects_marks->addSubItem($use_ects_fx);

        $mark_step = new ilNonEditableValueGUI('FX', 'ects_grade_fx');
        $mark_step->setInfo(
            $this->lng->txt('ects_grade_desc_prefix') . ' ' . $this->lng->txt('ects_grade_fx_desc')
        );
        $use_ects_fx->addSubItem($mark_step);

        $threshold = new ilNumberInputGUI($this->lng->txt('ects_fx_threshold'), 'ects_fx_threshold');
        $threshold->setInfo($this->lng->txt('ects_fx_threshold_info'));
        $threshold->setSuffix($this->lng->txt('percentile'));
        $threshold->allowDecimals(true);
        $threshold->setSize(5);
        $threshold->setRequired(true);
        $threshold->setDisabled($disabled);
        $use_ects_fx->addSubItem($threshold);


        $form->addItem($allow_ects_marks);

        if (!$disabled) {
            $form->addCommandButton('saveEctsForm', $this->lng->txt('save'));
        }

        return $form;
    }

    protected function saveEctsForm(): void
    {
        $this->ensureEctsGradesCanBeEdited();

        $ects_form = $this->getEctsForm();
        if (!$ects_form->checkInput()) {
            $ects_form->setValuesByPost();
            $this->showMarkSchema($ects_form);
            return;
        }

        $grades = array();
        for ($i = ord('a'); $i <= ord('e'); $i++) {
            $mark = chr($i);
            $grades[chr($i - 32)] = $ects_form->getInput('ects_grade_' . $mark);
        }

        $this->object->setECTSGrades($grades);
        $this->object->setECTSOutput((int) $ects_form->getInput('ectcs_status'));
        $this->object->setECTSFX(
            $ects_form->getInput('use_ects_fx') && preg_match('/\d+/', $ects_form->getInput('ects_fx_threshold')) ?
            $ects_form->getInput('ects_fx_threshold') :
            null
        );

        $this->object->saveECTSStatus();

        $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));
        $ects_form->setValuesByPost();
        $this->showMarkSchema($ects_form);
    }
}