Image.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Image;

use ILIAS\UI\Component 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 Image implements C\Image\Image
{
    use ComponentHelper;
    use JavaScriptBindable;
    use Triggerer;

    private static array $types = [
            self::STANDARD,
            self::RESPONSIVE
    ];

    private string $type;
    private string $src;
    private array $additional_high_res_sources = [];
    private string $alt;
    protected ?string $action = '';

    public function __construct(string $type, string $source, string $alt)
    {
        $this->checkArgIsElement("type", $type, self::$types, "image type");

        $this->type = $type;
        $this->src = $source;
        $this->alt = $alt;
    }

    public function getType(): string
    {
        return $this->type;
    }

    public function withSource(string $source): C\Image\Image
    {
        $clone = clone $this;
        $clone->src = $source;
        return $clone;
    }

    public function getSource(): string
    {
        return $this->src;
    }

    public function withAdditionalHighResSource(string $source, int $min_width_in_pixels): C\Image\Image
    {
        $clone = clone $this;
        $clone->additional_high_res_sources[$min_width_in_pixels] = $source;
        return $clone;
    }

    public function getAdditionalHighResSources(): array
    {
        return $this->additional_high_res_sources;
    }


    public function withAlt(string $alt): C\Image\Image
    {
        $clone = clone $this;
        $clone->alt = $alt;
        return $clone;
    }

    public function getAlt(): string
    {
        return $this->alt;
    }

    public function withAction($action): C\Image\Image
    {
        $this->checkStringOrSignalArg("action", $action);
        $clone = clone $this;
        if (is_string($action)) {
            $clone->action = $action;
        } else {
            $clone->action = null;
            $clone->setTriggeredSignal($action, "click");
        }

        return $clone;
    }

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

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

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