BasicScreenContext.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\GlobalScreen\ScreenContext;

use ILIAS\Data\ReferenceId;
use ILIAS\GlobalScreen\ScreenContext\AdditionalData\Collection;

class BasicScreenContext implements ScreenContext
{
    protected ReferenceId $reference_id;
    protected Collection $additional_data;
    protected string $context_identifier = '';

    public function __construct(string $context_identifier)
    {
        $this->context_identifier = $context_identifier;
        $this->additional_data = new Collection();
        $this->reference_id = new ReferenceId(-1);
    }

    public function hasReferenceId(): bool
    {
        return $this->reference_id->toInt() > 0;
    }

    public function getReferenceId(): ReferenceId
    {
        return $this->reference_id;
    }

    public function withReferenceId(ReferenceId $reference_id): ScreenContext
    {
        if ($reference_id->toInt() < 1) {
            throw new \InvalidArgumentException('ReferenceId must be greater than 0');
        }

        $clone = clone $this;
        $clone->reference_id = $reference_id;

        return $clone;
    }

    public function withAdditionalData(Collection $collection): ScreenContext
    {
        $clone = clone $this;
        $clone->additional_data = $collection;

        return $clone;
    }

    public function getAdditionalData(): Collection
    {
        return $this->additional_data;
    }

    public function addAdditionalData(string $key, $value): ScreenContext
    {
        $this->additional_data->add($key, $value);

        return $this;
    }

    public function getUniqueContextIdentifier(): string
    {
        return $this->context_identifier;
    }
}