TableViewControlFieldSelection.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\FieldSelection;
use ILIAS\UI\Component\Table\Column\Column;

trait TableViewControlFieldSelection
{
    protected ?array $selected_optional_column_ids = null;

    protected function initViewControlFieldSelection(array $columns): void
    {
        $this->selected_optional_column_ids = $this->filterVisibleColumnIds($columns);
    }

    protected function getViewControlFieldSelection(): ?FieldSelection
    {
        $optional_cols = $this->getOptionalColumns();
        if ($optional_cols === []) {
            return null;
        }

        return $this->view_control_factory
            ->fieldSelection(array_map(
                static fn($c): string => $c->getTitle(),
                $optional_cols
            ))
            ->withValue($this->getSelectedOptionalColumns());
    }

    protected function filterVisibleColumnIds(array $columns): array
    {
        return array_keys(
            array_filter(
                $columns,
                static fn($c): bool => $c->isInitiallyVisible()
            )
        );
    }

    public function withSelectedOptionalColumns(?array $selected_optional_column_ids): static
    {
        $clone = clone $this;
        $clone->selected_optional_column_ids = $selected_optional_column_ids;
        return $clone;
    }

    public function getSelectedOptionalColumns(): array
    {
        if (is_null($this->selected_optional_column_ids)) {
            return array_keys($this->getInitiallyVisibleColumns());
        }
        return $this->selected_optional_column_ids;
    }

    protected function getOptionalColumns(): array
    {
        return array_filter(
            $this->getColumns(),
            static fn($c): bool => $c->isOptional()
        );
    }

    protected function getInitiallyVisibleColumns(): array
    {
        return array_filter(
            $this->getOptionalColumns(),
            static fn($c): bool => $c->isInitiallyVisible()
        );
    }

    public function getVisibleColumns(): array
    {
        $visible_optional_columns = $this->getSelectedOptionalColumns();
        return array_filter(
            $this->getColumns(),
            fn(Column $col, string $col_id): bool => !$col->isOptional() || in_array($col_id, $visible_optional_columns, true),
            ARRAY_FILTER_USE_BOTH
        );
    }


}