TableViewControlOrdering.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Table;

use ILIAS\UI\Component\Input\ViewControl\Sortation;
use ILIAS\UI\Implementation\Component\Input\ViewControl;
use ILIAS\UI\Component\Table\Column\Column;
use ILIAS\Data\Order;

trait TableViewControlOrdering
{
    protected ?Order $order = null;

    protected function initViewControlOrdering(): void
    {
        $this->order = $this->getOrder();
    }

    private function initialOrder(): string
    {
        $visible_cols = $this->getVisibleColumns();
        $sortable_visible_cols = array_filter(
            $visible_cols,
            static fn($c): bool => $c->isSortable()
        );
        if ($sortable_visible_cols === []) {
            return array_key_first($visible_cols);
        }
        return array_key_first($sortable_visible_cols);
    }

    protected function getViewControlOrdering(int|null $total_count): Sortation|ViewControl\Group
    {

        $sortable_visible_cols = array_filter(
            $this->getVisibleColumns(),
            static fn($c): bool => $c->isSortable()
        );

        if ($sortable_visible_cols === [] ||
            ($total_count !== null && $total_count < 2)
        ) {
            return $this->view_control_factory->group([
                $this->view_control_factory->nullControl(),
                $this->view_control_factory->nullControl()
            ]);
        }

        $sort_options = [];
        foreach ($sortable_visible_cols as $col_id => $col) {

            $order_asc = $this->data_factory->order($col_id, Order::ASC);
            $order_desc = $this->data_factory->order($col_id, Order::DESC);

            $labels = $col->getOrderingLabels();
            $sort_options[$labels[0]] = $order_asc;
            $sort_options[$labels[1]] = $order_desc;
        }

        $value = $this->getOrder()->join('', fn($ret, $key, $value) => [$key, $value]);
        return $this->view_control_factory->sortation($sort_options)
            ->withValue($value);
    }

    public function withOrder(?Order $order): self
    {
        $clone = clone $this;
        $clone->order = $order;
        return $clone;
    }

    public function getOrder(): Order
    {
        return $this->order ?? $this->data_factory->order($this->initialOrder(), Order::ASC);
    }
}