Entity.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Entity;

use ILIAS\UI\Component\Entity as I;

use ILIAS\UI\Component\Image\Image;
use ILIAS\UI\Component\Symbol\Symbol;
use ILIAS\UI\Component\Symbol\Glyph\Glyph;
use ILIAS\UI\Component\Button\Shy;
use ILIAS\UI\Component\Button\Tag;
use ILIAS\UI\Component\Legacy\Legacy;
use ILIAS\UI\Component\Listing\Property as PropertyListing;
use ILIAS\UI\Component\Link\Standard as StandardLink;

use ILIAS\UI\Implementation\Component\ComponentHelper;

abstract class Entity implements I\Entity
{
    use ComponentHelper;

    protected array $blocking_conditions = [];
    protected array $featured_props = [];
    protected array $main_details = [];
    protected array $prio_reactions = [];
    protected array $reactions = [];
    protected array $availability = [];
    protected array $details = [];
    protected array $actions = [];
    protected array $personal_status = [];

    public function __construct(
        protected Symbol | Image | Shy | StandardLink | string $primary_identifier,
        protected Symbol | Image | Shy | StandardLink | string $secondary_identifier
    ) {
    }

    public function withPrimaryIdentifier(Symbol | Image | Shy | StandardLink | string $primary_identifier): self
    {
        $clone = clone $this;
        $clone->primary_identifier = $primary_identifier;
        return $clone;
    }
    public function getPrimaryIdentifier(): Symbol | Image | Shy | StandardLink | string
    {
        return $this->primary_identifier;
    }

    public function withSecondaryIdentifier(Symbol | Image | Shy | StandardLink | string $secondary_identifier): self
    {
        $clone = clone $this;
        $clone->secondary_identifier = $secondary_identifier;
        return $clone;
    }
    public function getSecondaryIdentifier(): Symbol | Image | Shy | StandardLink | string
    {
        return $this->secondary_identifier;
    }

    public function withBlockingAvailabilityConditions(
        PropertyListing | StandardLink | Legacy ...$blocking_conditions
    ): self {
        $clone = clone $this;
        $clone->blocking_conditions = $blocking_conditions;
        return $clone;
    }
    public function getBlockingAvailabilityConditions(): array
    {
        return $this->blocking_conditions;
    }

    public function withFeaturedProperties(
        PropertyListing | StandardLink | Legacy ...$featured_props
    ): self {
        $clone = clone $this;
        $clone->featured_props = $featured_props;
        return $clone;
    }
    public function getFeaturedProperties(): array
    {
        return $this->featured_props;
    }

    public function withMainDetails(
        PropertyListing | Legacy ...$main_details
    ): self {
        $clone = clone $this;
        $clone->main_details = $main_details;
        return $clone;
    }
    public function getMainDetails(): array
    {
        return $this->main_details;
    }

    public function withPrioritizedReactions(Glyph | Tag ...$prio_reactions): self
    {
        $this->checkArgListElements(
            "Entity Prioritized Reactions",
            $prio_reactions,
            [Glyph::class, Tag::class]
        );
        $clone = clone $this;
        $clone->prio_reactions = $prio_reactions;
        return $clone;
    }
    public function getPrioritizedReactions(): array
    {
        return $this->prio_reactions;
    }

    public function withReactions(Glyph | Tag ...$reactions): self
    {
        $this->checkArgListElements(
            "Entity Reactions",
            $reactions,
            [Glyph::class, Tag::class]
        );

        $clone = clone $this;
        $clone->reactions = $reactions;
        return $clone;
    }
    public function getReactions(): array
    {
        return $this->reactions;
    }

    public function withAvailability(
        PropertyListing | StandardLink | Legacy ...$availability
    ): self {
        $clone = clone $this;
        $clone->availability = $availability;
        return $clone;
    }
    public function getAvailability(): array
    {
        return $this->availability;
    }

    public function withDetails(
        PropertyListing | Legacy ...$details
    ): self {
        $clone = clone $this;
        $clone->details = $details;
        return $clone;
    }
    public function getDetails(): array
    {
        return $this->details;
    }

    public function withActions(Shy ...$actions): self
    {
        $clone = clone $this;
        $clone->actions = $actions;
        return $clone;
    }
    public function getActions(): array
    {
        return $this->actions;
    }

    public function withPersonalStatus(
        PropertyListing | Legacy ...$personal_status
    ): self {
        $clone = clone $this;
        $clone->personal_status = $personal_status;
        return $clone;
    }
    public function getPersonalStatus(): array
    {
        return $this->personal_status;
    }
}