EntriesTable.php

Go to the documentation of this file.

<?php

namespace ILIAS\GlobalScreen\UI\Footer\Entries;

use ILIAS\GlobalScreen\Scope\Footer\Collector\FooterMainCollector;
use ILIAS\GlobalScreen\Identification\IdentificationFactory;
use ILIAS\UI\Factory;
use Psr\Http\Message\ServerRequestInterface;
use ILIAS\GlobalScreen_\UI\Translator;
use ILIAS\Data\URI;
use ILIAS\UI\Component\Table\Ordering;
use ILIAS\UI\URLBuilder;
use ILIAS\UI\URLBuilderToken;
use ILIAS\GlobalScreen\Scope\MainMenu\Collector\Renderer\Hasher;
use ILIAS\UI\Component\Table\OrderingBinding;
use ILIAS\UI\Component\Table\OrderingRowBuilder;
use ILIAS\GlobalScreen\UI\Footer\Groups\Group;
use ILIAS\GlobalScreen_\UI\UIHelper;
use ILIAS\GlobalScreen\UI\Footer\Translation\TranslationsRepository;

class EntriesTable implements OrderingBinding
{
    use Hasher;
    use UIHelper   ;

    public const COLUMN_ACTIVE = 'active';
    public const COLUMN_TITLE = 'title';
    public const CLUMNS_ITEMS = 'items';
    private Factory $ui_factory;
    private ServerRequestInterface $request;
    private ?URLBuilderToken $id_token = null;
    private FooterMainCollector $collector;
    private IdentificationFactory $identification;

    public function __construct(
        private readonly Group $group,
        private readonly EntriesRepository $repository,
        private readonly TranslationsRepository $translations_repository,
        private readonly Translator $translator,
        private bool $write_access = false
    ) {
        global $DIC;
        $this->ui_factory = $DIC->ui()->factory();
        $this->request = $DIC->http()->request();
        $this->collector = $DIC->globalScreen()->collector()->footer();
        $this->identification = $DIC->globalScreen()->identification();
    }

    public function getRows(OrderingRowBuilder $row_builder, array $visible_column_ids): \Generator
    {
        $ok = $this->ok($this->ui_factory);
        $nok = $this->nok($this->ui_factory);

        foreach ($this->repository->allForParent($this->group->getId()) as $entry) {
            if ($entry->isCore()) {
                $title = $this->collector->getSingleItemFromRaw(
                    $this->identification->fromSerializedIdentification($entry->getId()),
                )->getTitle();
            } else {
                $title = $this->translations_repository->get($entry)->getDefault()?->getTranslation(
                ) ?? $entry->getTitle();
            }

            $row = $row_builder->buildOrderingRow(
                $this->hash($entry->getId()),
                [
                    self::COLUMN_TITLE => $title,
                    self::COLUMN_ACTIVE => $entry->isActive() ? $ok : $nok,
                ]
            );

            if (!$this->write_access || $entry->isCore()) {
                $row = $row->withDisabledAction('delete')
                           ->withDisabledAction('edit')
                           ->withDisabledAction('translate')
                           ->withDisabledAction('move');
            }
            if (!$this->write_access) {
                $row = $row->withDisabledAction('toggle_activation');
            }

            yield $row;
        }
    }

    public function get(
        URI $here_uri,
        URI $translations_uri
    ): Ordering {
        $uri_builder = $this->initURIBuilder($here_uri);

        return $this->ui_factory
            ->table()
            ->ordering(
                $this->group->getTitle(),
                [
                    self::COLUMN_TITLE => $this->ui_factory->table()->column()->text(
                        $this->translator->translate('title', 'entry')
                    ),
                    self::COLUMN_ACTIVE => $this->ui_factory->table()->column()->statusIcon(
                        $this->translator->translate('active', 'entry')
                    )
                ],
                $this,
                $here_uri
            )
            ->withRequest($this->request)
            ->withActions(
                [
                    'edit' => $this->ui_factory->table()->action()->single(
                        $this->translator->translate('edit', 'entry'),
                        $uri_builder->withURI($here_uri->withParameter('cmd', 'edit')),
                        $this->id_token
                    )->withAsync(true),

                    'toggle_activation' => $this->ui_factory->table()->action()->standard(
                        $this->translator->translate('toggle_activation', 'entry'),
                        $uri_builder->withURI($here_uri->withParameter('cmd', 'toggleActivation')),
                        $this->id_token
                    )->withAsync(false),

                    'delete' => $this->ui_factory->table()->action()->standard(
                        $this->translator->translate('delete', 'entry'),
                        $uri_builder->withURI($here_uri->withParameter('cmd', 'confirmDelete')),
                        $this->id_token
                    )->withAsync(true),

                    'move' => $this->ui_factory->table()->action()->standard(
                        $this->translator->translate('move', 'entry'),
                        $uri_builder->withURI($here_uri->withParameter('cmd', 'selectMove')),
                        $this->id_token
                    )->withAsync(true),

                    'translate' => $this->ui_factory->table()->action()->single(
                        $this->translator->translate('translate', 'group'),
                        $uri_builder->withURI(
                            $translations_uri->withParameter('async', 'true')->withParameter(
                                'cmd',
                                \ilFooterTranslationGUI::CMD_TRANSLATE_IN_MODAL
                            )
                        ),
                        $this->id_token
                    )->withAsync(true),
                ]
            );
    }

    protected function initURIBuilder(URI $target): URLBuilder
    {
        $url_builder = new URLBuilder(
            $target
        );

        // these are the query parameters this instance is controlling
        $query_params_namespace = ['gsfo'];
        [$url_builder, $this->id_token] = $url_builder->acquireParameters(
            $query_params_namespace,
            'entry_id'
        );
        return $url_builder;
    }

    public function getToken(URI $target): ?URLBuilderToken
    {
        $this->initURIBuilder($target);

        return $this->id_token;
    }

}