Collaboration diagram for ilBuddySystemRelation:

Public Member Functions
	__construct (ilBuddySystemRelationState $state, protected int $usrId, protected int $buddyUsrId, protected bool $isOwnedByActor, protected int $timestamp)

	setState (ilBuddySystemRelationState $state, bool $rememberPriorState=true)

	getState ()

	getPriorState ()

	isOwnedByActor ()

	withIsOwnedByActor (bool $isOwnedByActor)

	getBuddyUsrId ()

	withBuddyUsrId (int $buddyUsrId)

	getUsrId ()

	withUsrId (int $usrId)

	getTimestamp ()

	withTimestamp (int $timestamp)

	getCurrentPossibleTargetStates ()

	link ()

	unlink ()

	request ()

	ignore ()

	isLinked ()

	isUnlinked ()

	isRequested ()

	isIgnored ()

	wasLinked ()

	wasUnlinked ()

	wasRequested ()

	wasIgnored ()

Protected Attributes
ilBuddySystemRelationState	$state

ilBuddySystemRelationState	$priorState = null

Private Member Functions
	setPriorState (ilBuddySystemRelationState $prior_state)

Detailed Description

Class ilBuddySystemRelation.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 25 of file class.ilBuddySystemRelation.php.

Constructor & Destructor Documentation

◆ __construct()

ilBuddySystemRelation::__construct	(	ilBuddySystemRelationState	$state,
		protected int	$usrId,
		protected int	$buddyUsrId,
		protected bool	$isOwnedByActor,
		protected int	$timestamp
	)

Definition at line 30 of file class.ilBuddySystemRelation.php.

      {
        $this->setState($state, false);
    }

References setState().

Here is the call graph for this function:

Member Function Documentation

◆ getBuddyUsrId()

ilBuddySystemRelation::getBuddyUsrId ( )

Definition at line 78 of file class.ilBuddySystemRelation.php.

                                   : int
    {
        return $this->buddyUsrId;
    }

Referenced by ignore(), link(), request(), and unlink().

Here is the caller graph for this function:

◆ getCurrentPossibleTargetStates()

ilBuddySystemRelation::getCurrentPossibleTargetStates ( )

Definition at line 117 of file class.ilBuddySystemRelation.php.

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

References ilBuddySystemRelationStateFilterRuleFactory\getInstance().

Here is the call graph for this function:

◆ getPriorState()

ilBuddySystemRelation::getPriorState ( )

Definition at line 60 of file class.ilBuddySystemRelation.php.

                                   : ?ilBuddySystemRelationState
    {
        return $this->priorState;
    }

References $priorState.

Referenced by wasIgnored(), wasLinked(), wasRequested(), and wasUnlinked().

Here is the caller graph for this function:

◆ getState()

ilBuddySystemRelation::getState ( )

Definition at line 55 of file class.ilBuddySystemRelation.php.

                              : ilBuddySystemRelationState
    {
        return $this->state;
    }

References $state.

Referenced by ignore(), isIgnored(), isLinked(), isRequested(), isUnlinked(), link(), request(), setState(), and unlink().

Here is the caller graph for this function:

◆ getTimestamp()

ilBuddySystemRelation::getTimestamp ( )

Definition at line 104 of file class.ilBuddySystemRelation.php.

                                  : int
    {
        return $this->timestamp;
    }

References $timestamp.

◆ getUsrId()

ilBuddySystemRelation::getUsrId ( )

Definition at line 91 of file class.ilBuddySystemRelation.php.

                              : int
    {
        return $this->usrId;
    }

Referenced by ignore(), ilBuddyList\ignore(), link(), ilBuddyList\link(), request(), and unlink().

Here is the caller graph for this function:

◆ ignore()

ilBuddySystemRelation::ignore ( )

Exceptions

ilBuddySystemRelationStateException

Definition at line 164 of file class.ilBuddySystemRelation.php.

                            : 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;
    }

References getBuddyUsrId(), getState(), and getUsrId().

Here is the call graph for this function:

◆ isIgnored()

ilBuddySystemRelation::isIgnored ( )

Definition at line 189 of file class.ilBuddySystemRelation.php.

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

References getState().

Here is the call graph for this function:

◆ isLinked()

ilBuddySystemRelation::isLinked ( )

Definition at line 174 of file class.ilBuddySystemRelation.php.

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

References getState().

Here is the call graph for this function:

◆ isOwnedByActor()

ilBuddySystemRelation::isOwnedByActor ( )

Definition at line 65 of file class.ilBuddySystemRelation.php.

                                    : bool
    {
        return $this->isOwnedByActor;
    }

◆ isRequested()

ilBuddySystemRelation::isRequested ( )

Definition at line 184 of file class.ilBuddySystemRelation.php.

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

References getState().

Here is the call graph for this function:

◆ isUnlinked()

ilBuddySystemRelation::isUnlinked ( )

Definition at line 179 of file class.ilBuddySystemRelation.php.

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

References getState().

Here is the call graph for this function:

◆ link()

ilBuddySystemRelation::link ( )

Exceptions

ilBuddySystemRelationStateException

Definition at line 125 of file class.ilBuddySystemRelation.php.

                          : 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;
    }

References getBuddyUsrId(), getState(), and getUsrId().

Here is the call graph for this function:

◆ request()

ilBuddySystemRelation::request ( )

Exceptions

ilBuddySystemRelationStateException

Definition at line 151 of file class.ilBuddySystemRelation.php.

                             : 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;
    }

References getBuddyUsrId(), getState(), and getUsrId().

Here is the call graph for this function:

◆ setPriorState()

ilBuddySystemRelation::setPriorState ( ilBuddySystemRelationState $prior_state )

private

Definition at line 40 of file class.ilBuddySystemRelation.php.

                                                                           : void
    {
        $this->priorState = $prior_state;
    }

Referenced by setState().

Here is the caller graph for this function:

◆ setState()

ilBuddySystemRelation::setState	(	ilBuddySystemRelationState	$state,
		bool	$rememberPriorState = `true`
	)

Definition at line 45 of file class.ilBuddySystemRelation.php.

                                                                                                : self
    {
        if ($rememberPriorState) {
            $this->setPriorState($this->getState());
        }
 
        $this->state = $state;
        return $this;
    }

References $state, getState(), and setPriorState().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unlink()

ilBuddySystemRelation::unlink ( )

Exceptions

ilBuddySystemRelationStateException

Definition at line 138 of file class.ilBuddySystemRelation.php.

                            : 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;
    }

References getBuddyUsrId(), getState(), and getUsrId().

Here is the call graph for this function:

◆ wasIgnored()

ilBuddySystemRelation::wasIgnored ( )

Definition at line 209 of file class.ilBuddySystemRelation.php.

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

References getPriorState().

Here is the call graph for this function:

◆ wasLinked()

ilBuddySystemRelation::wasLinked ( )

Definition at line 194 of file class.ilBuddySystemRelation.php.

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

References getPriorState().

Here is the call graph for this function:

◆ wasRequested()

ilBuddySystemRelation::wasRequested ( )

Definition at line 204 of file class.ilBuddySystemRelation.php.

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

References getPriorState().

Here is the call graph for this function:

◆ wasUnlinked()

ilBuddySystemRelation::wasUnlinked ( )

Definition at line 199 of file class.ilBuddySystemRelation.php.

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

References getPriorState().

Here is the call graph for this function:

◆ withBuddyUsrId()

ilBuddySystemRelation::withBuddyUsrId ( int $buddyUsrId )

Definition at line 83 of file class.ilBuddySystemRelation.php.

                                                   : self
    {
        $clone = clone $this;
        $clone->buddyUsrId = $buddyUsrId;
 
        return $clone;
    }

◆ withIsOwnedByActor()

ilBuddySystemRelation::withIsOwnedByActor ( bool $isOwnedByActor )

Definition at line 70 of file class.ilBuddySystemRelation.php.

                                                            : self
    {
        $clone = clone $this;
        $clone->isOwnedByActor = $isOwnedByActor;
 
        return $clone;
    }

◆ withTimestamp()

ilBuddySystemRelation::withTimestamp ( int $timestamp )

Definition at line 109 of file class.ilBuddySystemRelation.php.

                                                 : self
    {
        $clone = clone $this;
        $clone->timestamp = $timestamp;
 
        return $clone;
    }

References $timestamp.

◆ withUsrId()

ilBuddySystemRelation::withUsrId ( int $usrId )

Definition at line 96 of file class.ilBuddySystemRelation.php.

                                         : self
    {
        $clone = clone $this;
        $clone->usrId = $usrId;
 
        return $clone;
    }

Field Documentation

◆ $priorState

ilBuddySystemRelationState ilBuddySystemRelation::$priorState = null

protected

Definition at line 28 of file class.ilBuddySystemRelation.php.

Referenced by getPriorState().

◆ $state

ilBuddySystemRelationState ilBuddySystemRelation::$state

protected

Definition at line 27 of file class.ilBuddySystemRelation.php.

Referenced by getState(), and setState().

The documentation for this class was generated from the following file:

components/ILIAS/Contact/BuddySystem/classes/class.ilBuddySystemRelation.php

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getBuddyUsrId()

◆ getCurrentPossibleTargetStates()

◆ getPriorState()

◆ getState()

◆ getTimestamp()

◆ getUsrId()

◆ ignore()

◆ isIgnored()

◆ isLinked()

◆ isOwnedByActor()

◆ isRequested()

◆ isUnlinked()

◆ link()

◆ request()

◆ setPriorState()

◆ setState()

◆ unlink()

◆ wasIgnored()

◆ wasLinked()

◆ wasRequested()

◆ wasUnlinked()

◆ withBuddyUsrId()

◆ withIsOwnedByActor()

◆ withTimestamp()

◆ withUsrId()

Field Documentation

◆ $priorState

◆ $state