Collaboration diagram for ilBuddySystemRelation:

Public Member Functions
	__construct (ilBuddySystemRelationState $state)
	ilBuddySystemRelation constructor. More...

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

	getState ()

	getPriorState ()

	isOwnedByActor ()

	setIsOwnedByActor (bool $isOwnedByActor)

	getBuddyUsrId ()

	setBuddyUsrId (int $buddyUsrId)

	getUsrId ()

	setUsrId (int $usrId)

	getTimestamp ()

	setTimestamp (int $timestamp)

	getCurrentPossibleTargetStates ()

	link ()

	unlink ()

	request ()

	ignore ()

	isLinked ()

	isUnlinked ()

	isRequested ()

	isIgnored ()

	wasLinked ()

	wasUnlinked ()

	wasRequested ()

	wasIgnored ()

Protected Attributes
	$isOwnedByActor = false

	$usrId

	$buddyUsrId

	$timestamp

	$state

	$priorState

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 8 of file class.ilBuddySystemRelation.php.

Constructor & Destructor Documentation

◆ __construct()

ilBuddySystemRelation::__construct ( ilBuddySystemRelationState $state )

ilBuddySystemRelation constructor.

Parameters

ilBuddySystemRelationState $state

Definition at line 32 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 ( )

Returns: int

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

                                    : int
    {
        return $this->buddyUsrId;
    }

References $buddyUsrId.

Referenced by ilBuddySystemRelationRepository\addToApprovedBuddies(), ilBuddySystemRelationRepository\addToRequestedBuddies(), ilBuddyList\getIgnoredRelationsForOwner(), ilBuddyList\getRelationTargetUserId(), ilBuddyList\getRequestRelationsForOwner(), ignore(), link(), ilBuddySystemRelationRepository\removeFromApprovedBuddies(), ilBuddySystemRelationRepository\removeFromRequestedBuddies(), request(), ilBuddySystemGUI\requestCommand(), and unlink().

Here is the caller graph for this function:

◆ getCurrentPossibleTargetStates()

ilBuddySystemRelation::getCurrentPossibleTargetStates ( )

Returns: ilBuddySystemCollection

Definition at line 153 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 ( )

Returns: ilBuddySystemRelationState|null

Definition at line 63 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 ( )

Returns: ilBuddySystemRelationState

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

                               : ilBuddySystemRelationState
    {
        return $this->state;
    }

References $state.

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

Here is the caller graph for this function:

◆ getTimestamp()

ilBuddySystemRelation::getTimestamp ( )

Returns: int

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

                                   : int
    {
        return $this->timestamp;
    }

References $timestamp.

Referenced by ilBuddySystemRelationRepository\addToApprovedBuddies(), ilBuddySystemRelationRepository\addToRequestedBuddies(), and ILIAS\Contact\Provider\ContactNotificationProvider\getNotifications().

Here is the caller graph for this function:

◆ getUsrId()

ilBuddySystemRelation::getUsrId ( )

Returns: int

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

                               : int
    {
        return $this->usrId;
    }

References $usrId.

Referenced by ilBuddySystemRelationRepository\addToApprovedBuddies(), ilBuddySystemRelationRepository\addToRequestedBuddies(), ilBuddyList\getIgnoredRelationsByOwner(), ilBuddyList\getRelationTargetUserId(), ilBuddyList\getRequestRelationsByOwner(), ignore(), ilBuddyList\ignore(), link(), ilBuddyList\link(), ilBuddySystemRelationRepository\removeFromApprovedBuddies(), ilBuddySystemRelationRepository\removeFromRequestedBuddies(), request(), and unlink().

Here is the caller graph for this function:

◆ ignore()

ilBuddySystemRelation::ignore ( )

Returns: self

Exceptions

ilBuddySystemRelationStateException

Definition at line 204 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().

Referenced by ilBuddyList\ignore().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isIgnored()

ilBuddySystemRelation::isIgnored ( )

Returns: bool

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

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

References getState().

Referenced by ilBuddyList\getIgnoredRelations(), ilBuddyList\ignore(), and ilBuddySystemRelationRepository\save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isLinked()

ilBuddySystemRelation::isLinked ( )

Returns: bool

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

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

References getState().

Referenced by ilBuddyList\getLinkedRelations(), ilBuddyList\ignore(), ilBuddyList\link(), and ilBuddySystemRelationRepository\save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isOwnedByActor()

ilBuddySystemRelation::isOwnedByActor ( )

Returns: bool

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

                                     : bool
    {
        return $this->isOwnedByActor;
    }

References $isOwnedByActor.

Referenced by ilBuddySystemIgnoredRequestRelationStateTableFilterMapper\filterMatchesRelation(), ilBuddySystemRequestedRelationStateTableFilterMapper\filterMatchesRelation(), and setIsOwnedByActor().

Here is the caller graph for this function:

◆ isRequested()

ilBuddySystemRelation::isRequested ( )

Returns: bool

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

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

References getState().

Referenced by ilBuddyList\getRequestedRelations(), ilBuddyList\request(), and ilBuddySystemRelationRepository\save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isUnlinked()

ilBuddySystemRelation::isUnlinked ( )

Returns: bool

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

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

References getState().

Referenced by ilBuddySystemGUI\requestCommand(), and ilBuddyList\unlink().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ link()

ilBuddySystemRelation::link ( )

Returns: self

Exceptions

ilBuddySystemRelationStateException

Definition at line 162 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().

Referenced by ilBuddyList\link().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ request()

ilBuddySystemRelation::request ( )

Returns: self

Exceptions

ilBuddySystemRelationStateException

Definition at line 190 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().

Referenced by ilBuddyList\request().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBuddyUsrId()

ilBuddySystemRelation::setBuddyUsrId ( int $buddyUsrId )

Parameters

int $buddyUsrId

Returns: self

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

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

References $buddyUsrId.

Referenced by ilBuddyListTest\testAlreadyGivenStateExceptionIsThrownWhenALinkedRelationShouldBeMarkedAsLinked(), ilBuddyListTest\testAlreadyGivenStateExceptionIsThrownWhenAnIgnoredRelationShouldBeMarkedAsIgnored(), ilBuddyListTest\testAlreadyGivenStateExceptionIsThrownWhenAnUnlinkedRelationShouldBeMarkedAsUnlinked(), ilBuddyListTest\testAlreadyGivenStateExceptionIsThrownWhenARequestedRelationShouldBeMarkedAsRequested(), and ilBuddyListTest\testStateTransitionExceptionIsThrownWhenALinkedRelationShouldBeMarkedAsIgnored().

Here is the caller graph for this function:

◆ setIsOwnedByActor()

ilBuddySystemRelation::setIsOwnedByActor ( bool $isOwnedByActor )

Parameters

bool $isOwnedByActor

Returns: ilBuddySystemRelation

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

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

References $isOwnedByActor, and isOwnedByActor().

Here is the call graph for this function:

◆ setPriorState()

ilBuddySystemRelation::setPriorState ( ilBuddySystemRelationState $prior_state )

private

Parameters

ilBuddySystemRelationState $prior_state

Returns: ilBuddySystemRelation

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

                                                                            : self
    {
        $this->priorState = $prior_state;
        return $this;
    }

Referenced by setState().

Here is the caller graph for this function:

◆ setState()

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

Parameters

ilBuddySystemRelationState	$state
	$rememberPriorState	boolean

Returns: self

Definition at line 42 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(), ilBuddySystemRequestedRelationState\ignore(), ilBuddySystemIgnoredRequestRelationState\link(), ilBuddySystemRequestedRelationState\link(), ilBuddySystemUnlinkedRelationState\request(), ilBuddySystemIgnoredRequestRelationState\unlink(), ilBuddySystemLinkedRelationState\unlink(), and ilBuddySystemRequestedRelationState\unlink().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTimestamp()

ilBuddySystemRelation::setTimestamp ( int $timestamp )

Parameters

int $timestamp

Returns: self

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

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

References $timestamp.

◆ setUsrId()

ilBuddySystemRelation::setUsrId ( int $usrId )

Parameters

int $usrId

Returns: self

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

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

References $usrId.

Referenced by ilBuddyListTest\testAlreadyGivenStateExceptionIsThrownWhenALinkedRelationShouldBeMarkedAsLinked(), ilBuddyListTest\testAlreadyGivenStateExceptionIsThrownWhenAnIgnoredRelationShouldBeMarkedAsIgnored(), ilBuddyListTest\testAlreadyGivenStateExceptionIsThrownWhenAnUnlinkedRelationShouldBeMarkedAsUnlinked(), ilBuddyListTest\testAlreadyGivenStateExceptionIsThrownWhenARequestedRelationShouldBeMarkedAsRequested(), and ilBuddyListTest\testStateTransitionExceptionIsThrownWhenALinkedRelationShouldBeMarkedAsIgnored().

Here is the caller graph for this function:

◆ unlink()

ilBuddySystemRelation::unlink ( )

Returns: self

Exceptions

ilBuddySystemRelationStateException

Definition at line 176 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().

Referenced by ilBuddyList\unlink().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wasIgnored()

ilBuddySystemRelation::wasIgnored ( )

Returns: bool

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

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

References getPriorState().

Referenced by ilBuddySystemRelationRepository\save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wasLinked()

ilBuddySystemRelation::wasLinked ( )

Returns: bool

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

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

References getPriorState().

Referenced by ilBuddySystemRelationRepository\save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wasRequested()

ilBuddySystemRelation::wasRequested ( )

Returns: bool

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

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

References getPriorState().

Referenced by ilBuddySystemRelationRepository\save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wasUnlinked()

ilBuddySystemRelation::wasUnlinked ( )

Returns: bool

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

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

References getPriorState().

Here is the call graph for this function:

Field Documentation

◆ $buddyUsrId

ilBuddySystemRelation::$buddyUsrId

protected

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

Referenced by getBuddyUsrId(), and setBuddyUsrId().

◆ $isOwnedByActor

ilBuddySystemRelation::$isOwnedByActor = false

protected

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

Referenced by isOwnedByActor(), and setIsOwnedByActor().

◆ $priorState

ilBuddySystemRelation::$priorState

protected

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

Referenced by getPriorState().

◆ $state

ilBuddySystemRelation::$state

protected

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

Referenced by getState(), and setState().

◆ $timestamp

ilBuddySystemRelation::$timestamp

protected

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

Referenced by getTimestamp(), and setTimestamp().

◆ $usrId

ilBuddySystemRelation::$usrId

protected

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

Referenced by getUsrId(), and setUsrId().

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

Services/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()

◆ setBuddyUsrId()

◆ setIsOwnedByActor()

◆ setPriorState()

◆ setState()

◆ setTimestamp()

◆ setUsrId()

◆ unlink()

◆ wasIgnored()

◆ wasLinked()

◆ wasRequested()

◆ wasUnlinked()

Field Documentation

◆ $buddyUsrId

◆ $isOwnedByActor

◆ $priorState

◆ $state

◆ $timestamp

◆ $usrId