GroupingHandler.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Course\Grouping\Table;

use ILIAS\UI\Factory as UIFactory;
use ilLanguage;
use ILIAS\UI\Component\Table\Data as DataTable;
use ILIAS\Data\Factory as DataFactory;
use ILIAS\StaticURL\Services as StaticURL;
use ILIAS\UI\Component\Table\Column\Column;
use ILIAS\UI\Component\Table\Action\Action;
use ILIAS\HTTP\Services as HTTP;
use ilObject;
use ILIAS\UI\URLBuilder;
use ILIAS\UI\URLBuilderToken;
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\UI\Component\Table\DataRetrieval;

class GroupingHandler
{
    protected const string ID = 'grouping_id';
    protected const string ACTION = 'table_action';
    protected const string NAMESPACE = 'grouping';

    public const string ACTION_DELETE = 'delete';
    public const string ACTION_EDIT = 'edit';

    public const string COL_TITLE = 'title';
    public const string COL_DESCRIPTION = 'description';
    public const string COL_SOURCE = 'source';
    public const string COL_UNIQUE_FIELD = 'unique_field';
    public const string COL_ASSIGNED_OBJS = 'assigned_objs';

    protected URLBuilder $url_builder;
    protected URLBuilderToken $action_token;
    protected URLBuilderToken $id_token;
    protected DataRetrieval $data_retrieval;

    public function __construct(
        protected string $action,
        protected int $content_obj_id,
        protected ilLanguage $lng,
        protected UIFactory $ui_factory,
        protected DataFactory $data_factory,
        protected HTTP $http,
        protected Refinery $refinery,
        StaticURL $static_url
    ) {
        $this->data_retrieval = new GroupingRetrieval(
            $this->content_obj_id,
            $this->lng,
            $this->ui_factory,
            $this->data_factory,
            $static_url
        );
    }

    public function getTable(): DataTable
    {
        return $this->ui_factory->table()->data(
            $this->data_retrieval,
            $this->lng->txt('groupings'),
            $this->buildColumns()
        )->withRequest($this->http->request())
         ->withActions($this->buildActions());
    }

    protected function buildColumns(): array
    {
        $f = $this->ui_factory->table()->column();
        $type = ilObject::_lookupType($this->content_obj_id);
        return [
            self::COL_TITLE => $f->text($this->lng->txt('title'))->withIsSortable(true),
            self::COL_DESCRIPTION => $f->text($this->lng->txt('description'))->withIsSortable(true),
            self::COL_SOURCE => $f->link($this->lng->txt('groupings_source'))->withIsSortable(true),
            self::COL_UNIQUE_FIELD => $f->text($this->lng->txt('unambiguousness'))->withIsSortable(true),
            self::COL_ASSIGNED_OBJS => $f->linkListing($this->lng->txt('groupings_assigned_obj_' . $type))->withIsSortable(true)
        ];
    }

    protected function buildActions(): array
    {
        $f = $this->ui_factory->table()->action();
        return [
            self::ACTION_EDIT => $f->single(
                $this->lng->txt('edit'),
                $this->URLBuilder()->withParameter($this->actionToken(), self::ACTION_EDIT),
                $this->IDToken()
            ),
            self::ACTION_DELETE => $f->standard(
                $this->lng->txt('delete'),
                $this->URLBuilder()->withParameter($this->actionToken(), self::ACTION_DELETE),
                $this->IDToken()
            )
        ];
    }

    protected function URLBuilder(): URLBuilder
    {
        if (!isset($this->url_builder)) {
            $this->initURLBuilderAndTokens();
        }
        return $this->url_builder;
    }

    protected function actionToken(): URLBuilderToken
    {
        if (!isset($this->action_token)) {
            $this->initURLBuilderAndTokens();
        }
        return $this->action_token;
    }

    protected function IDToken(): URLBuilderToken
    {
        if (!isset($this->id_token)) {
            $this->initURLBuilderAndTokens();
        }
        return $this->id_token;
    }

    protected function initURLBuilderAndTokens(): void
    {
        $url_builder = new URLBuilder($this->data_factory->uri(
            ltrim(ILIAS_HTTP_PATH, '/') . '/' . $this->action
        ));
        list($url_builder, $action_token, $id_token) = $url_builder->acquireParameters(
            [self::NAMESPACE],
            self::ACTION,
            self::ID
        );
        $this->url_builder = $url_builder;
        $this->action_token = $action_token;
        $this->id_token = $id_token;
    }

    public function getSelectedTableAction(): string
    {
        $action = '';
        if ($this->http->wrapper()->query()->has($this->actionToken()->getName())) {
            $action = $this->http->wrapper()->query()->retrieve(
                $this->actionToken()->getName(),
                $this->refinery->identity()
            );
        }
        return $action;
    }

    public function getSelectedGroupingIDs(): array
    {
        $grouping_ids = [];
        $data_retrieval = $this->data_retrieval;

        $retrieval_trafo = $this->refinery->byTrying([
            $this->refinery->custom()->transformation(function ($v) use ($data_retrieval) {
                if ((string) $v[0] === 'ALL_OBJECTS') {
                    return $data_retrieval->getAllGroupingIDs();
                }
                throw new \Exception('not all selected');
            }),
            $this->refinery->kindlyTo()->listOf(
                $this->refinery->kindlyTo()->int()
            )
        ]);

        if ($this->http->wrapper()->query()->has($this->IDToken()->getName())) {
            $grouping_ids = $this->http->wrapper()->query()->retrieve(
                $this->IDToken()->getName(),
                $retrieval_trafo
            );
        }

        return $grouping_ids;
    }
}