Boolean.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Table\Column;

use ILIAS\UI\Component\Table\Column as C;
use ILIAS\UI\Component\Symbol\Icon\Icon;
use ILIAS\UI\Component\Symbol\Glyph\Glyph;
use ILIAS\UI\Component\Symbol\Symbol;
use ILIAS\UI\Component\Component;

class Boolean extends Column implements C\Boolean
{
    public function __construct(
        protected \ilLanguage $lng,
        string $title,
        protected string|Icon|Glyph $true_option,
        protected string|Icon|Glyph $false_option
    ) {
        parent::__construct($lng, $title);

        if (
            ($true_option instanceof Glyph && $true_option->getAction() !== null)
            || ($false_option instanceof Glyph && $false_option->getAction() !== null)
        ) {
            throw new \LogicException(
                "If Glyps are used to indicate the state, they MUST NOT have an attached action."
            );
        }
    }

    public function format($value): string|Icon|Glyph
    {
        $this->checkBoolArg('value', $value);
        return $value ? $this->true_option : $this->false_option;
    }

    public function getOrderingLabels(): array
    {
        $column_value_true = $this->format(true);
        $column_value_false = $this->format(false);
        if($column_value_true instanceof Symbol) {
            $column_value_true = $column_value_true->getLabel();
        }
        if($column_value_false instanceof Symbol) {
            $column_value_false = $column_value_false->getLabel();
        }
        return [
            $this->asc_label ?? $column_value_true . ' ' . $this->lng->txt('order_option_first'),
            $this->desc_label ?? $column_value_false . ' ' . $this->lng->txt('order_option_first')
        ];
    }
}