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\Content;
use ILIAS\UI\Component\Button\Standard as StandardButton;
use ILIAS\UI\Component\Listing\Property as PropertyListing;
use ILIAS\UI\Component\Link\Standard as StandardLink;
use ILIAS\UI\Implementation\Component\ComponentHelper;
use ILIAS\UI\Component\Listing\Workflow;
 
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 $managing_actions = [];
    protected array $personal_status = [];
 
    protected ?Workflow\Linear $workflow = null;
 
    public function __construct(
        protected string|int $id,
        protected Symbol | Image | Shy | StandardLink | string $primary_identifier,
        protected Symbol | Image | Shy | StandardLink | string $secondary_identifier
    ) {
    }
 
    public function getId(): string|int
    {
        return $this->id;
    }
 
    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 | Content ...$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 | Content ...$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 | Content ...$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 | StandardButton | Shy ...$prio_reactions): self
    {
        $this->checkArgListElements(
            "Entity Prioritized Reactions",
            $prio_reactions,
            [Glyph::class, Tag::class, StandardButton::class, Shy::class]
        );
        $clone = clone $this;
        $clone->prio_reactions = $prio_reactions;
        return $clone;
    }
    public function getPrioritizedReactions(): array
    {
        return $this->prio_reactions;
    }
 
    public function withReactions(Glyph | Tag | Shy | StandardButton ...$reactions): self
    {
        $this->checkArgListElements(
            "Entity Reactions",
            $reactions,
            [Glyph::class, Tag::class, Shy::class, StandardButton::class]
        );
 
        $clone = clone $this;
        $clone->reactions = $reactions;
        return $clone;
    }
    public function getReactions(): array
    {
        return $this->reactions;
    }
 
    public function withAvailability(
        PropertyListing | StandardLink | Content ...$availability
    ): self {
        $clone = clone $this;
        $clone->availability = $availability;
        return $clone;
    }
    public function getAvailability(): array
    {
        return $this->availability;
    }
 
    public function withDetails(
        PropertyListing | Content ...$details
    ): self {
        $clone = clone $this;
        $clone->details = $details;
        return $clone;
    }
    public function getDetails(): array
    {
        return $this->details;
    }
 
    public function withManagingActions(Shy ...$managing_actions): static
    {
        $clone = clone $this;
        $clone->managing_actions = $managing_actions;
        return $clone;
    }
 
    public function withActions(Shy ...$actions): self
    {
        return $this->withManagingActions(...$actions);
    }
 
    public function getManagingActions(): array
    {
        return $this->managing_actions;
    }
 
    public function withPersonalStatus(
        PropertyListing | Content ...$personal_status
    ): self {
        $clone = clone $this;
        $clone->personal_status = $personal_status;
        return $clone;
    }
    public function getPersonalStatus(): array
    {
        return $this->personal_status;
    }
 
    public function withWorkflow(Workflow\Linear $workflow): static
    {
        $clone = clone $this;
        $clone->workflow = $workflow;
        return $clone;
    }
 
    public function getWorkflow(): ?Workflow\Linear
    {
        return $this->workflow;
    }
}