ModalFactory.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\MetaData\Editor\Full\Services\Actions;

use ILIAS\UI\Factory as UIFactory;
use ILIAS\UI\Component\Modal\RoundTrip as RoundtripModal;
use ILIAS\UI\Component\Input\Container\Form\Standard as StandardForm;
use ILIAS\UI\Component\Input\Field\Group as Group;
use ILIAS\MetaData\Editor\Presenter\PresenterInterface;
use ILIAS\MetaData\Paths\PathInterface;
use ILIAS\MetaData\Elements\SetInterface;
use ILIAS\MetaData\Editor\Full\Services\PropertiesFetcher;
use ILIAS\MetaData\Editor\Http\Command;
use ILIAS\MetaData\Elements\ElementInterface;
use ILIAS\MetaData\Editor\Full\Services\FormFactory;
use ILIAS\MetaData\Repository\Validation\Dictionary\DictionaryInterface as ConstraintDictionaryInterface;
use ILIAS\MetaData\Repository\Validation\Dictionary\Restriction;
use ILIAS\MetaData\Paths\FactoryInterface;
use ILIAS\MetaData\Editor\Http\RequestForFormInterface;

class ModalFactory
{
    public const int MAX_LENGTH = 128;

    protected LinkProvider $link_provider;
    protected UIFactory $factory;
    protected PresenterInterface $presenter;
    protected PropertiesFetcher $properties_fetcher;
    protected FormFactory $form_factory;
    protected ConstraintDictionaryInterface $constraint_dictionary;
    protected FactoryInterface $path_factory;

    public function __construct(
        LinkProvider $link_provider,
        UIFactory $factory,
        PresenterInterface $presenter,
        PropertiesFetcher $properties_fetcher,
        FormFactory $form_factory,
        ConstraintDictionaryInterface $constraint_dictionary,
        FactoryInterface $path_factory
    ) {
        $this->link_provider = $link_provider;
        $this->factory = $factory;
        $this->presenter = $presenter;
        $this->properties_fetcher = $properties_fetcher;
        $this->form_factory = $form_factory;
        $this->constraint_dictionary = $constraint_dictionary;
        $this->path_factory = $path_factory;
    }

    public function delete(
        PathInterface $base_path,
        ElementInterface $to_be_deleted,
        bool $props_from_data = false
    ): ?FlexibleModal {
        if (!$this->isDeletable($to_be_deleted)) {
            return null;
        }

        $action = $this->link_provider->delete(
            $base_path,
            $to_be_deleted
        );

        $items = [];
        $index = 0;
        if ($props_from_data) {
            $content = $this->properties_fetcher->getPropertiesByData($to_be_deleted);
        } else {
            $content = $this->properties_fetcher->getPropertiesByPreview($to_be_deleted);
        }
        foreach ($content as $key => $value) {
            $items[] = $this->factory->modal()->interruptiveItem()->keyValue(
                'md_delete_' . $index,
                $this->presenter->utilities()->shortenString($key, self::MAX_LENGTH),
                $this->presenter->utilities()->shortenString($value, self::MAX_LENGTH),
            );
            $index++;
        }

        $modal = $this->factory->modal()->interruptive(
            $this->getModalTitle(
                Command::DELETE_FULL,
                $to_be_deleted
            ),
            $this->presenter->utilities()->txt('meta_delete_confirm'),
            (string) $action
        )->withAffectedItems($items);

        return new FlexibleModal($modal);
    }

    public function update(
        PathInterface $base_path,
        ElementInterface $to_be_updated,
        ?RequestForFormInterface $request = null
    ): FlexibleModal {
        $form = $this->form_factory->getUpdateForm(
            $base_path,
            $to_be_updated,
            false
        );
        $modal = $this->getRoundtripModal(
            $to_be_updated,
            $form,
            Command::UPDATE_FULL,
            $request
        );

        return new FlexibleModal($modal);
    }

    public function create(
        PathInterface $base_path,
        ElementInterface $to_be_created,
        ?RequestForFormInterface $request = null
    ): FlexibleModal {
        $form = $this->form_factory->getCreateForm(
            $base_path,
            $to_be_created,
            false
        );
        // if the modal is empty, directly return the form action
        if (empty($form->getInputs())) {
            return new FlexibleModal($form->getPostURL());
        }

        $modal = $this->getRoundtripModal(
            $to_be_created,
            $form,
            Command::CREATE_FULL,
            $request
        );

        return new FlexibleModal($modal);
    }

    protected function getRoundtripModal(
        ElementInterface $element,
        StandardForm $form,
        Command $action_cmd,
        ?RequestForFormInterface $request
    ): RoundtripModal {
        $modal = $this->factory->modal()->roundtrip(
            $this->getModalTitle($action_cmd, $element),
            null,
            $form->getInputs(),
            $form->getPostURL()
        );
        return $this->handleError($modal, $element, $request);
    }

    protected function handleError(
        RoundtripModal $modal,
        ElementInterface $element,
        ?RequestForFormInterface $request
    ): RoundtripModal {
        if (is_null($request)) {
            return $modal;
        }
        $action_path = $this->path_factory->toElement($element, true);
        if (strtolower($action_path->toString()) !== strtolower($request->path()?->toString() ?? '')) {
            $request = null;
        }
        // For error handling, make the modal open on load and pass request
        if ($request) {
            $modal = $request->applyRequestToModal($modal);

            /*
             * Show error message in a box, since KS groups don't pass along
             * errors on their own.
             */
            if (
                ($group = $modal->getInputs()[0]) instanceof Group &&
                $error = $group->getError()
            ) {
                $modal = $this->factory->modal()->roundtrip(
                    $modal->getTitle(),
                    [$this->factory->messageBox()->failure($error)],
                    $modal->getInputs(),
                    $modal->getPostURL()
                );
                $modal = $request->applyRequestToModal($modal);
            }

            $modal = $modal->withOnLoad($modal->getShowSignal());
        }
        return $modal;
    }

    protected function getModalTitle(
        Command $action_cmd,
        ElementInterface $element
    ): string {
        switch ($action_cmd) {
            case Command::UPDATE_FULL:
                $title_key = 'meta_edit_element';
                break;

            case Command::CREATE_FULL:
                $title_key = 'meta_add_element';
                break;

            case Command::DELETE_FULL:
                $title_key = 'meta_delete_element';
                break;

            default:
                throw new \ilMDEditorException(
                    'Invalid action: ' . $action_cmd->name
                );
        }
        return $this->presenter->utilities()->txtFill(
            $title_key,
            $this->presenter->elements()->nameWithParents(
                $element,
                null,
                false,
                true
            )
        );
    }

    protected function isDeletable(ElementInterface $element): bool
    {
        foreach ($this->constraint_dictionary->tagsForElement($element) as $tag) {
            if ($tag->restriction() === Restriction::NOT_DELETABLE) {
                return false;
            }
        }
        return true;
    }
}