class.ilSamlIdpTableGUI.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
final readonly class ilSamlIdpTableGUI implements \ILIAS\UI\Component\Table\DataRetrieval, ilSamlCommands
{
    private array $idps;
    private ILIAS\UI\URLBuilder $url_builder;
    private ILIAS\UI\URLBuilderToken $action_parameter_token;
    private ILIAS\UI\URLBuilderToken $row_id_token;
 
    public function __construct(
        private ilSamlSettingsGUI $parent_gui,
        private \ILIAS\UI\Factory $ui_factory,
        private \ILIAS\UI\Renderer $ui_renderer,
        private ilLanguage $lng,
        private ilCtrlInterface $ctrl,
        private \Psr\Http\Message\ServerRequestInterface $http_request,
        private \ILIAS\Data\Factory $df,
        private string $parent_cmd,
        private bool $has_write_access
    ) {
        $this->idps = ilSamlIdp::getAllIdps();
 
        $form_action = $this->df->uri(
            ilUtil::_getHttpPath() . '/' .
            $this->ctrl->getLinkTarget($this->parent_gui, $this->parent_cmd)
        );
 
        [
            $this->url_builder,
            $this->action_parameter_token,
            $this->row_id_token
        ] = (new ILIAS\UI\URLBuilder($form_action))->acquireParameters(
            ['saml', 'idps'],
            'table_action',
            'idp_id'
        );
    }
 
    public function get(): \ILIAS\UI\Component\Table\Data
    {
        return $this->ui_factory
            ->table()
            ->data(
                $this,
                $this->lng->txt('auth_saml_idps'),
                $this->getColumnDefinition(),
            )
            ->withId(self::class)
            ->withOrder(new \ILIAS\Data\Order('title', \ILIAS\Data\Order::ASC))
            ->withActions($this->getActions())
            ->withRequest($this->http_request);
    }
 
    private function getColumnDefinition(): array
    {
        return [
            'title' => $this->ui_factory
                ->table()
                ->column()
                ->text($this->lng->txt('saml_tab_head_idp'))
                ->withIsSortable(true),
            'active' => $this->ui_factory
                ->table()
                ->column()
                ->boolean(
                    $this->lng->txt('status'),
                    $this->ui_factory->symbol()->icon()->custom(
                        'assets/images/standard/icon_ok.svg',
                        $this->lng->txt('active'),
                        'small'
                    ),
                    $this->ui_factory->symbol()->icon()->custom(
                        'assets/images/standard/icon_not_ok.svg',
                        $this->lng->txt('inactive'),
                        'small'
                    )
                )
                ->withIsSortable(true)
                ->withOrderingLabels(
                    "{$this->lng->txt('status')}, {$this->lng->txt('active')} {$this->lng->txt('order_option_first')}",
                    "{$this->lng->txt('status')}, {$this->lng->txt('inactive')} {$this->lng->txt('order_option_first')}"
                )
        ];
    }
 
    private function getActions(): array
    {
        if (!$this->has_write_access) {
            return [];
        }
 
        return [
            'edit' => $this->ui_factory->table()->action()->single(
                $this->lng->txt('edit'),
                $this->url_builder->withParameter($this->action_parameter_token, self::TABLE_ACTION_SHOW_IDP_SETTINGS),
                $this->row_id_token
            ),
            'activate' => $this->ui_factory->table()->action()->single(
                $this->lng->txt('activate'),
                $this->url_builder->withParameter($this->action_parameter_token, self::TABLE_ACTION_ACTIVATE_IDP),
                $this->row_id_token
            ),
            'deactivate' => $this->ui_factory->table()->action()->single(
                $this->lng->txt('deactivate'),
                $this->url_builder->withParameter($this->action_parameter_token, self::TABLE_ACTION_DEACTIVATE_IDP),
                $this->row_id_token
            ),
            'delete' => $this->ui_factory->table()->action()->single(
                $this->lng->txt('delete'),
                $this->url_builder->withParameter($this->action_parameter_token, self::TABLE_ACTION_CONFIRM_DELETE_IDP),
                $this->row_id_token
            )
        ];
    }
 
    private function getRecords(\ILIAS\Data\Range $range, \ILIAS\Data\Order $order): array
    {
        $records = $this->idps;
 
        [$order_field, $order_direction] = $order->join([], static function ($ret, $key, $value) {
            return [$key, $value];
        });
 
        usort($records, static function (ilSamlIdp $left, ilSamlIdp $right) use ($order_field): int {
            if ($order_field === 'title') {
                return ilStr::strCmp($left->getEntityId(), $right->getEntityId());
            }
 
            return (int) $right->isActive() <=> (int) $left->isActive();
        });
 
        if ($order_direction === \ILIAS\Data\Order::DESC) {
            $records = array_reverse($records);
        }
 
        $records = array_slice($records, $range->getStart(), $range->getLength());
 
        return $records;
    }
 
    public function getRows(
        \ILIAS\UI\Component\Table\DataRowBuilder $row_builder,
        array $visible_column_ids,
        \ILIAS\Data\Range $range,
        \ILIAS\Data\Order $order,
        ?array $filter_data,
        ?array $additional_parameters
    ): Generator {
        foreach ($this->getRecords($range, $order) as $item) {
            yield $row_builder
                ->buildDataRow((string) $item->getIdpId(), [
                    'title' => $item->getEntityId(),
                    'active' => $item->isActive()
                ])
                ->withDisabledAction(
                    'activate',
                    $item->isActive(),
                )
                ->withDisabledAction(
                    'deactivate',
                    !$item->isActive(),
                );
        }
    }
 
    public function getTotalRowCount(?array $filter_data, ?array $additional_parameters): ?int
    {
        return count($this->idps);
    }
}