Item.php

Go to the documentation of this file.

<?php

/* Copyright (c) 2017 Alex Killing <killing@leifos.de> Extended GPL, see docs/LICENSE */

namespace ILIAS\UI\Implementation\Component\Item;

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

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

    protected $color = null;

    protected $title;

    protected $desc;

    protected $props;

    protected $actions;

    protected $lead = null;

    public function __construct($title)
    {
        if (!$title instanceof \ILIAS\UI\Component\Button\Shy) {
            $this->checkStringArg("title", $title);
        }
        $this->title = $title;
        $this->props = [];
    }

    public function getTitle()
    {
        return $this->title;
    }

    public function withDescription($desc)
    {
        $this->checkStringArg("description", $desc);
        $clone = clone $this;
        $clone->desc = $desc;
        return $clone;
    }

    public function getDescription()
    {
        return $this->desc;
    }

    public function withProperties(array $props)
    {
        $clone = clone $this;
        $clone->props = $props;
        return $clone;
    }

    public function getProperties()
    {
        return $this->props;
    }

    public function withActions(\ILIAS\UI\Component\Dropdown\Standard $actions)
    {
        $clone = clone $this;
        $clone->actions = $actions;
        return $clone;
    }

    public function getActions()
    {
        return $this->actions;
    }

    public function withColor(\ILIAS\Data\Color $color)
    {
        $clone = clone $this;
        $clone->color = $color;

        return $clone;
    }

    public function getColor()
    {
        return $this->color;
    }

    public function withLeadImage(\ILIAS\UI\Component\Image\Image $image)
    {
        $clone = clone $this;
        $clone->lead = $image;
        return $clone;
    }

    public function withLeadIcon(\ILIAS\UI\Component\Icon\Icon $icon)
    {
        $clone = clone $this;
        $clone->lead = $icon;
        return $clone;
    }

    public function withLeadText($text)
    {
        $this->checkStringArg("lead_text", $text);
        $clone = clone $this;
        $clone->lead = (string) $text;
        return $clone;
    }

    public function withNoLead()
    {
        $clone = clone $this;
        $clone->lead = null;
        return $clone;
    }

    public function getLead()
    {
        return $this->lead;
    }
}