class.ilBuddySystemRelation.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilBuddySystemRelation
{
    protected ilBuddySystemRelationState $state;
    protected ?ilBuddySystemRelationState $priorState = null;

    public function __construct(
        ilBuddySystemRelationState $state,
        protected int $usrId,
        protected int $buddyUsrId,
        protected bool $isOwnedByActor,
        protected int $timestamp
    ) {
        $this->setState($state, false);
    }

    private function setPriorState(ilBuddySystemRelationState $prior_state): void
    {
        $this->priorState = $prior_state;
    }

    public function setState(ilBuddySystemRelationState $state, bool $rememberPriorState = true): self
    {
        if ($rememberPriorState) {
            $this->setPriorState($this->getState());
        }

        $this->state = $state;
        return $this;
    }

    public function getState(): ilBuddySystemRelationState
    {
        return $this->state;
    }

    public function getPriorState(): ?ilBuddySystemRelationState
    {
        return $this->priorState;
    }

    public function isOwnedByActor(): bool
    {
        return $this->isOwnedByActor;
    }

    public function withIsOwnedByActor(bool $isOwnedByActor): self
    {
        $clone = clone $this;
        $clone->isOwnedByActor = $isOwnedByActor;

        return $clone;
    }

    public function getBuddyUsrId(): int
    {
        return $this->buddyUsrId;
    }

    public function withBuddyUsrId(int $buddyUsrId): self
    {
        $clone = clone $this;
        $clone->buddyUsrId = $buddyUsrId;

        return $clone;
    }

    public function getUsrId(): int
    {
        return $this->usrId;
    }

    public function withUsrId(int $usrId): self
    {
        $clone = clone $this;
        $clone->usrId = $usrId;

        return $clone;
    }

    public function getTimestamp(): int
    {
        return $this->timestamp;
    }

    public function withTimestamp(int $timestamp): self
    {
        $clone = clone $this;
        $clone->timestamp = $timestamp;

        return $clone;
    }

    public function getCurrentPossibleTargetStates(): ilBuddySystemCollection
    {
        return ilBuddySystemRelationStateFilterRuleFactory::getInstance()->getFilterRuleByRelation($this)->getStates();
    }

    public function link(): self
    {
        if ($this->getUsrId() === $this->getBuddyUsrId()) {
            throw new ilBuddySystemRelationStateException("Can't change a state when the requester equals the requestee.");
        }

        $this->getState()->link($this);
        return $this;
    }

    public function unlink(): self
    {
        if ($this->getUsrId() === $this->getBuddyUsrId()) {
            throw new ilBuddySystemRelationStateException("Can't change a state when the requester equals the requestee.");
        }

        $this->getState()->unlink($this);
        return $this;
    }

    public function request(): self
    {
        if ($this->getUsrId() === $this->getBuddyUsrId()) {
            throw new ilBuddySystemRelationStateException("Can't change a state when the requester equals the requestee.");
        }

        $this->getState()->request($this);
        return $this;
    }

    public function ignore(): self
    {
        if ($this->getUsrId() === $this->getBuddyUsrId()) {
            throw new ilBuddySystemRelationStateException("Can't change a state when the requester equals the requestee.");
        }

        $this->getState()->ignore($this);
        return $this;
    }

    public function isLinked(): bool
    {
        return $this->getState() instanceof ilBuddySystemLinkedRelationState;
    }

    public function isUnlinked(): bool
    {
        return $this->getState() instanceof ilBuddySystemUnlinkedRelationState;
    }

    public function isRequested(): bool
    {
        return $this->getState() instanceof ilBuddySystemRequestedRelationState;
    }

    public function isIgnored(): bool
    {
        return $this->getState() instanceof ilBuddySystemIgnoredRequestRelationState;
    }

    public function wasLinked(): bool
    {
        return $this->getPriorState() instanceof ilBuddySystemLinkedRelationState;
    }

    public function wasUnlinked(): bool
    {
        return $this->getPriorState() instanceof ilBuddySystemUnlinkedRelationState;
    }

    public function wasRequested(): bool
    {
        return $this->getPriorState() instanceof ilBuddySystemRequestedRelationState;
    }

    public function wasIgnored(): bool
    {
        return $this->getPriorState() instanceof ilBuddySystemIgnoredRequestRelationState;
    }
}