Standard.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Item;

use ILIAS\UI\Component as C;
use ILIAS\Data\Color;
use ILIAS\UI\Component\Image\Image;
use ILIAS\UI\Component\Player\Audio;
use ILIAS\UI\Component\Symbol\Icon\Icon;
use ILIAS\UI\Component\Symbol\Avatar\Avatar;
use ILIAS\UI\Component\Button\Standard as ButtonStandard;
use ILIAS\UI\Component\Link\Standard as LinkStandard;

class Standard extends Item implements C\Item\Standard
{
    protected ?Color $color = null;

    protected $lead = null;
    protected ?C\Chart\ProgressMeter\ProgressMeter $chart = null;
    protected ?Audio $audio = null;
    protected ButtonStandard|LinkStandard|null $main_action = null;

    public function withColor(Color $color): C\Item\Standard
    {
        $clone = clone $this;
        $clone->color = $color;
        return $clone;
    }

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

    public function withLeadImage(Image $image): C\Item\Standard
    {
        $clone = clone $this;
        $clone->lead = $image;
        return $clone;
    }

    public function withLeadAvatar(Avatar $avatar): C\Item\Standard
    {
        $clone = clone $this;
        $clone->lead = $avatar;
        return $clone;
    }

    public function withAudioPlayer(Audio $audio): C\Item\Standard
    {
        $clone = clone $this;
        $clone->audio = $audio;
        return $clone;
    }

    public function getAudioPlayer(): ?Audio
    {
        return $this->audio;
    }

    public function withLeadIcon(Icon $icon): C\Item\Standard
    {
        $clone = clone $this;
        $clone->lead = $icon;
        return $clone;
    }

    public function withLeadText(string $text): C\Item\Standard
    {
        $clone = clone $this;
        $clone->lead = $text;
        return $clone;
    }

    public function withNoLead(): C\Item\Standard
    {
        $clone = clone $this;
        $clone->lead = null;
        return $clone;
    }

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

    public function withProgress(C\Chart\ProgressMeter\ProgressMeter $chart): C\Item\Standard
    {
        $clone = clone $this;
        $clone->chart = $chart;
        return $clone;
    }

    public function getProgress(): ?C\Chart\ProgressMeter\ProgressMeter
    {
        return $this->chart;
    }

    public function withActions(C\Dropdown\Standard $actions): C\Item\Standard
    {
        $clone = clone $this;
        $clone->actions = $actions;
        return $clone;
    }

    public function getActions(): ?C\Dropdown\Standard
    {
        return $this->actions;
    }

    public function withMainAction(ButtonStandard|LinkStandard $button): C\Item\Standard
    {
        $clone = clone $this;
        $clone->main_action = $button;
        return $clone;
    }

    public function getMainAction(): ButtonStandard|LinkStandard|null
    {
        return $this->main_action;
    }
}