ActionBuilder.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\components\ResourceStorage\Collections\View;

use ILIAS\UI\URLBuilderToken;
use ILIAS\UI\Implementation\Component\Dropdown\Standard;
use ILIAS\UI\Factory;
use ILIAS\Data\URI;
use ILIAS\ResourceStorage\Identification\ResourceIdentification;
use ILIAS\components\ResourceStorage\BinToHexSerializer;
use ILIAS\ResourceStorage\Services;
use ILIAS\UI\Component\Modal\Modal;
use ILIAS\UI\URLBuilder;

final class ActionBuilder
{
    use BinToHexSerializer;

    public const ACTION_UNZIP = 'unzip';
    private const ACTION_DOWNLOAD = 'download';
    private const ACTION_REMOVE = 'remove';
    private const ACTION_EDIT = 'edit';
    public const ACTION_NAMESPACE = 'rcgui';
    private array $modals = [];
    private URLBuilder $url_builder;
    private URLBuilderToken $url_token;

    public function __construct(
        private Request $request,
        private \ilCtrlInterface $ctrl,
        private Factory $ui_factory,
        private \ilLanguage $language,
        private Services $irss
    ) {
        $this->initURIBuilder();
    }

    private function initURIBuilder(): void
    {
        $uri_builder = new URLBuilder(
            new URI(
                ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTargetByClass(
                    \ilResourceCollectionGUI::class,
                    \ilResourceCollectionGUI::CMD_INDEX
                )
            )
        );
        $parameters = $uri_builder->acquireParameter(
            [self::ACTION_NAMESPACE],
            \ilResourceCollectionGUI::P_RESOURCE_ID
        );

        $this->url_builder = $parameters[0];
        $this->url_token = $parameters[1];
    }

    public function getUrlBuilder(): URLBuilder
    {
        return $this->url_builder;
    }

    public function getUrlToken(): URLBuilderToken
    {
        return $this->url_token;
    }

    public function getModals(): array
    {
        return $this->modals;
    }

    public function getActions(): array
    {
        // we init the fixed actions here
        $actions[self::ACTION_DOWNLOAD] =
            $this->ui_factory->table()->action()->single(
                $this->language->txt(self::ACTION_DOWNLOAD),
                $this->url_builder->withURI($this->buildURI(\ilResourceCollectionGUI::CMD_DOWNLOAD)),
                $this->url_token
            );

        if ($this->request->canUserAdministrate()) {
            $actions[self::ACTION_REMOVE] =
                $this->ui_factory->table()->action()->standard(
                    $this->language->txt(self::ACTION_REMOVE),
                    $this->url_builder->withURI($this->buildURI(\ilResourceCollectionGUI::CMD_RENDER_CONFIRM_REMOVE)),
                    $this->url_token
                )->withAsync(true);

            $actions[self::ACTION_UNZIP] =
                $this->ui_factory->table()->action()->single(
                    $this->language->txt(self::ACTION_UNZIP),
                    $this->url_builder->withURI($this->buildURI(\ilResourceCollectionGUI::CMD_UNZIP)),
                    $this->url_token
                );

            $actions[self::ACTION_EDIT] =
                $this->ui_factory->table()->action()->single(
                    $this->language->txt(self::ACTION_EDIT),
                    $this->url_builder->withURI($this->buildURI(\ilResourceCollectionGUI::CMD_EDIT)),
                    $this->url_token
                )->withAsync(true);
        }

        return $actions;
    }

    public function buildDropDownForResource(
        ResourceIdentification $rid
    ): Standard {
        $items = [];
        foreach ($this->getActions() as $index => $a) {
            $revision = $this->irss->manage()->getCurrentRevision($rid);
            $mime_type = $revision->getInformation()->getMimeType();
            if ($index === self::ACTION_UNZIP
                && !in_array($mime_type, ['application/zip', 'application/x-zip-compressed'])
            ) {
                continue;
            }

            $target = $a->getTarget();
            $target = $this->url_builder->withURI($target)
                                        ->withParameter(
                                            $this->url_token,
                                            $this->hash($rid->serialize())
                                        )->buildURI();

            if (!$a->isAsync()) {
                $items[] = $this->ui_factory->link()->standard(
                    $a->getLabel(),
                    (string) $target
                );
            } else {
                $this->modals[] = $modal = $this->ui_factory->modal()->interruptive(
                    $a->getLabel(),
                    $a->getLabel(),
                    '#'
                )->withAsyncRenderUrl($target->__toString());

                $items[] = $this->ui_factory->button()->shy(
                    $a->getLabel(),
                    $modal->getShowSignal()
                );
            }
        }
        return $this->ui_factory->dropdown()->standard(
            $items
        );
    }

    private function buildURI(
        string $command
    ): URI {
        return new URI(
            ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTargetByClass(
                \ilResourceCollectionGUI::class,
                $command
            )
        );
    }
}