class.ilObjPDFGenerationGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilObjPDFGenerationGUI extends ilObject2GUI
{
    private string $active_tab = '';
    private ilPDFGenerationRequest $pdfRequest;

    public function __construct(int $a_id = 0, int $a_id_type = self::REPOSITORY_NODE_ID, int $a_parent_node_id = 0)
    {
        global $DIC;
        parent::__construct($a_id, $a_id_type, $a_parent_node_id);
        $this->lng->loadLanguageModule('pdfgen');
        $this->pdfRequest = new ilPDFGenerationRequest($this->refinery, $DIC->http());
    }

    protected function hasWritePermission(): bool
    {
        return $this->checkPermissionBool('write');
    }

    public function getType(): string
    {
        return 'pdfg';
    }

    public function executeCommand(): void
    {
        $next_class = $this->ctrl->getNextClass();
        $cmd = $this->ctrl->getCmd();
        $this->prepareOutput();

        switch (strtolower($next_class)) {
            case strtolower(ilPermissionGUI::class):
                $this->tabs_gui->setTabActive('perm_settings');
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;

            default:
                if ($cmd === null || $cmd === '' || $cmd === 'view') {
                    $cmd = 'configForm';
                }

                if (strpos($cmd, 'saveandconf_selected_') === 0) {
                    $this->handleSaveAndConf(substr($cmd, 21));
                } else {
                    $this->$cmd();
                }
                break;
        }
    }

    public function configForm(): void
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, 'view'));
        $purpose_map = ilPDFGeneratorUtils::getPurposeMap();
        $selection_map = ilPDFGeneratorUtils::getSelectionMap();
        $renderers = ilPDFGeneratorUtils::getRenderers();
        foreach ($purpose_map as $service => $purposes) {
            foreach ($purposes as $purpose) {
                $section = new ilFormSectionHeaderGUI();
                $section->setTitle(ucfirst($service) . ' / ' . ucfirst($purpose));
                $form->addItem($section);

                $preferred = new ilTextInputGUI($this->lng->txt('preferred_renderer'));
                $preferred->setValue($selection_map[$service][$purpose]['preferred']);
                $preferred->setDisabled(true);
                $form->addItem($preferred);

                $selected = new ilSelectInputGUI($this->lng->txt('selected_renderer'), 'selected_' . $service . '::' . $purpose);
                $selected->setOptions($renderers[$service][$purpose]);
                $selected_renderer = $selection_map[$service][$purpose]['selected'];
                $selected_index = 0;
                foreach ($renderers[$service][$purpose] as $key => $value) {
                    if ($value === $selected_renderer) {
                        $selected_index = $key;
                    }
                }
                $selected->setValue($selected_index);
                $form->addItem($selected);

                $s_button = ilSubmitButton::getInstance();
                $s_button->setCaption('configure');
                $s_button->setCommand('saveandconf_selected_' . $service . '::' . $purpose);
                if (!$this->hasWritePermission()) {
                    $s_button->setDisabled(true);
                }
                $input_selected = new ilCustomInputGUI($this->lng->txt('configure'));
                $input_selected->setHtml($s_button->getToolbarHTML());
                $form->addItem($input_selected);
            }
        }

        if ($this->hasWritePermission()) {
            $form->addCommandButton("saveSettings", $this->lng->txt("save"));
        }

        if (ilPDFCompInstaller::checkForMultipleServiceAndPurposeCombination()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('problem_with_purposes'));
            $clean_btn = ilLinkButton::getInstance();
            $clean_btn->setCaption('cleanup');
            $clean_btn->setUrl($this->ctrl->getLinkTarget($this, 'doCleanUp'));
            $this->toolbar->addButtonInstance($clean_btn);
        }
        $this->tpl->setContent($form->getHTML());
        $this->setActiveTab('settings');
    }

    public function saveSettings(bool $redirect_after = true): void
    {
        if (!$this->hasWritePermission()) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_permission'), true);
            $this->ctrl->redirect($this, "view");
        }

        $purpose_map = ilPDFGeneratorUtils::getPurposeMap();
        $selection_map = ilPDFGeneratorUtils::getSelectionMap();
        $renderers = ilPDFGeneratorUtils::getRenderers();

        foreach ($purpose_map as $service => $purposes) {
            foreach ($purposes as $purpose) {
                $selected = $this->pdfRequest->securedString('selected_' . $service . '::' . $purpose);
                $posted_renderer = $renderers[$service][$purpose][$selected] ?? null;
                if ($posted_renderer === null) {
                    continue;
                }

                $selected_renderer = $selection_map[$service][$purpose]['selected'];
                if ($posted_renderer !== $selected_renderer) {
                    ilPDFGeneratorUtils::updateRendererSelection($service, $purpose, $posted_renderer);
                }
            }
        }

        if ($redirect_after) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('config_saved'), true);
            $this->ctrl->redirect($this, "view");
        }
    }

    protected function handleSaveAndConf(string $command): void
    {
        if (!$this->checkPermissionBool('edit')) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_permission'), true);
            $this->ctrl->redirect($this, "view");
        }

        $this->saveSettings(false);

        $form = $this->buildConfigForm($command);
        $this->tpl->setContent($form->getHTML());
        $this->setActiveTab('settings');
    }

    public function resetSettings(): void
    {
        $renderer = $this->pdfRequest->securedString('renderer');
        $service = $this->pdfRequest->securedString('service');
        $purpose = $this->pdfRequest->securedString('purpose');

        ilPDFGeneratorUtils::removeRendererConfig($service, $purpose, $renderer);
        $this->ctrl->redirect($this, "view");
    }

    private function buildConfigForm(string $command, bool $populate = true): ilPropertyFormGUI
    {
        $parts = explode('::', $command);
        $service = $parts[0];
        $purpose = $parts[1];

        $renderers = ilPDFGeneratorUtils::getRenderers();

        $selected = $this->pdfRequest->securedString('selected_' . $service . '::' . $purpose);
        $posted_renderer = $renderers[$service][$purpose][$selected];

        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, 'view'));

        $form->setTitle($this->lng->txt('settings') . ' ' . $posted_renderer . ' / ' . $service . ' / ' . $purpose);
        $service_hidden = new ilHiddenInputGUI('service');
        $service_hidden->setValue($service);
        $form->addItem($service_hidden);

        $purpose_hidden = new ilHiddenInputGUI('purpose');
        $purpose_hidden->setValue($purpose);
        $form->addItem($purpose_hidden);

        $renderer_hidden = new ilHiddenInputGUI('renderer');
        $renderer_hidden->setValue($posted_renderer);
        $form->addItem($renderer_hidden);

        $renderer_hidden = new ilHiddenInputGUI(
            ilLegacyFormElementsUtil::prepareFormOutput('selected_' . $service . '::' . $purpose)
        );
        $renderer_hidden->setValue($selected);
        $form->addItem($renderer_hidden);

        // Add In RendererConfig
        $renderer = ilPDFGeneratorUtils::getRendererInstance($posted_renderer);
        $renderer->addConfigElementsToForm($form, $service, $purpose);

        if ($populate) {
            $config = ilPDFGeneratorUtils::getRendererConfig($service, $purpose, $posted_renderer);
            $renderer->populateConfigElementsInForm($form, $service, $purpose, $config);
        }

        $form->addCommandButton('saveConfig', $this->lng->txt('save'));
        $form->addCommandButton('view', $this->lng->txt('cancel'));
        $form->addCommandButton('resetSettings', $this->lng->txt('reset_to_default'));

        return $form;
    }

    protected function saveConfig(): void
    {
        $renderer = $this->pdfRequest->securedString('renderer');
        $service = $this->pdfRequest->securedString('service');
        $purpose = $this->pdfRequest->securedString('purpose');

        $form = $this->buildConfigForm($service . '::' . $purpose, false);

        $renderer_obj = ilPDFGeneratorUtils::getRendererInstance($renderer);

        $valid_renderer_config = false;
        if ($form->checkInput() &&
            ($valid_renderer_config = $renderer_obj->validateConfigInForm($form, $service, $purpose))) {
            $config = $renderer_obj->getConfigFromForm($form, $service, $purpose);
            ilPDFGeneratorUtils::saveRendererPurposeConfig($service, $purpose, $renderer, $config);
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('config_saved'), true);
            $this->ctrl->redirect($this, 'view');
        }

        if (!$valid_renderer_config) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('form_input_not_valid'));
        }

        $form->setValuesByPost();

        $this->tpl->setContent($form->getHTML());
        $this->setActiveTab('settings');
    }

    protected function doCleanUp(): void
    {
        ilPDFCompInstaller::doCleanUp();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('config_saved'), true);
        $this->ctrl->redirect($this, "view");
    }

    public function getAdminTabs(): void
    {
        if (strpos($this->ctrl->getCmd(), 'saveandconf') !== 0) {
            if ($this->checkPermissionBool('read')) {
                $this->tabs_gui->addTarget('settings', $this->ctrl->getLinkTarget($this, 'view'), [], __CLASS__);
            }

            if ($this->checkPermissionBool('edit_permission')) {
                $this->tabs_gui->addTarget(
                    'perm_settings',
                    $this->ctrl->getLinkTargetByClass('ilpermissiongui', 'perm'),
                    [],
                    'ilpermissiongui'
                );
            }
        } else {
            $this->tabs_gui->setBackTarget(
                $this->lng->txt("back"),
                $this->ctrl->getLinkTargetByClass("ilobjpdfgenerationgui", "view")
            );
        }
    }

    protected function setActiveTab(string $tab = ''): void
    {
        $this->tabs_gui->setTabActive($tab === '' ? $this->active_tab : $tab);
    }
}