class.ilBuddySystemRelation.php

Go to the documentation of this file.

<?php declare(strict_types=1);
/* Copyright (c) 1998-2015 ILIAS open source, Extended GPL, see docs/LICENSE */
 
class ilBuddySystemRelation
{
    protected $isOwnedByActor = false;
 
    protected $usrId;
 
    protected $buddyUsrId;
 
    protected $timestamp;
 
    protected $state;
 
    protected $priorState;
 
    public function __construct(ilBuddySystemRelationState $state)
    {
        $this->setState($state, false);
    }
 
    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;
    }
 
    private function setPriorState(ilBuddySystemRelationState $prior_state) : self
    {
        $this->priorState = $prior_state;
        return $this;
    }
 
    public function isOwnedByActor() : bool
    {
        return $this->isOwnedByActor;
    }
 
    public function setIsOwnedByActor(bool $isOwnedByActor) : self
    {
        $this->isOwnedByActor = $isOwnedByActor;
        return $this;
    }
 
    public function getBuddyUsrId() : int
    {
        return $this->buddyUsrId;
    }
 
    public function setBuddyUsrId(int $buddyUsrId) : self
    {
        $this->buddyUsrId = $buddyUsrId;
        return $this;
    }
 
    public function getUsrId() : int
    {
        return $this->usrId;
    }
 
    public function setUsrId(int $usrId) : self
    {
        $this->usrId = $usrId;
        return $this;
    }
 
    public function getTimestamp() : int
    {
        return $this->timestamp;
    }
 
    public function setTimestamp(int $timestamp) : self
    {
        $this->timestamp = $timestamp;
        return $this;
    }
 
    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;
    }
}