class.ilBuddySystemRelation.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2015 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once 'Services/Contact/BuddySystem/interfaces/interface.ilBuddySystemRelationState.php';

class ilBuddySystemRelation
{
    protected $is_owned_by_request = false;

    protected $user_id;

    protected $buddy_user_id;

    protected $timestamp;

    protected $state;

    protected $prior_state;

    public function __construct(ilBuddySystemRelationState $state)
    {
        $this->setState($state, false);
    }

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

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

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

    public function getPriorState()
    {
        return $this->prior_state;
    }

    private function setPriorState($prior_state)
    {
        $this->prior_state = $prior_state;
    }

    public function isOwnedByRequest()
    {
        return $this->is_owned_by_request;
    }

    public function setIsOwnedByRequest($is_owned_by_request)
    {
        $this->is_owned_by_request = $is_owned_by_request;
    }

    public function getBuddyUserId()
    {
        return $this->buddy_user_id;
    }

    public function setBuddyUserId($buddy_user_id)
    {
        $this->buddy_user_id = $buddy_user_id;
        return $this;
    }

    public function getUserId()
    {
        return $this->user_id;
    }

    public function setUserId($user_id)
    {
        $this->user_id = $user_id;
        return $this;
    }

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

    public function setTimestamp($timestamp)
    {
        $this->timestamp = $timestamp;
        return $this;
    }

    public function getCurrentPossibleTargetStates()
    {
        require_once 'Services/Contact/BuddySystem/classes/states/class.ilBuddySystemRelationStateFilterRuleFactory.php';
        $state_filter = ilBuddySystemRelationStateFilterRuleFactory::getInstance()->getFilterRuleByRelation($this);
        return $state_filter->getStates();
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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