Icon.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Symbol\Icon;

use ILIAS\UI\Component as C;
use ILIAS\UI\Implementation\Component\ComponentHelper;
use ILIAS\UI\Implementation\Component\JavaScriptBindable;

abstract class Icon implements C\Symbol\Icon\Icon
{
    use ComponentHelper;
    use JavaScriptBindable;

    protected static array $possible_sizes = array(
        self::SMALL,
        self::MEDIUM,
        self::LARGE,
        self::RESPONSIVE
    );

    protected string $name;
    protected string $label;
    protected string $size;
    protected ?string $abbreviation = null;
    protected bool $is_disabled;

    public function getName(): string
    {
        return $this->name;
    }

    public function getLabel(): string
    {
        return $this->label;
    }

    public function setLabel(string $label): void
    {
        $this->label = $label;
    }

    public function withLabel(string $label): self
    {
        $clone = clone $this;
        $clone->label = $label;
        return $clone;
    }

    public function withAbbreviation(string $abbreviation): C\Symbol\Icon\Icon
    {
        $clone = clone $this;
        $clone->abbreviation = $abbreviation;
        return $clone;
    }

    public function getAbbreviation(): ?string
    {
        return $this->abbreviation;
    }

    public function withSize(string $size): C\Symbol\Icon\Icon
    {
        $this->checkArgIsElement(
            "size",
            $size,
            self::$possible_sizes,
            implode('/', self::$possible_sizes)
        );
        $clone = clone $this;
        $clone->size = $size;
        return $clone;
    }

    public function getSize(): string
    {
        return $this->size;
    }

    public function isDisabled(): bool
    {
        return $this->is_disabled;
    }

    public function withDisabled(bool $is_disabled): C\Symbol\Icon\Icon
    {
        $clone = clone $this;
        $clone->is_disabled = $is_disabled;
        return $clone;
    }
}