Icon.php

Go to the documentation of this file.

<?php
/* Copyright (c) 2017 Nils Haagen <nils.haagen@concepts-and-training.de> Extended GPL, see docs/LICENSE */

namespace ILIAS\UI\Implementation\Component\Icon;

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

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

    protected $name;

    protected $aria_label;

    protected $size;

    protected $abbreviation;

    protected $is_disabled;

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


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

    public function getAriaLabel()
    {
        return $this->aria_label;
    }

    public function withAbbreviation($abbreviation)
    {
        $this->checkStringArg("string", $abbreviation);
        $clone = clone $this;
        $clone->abbreviation = $abbreviation;
        return $clone;
    }

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

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

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

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

    public function withDisabled($is_disabled)
    {
        $this->checkBoolArg("is_disabled", $is_disabled);
        $clone = clone $this;
        $clone->is_disabled = $is_disabled;
        return $clone;
    }
}