Card.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Card;

use ILIAS\UI\Component\Card as C;
use ILIAS\UI\Implementation\Component\ComponentHelper;
use ILIAS\UI\Component\Signal;
use ILIAS\UI\Implementation\Component\JavaScriptBindable;
use ILIAS\UI\Implementation\Component\Triggerer;
use ILIAS\UI\Component\Component;
use ILIAS\UI\Component\Image\Image;
use ILIAS\UI\Component\Button\Shy;
use ILIAS\UI\Component\Clickable;

class Card implements C\Card
{
    use ComponentHelper;
    use JavaScriptBindable;
    use Triggerer;

    protected $title;
    protected Component $header_section;

    protected array $content_sections = [];
    protected ?Image $image;

    protected $title_action = '';
    protected bool $highlight = false;

    protected array $hidden_sections = [];

    public function __construct($title, Image $image = null)
    {
        if (!$title instanceof Shy) {
            $this->checkStringArg("title", $title);
        }

        $this->title = $title;
        $this->image = $image;
    }

    public function withTitle($title): C\Card
    {
        if (!$title instanceof Shy) {
            $this->checkStringArg("title", $title);
        }

        $clone = clone $this;
        $clone->title = $title;

        return $clone;
    }

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

    public function withImage(Image $image): C\Card
    {
        $clone = clone $this;
        $clone->image = $image;
        return $clone;
    }

    public function getImage(): ?Image
    {
        return $this->image;
    }

    public function withSections(array $sections): C\Card
    {
        $classes = [Component::class];
        $this->checkArgListElements("sections", $sections, $classes);

        $clone = clone $this;
        $clone->content_sections = $sections;
        return $clone;
    }

    public function getSections(): array
    {
        return $this->content_sections;
    }

    public function withHiddenSections(array $sections): Card
    {
        $clone = clone $this;
        $clone->hidden_sections = $sections;

        return $clone;
    }

    public function getHiddenSections(): array
    {
        return $this->hidden_sections;
    }

    public function withTitleAction($action): C\Card
    {
        $this->checkStringOrSignalArg("title_action", $action);

        $clone = clone $this;
        if (is_string($action)) {
            $clone->title_action = $action;
        } else {
            $clone->title_action = null;
            $clone->setTriggeredSignal($action, "click");
        }

        return $clone;
    }

    public function getTitleAction()
    {
        if ($this->title_action !== null) {
            return $this->title_action;
        }
        return $this->getTriggeredSignalsFor("click");
    }

    public function withHighlight(bool $status): Card
    {
        $clone = clone $this;
        $clone->highlight = $status;

        return $clone;
    }

    public function isHighlighted(): bool
    {
        return $this->highlight;
    }

    public function withOnClick(Signal $signal): Clickable
    {
        return $this->withTriggeredSignal($signal, 'click');
    }
    public function appendOnClick(Signal $signal): Clickable
    {
        return $this->appendTriggeredSignal($signal, 'click');
    }
}