Card.php

Go to the documentation of this file.

<?php

/* Copyright (c) 2016 Amstutz Timon <timon.amstutz@ilub.unibe.ch> Extended GPL, see docs/LICENSE */

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;

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

    protected $title;

    protected $header_section;

    protected $content_sections;

    protected $image;

    protected $title_action = '';

    protected $highlight = false;

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

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

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

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

        return $clone;
    }

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

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

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

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

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

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

    public function withTitleAction($action)
    {
        $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($status)
    {
        $clone = clone $this;
        $clone->highlight = $status;

        return $clone;
    }

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

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