Collaboration diagram for ilBuddySystemRelation:

Public Member Functions
	__construct (ilBuddySystemRelationState $state, int $usrId, int $buddyUsrId, bool $isOwnedByActor, 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

int	$usrId

int	$buddyUsrId

bool	$isOwnedByActor

int	$timestamp

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,
		int	$usrId,
		int	$buddyUsrId,
		bool	$isOwnedByActor,
		int	$timestamp
	)

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

References $buddyUsrId, $isOwnedByActor, $timestamp, $usrId, isOwnedByActor(), and setState().

       {
         $this->usrId = $usrId;
         $this->buddyUsrId = $buddyUsrId;
         $this->isOwnedByActor = $isOwnedByActor;
         $this->timestamp = $timestamp;
         $this->setState($state, false);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getBuddyUsrId()

ilBuddySystemRelation::getBuddyUsrId ( )

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

References $buddyUsrId.

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

                                    : int
     {
         return $this->buddyUsrId;
     }

Here is the caller graph for this function:

◆ getCurrentPossibleTargetStates()

ilBuddySystemRelation::getCurrentPossibleTargetStates ( )

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

References ilBuddySystemRelationStateFilterRuleFactory\getInstance().

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

Here is the call graph for this function:

◆ getPriorState()

ilBuddySystemRelation::getPriorState ( )

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

References $priorState.

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

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

Here is the caller graph for this function:

◆ getState()

ilBuddySystemRelation::getState ( )

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

References $state.

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

                               : ilBuddySystemRelationState
     {
         return $this->state;
     }

Here is the caller graph for this function:

◆ getTimestamp()

ilBuddySystemRelation::getTimestamp ( )

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

References $timestamp.

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

                                   : int
     {
         return $this->timestamp;
     }

Here is the caller graph for this function:

◆ getUsrId()

ilBuddySystemRelation::getUsrId ( )

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

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().

                               : int
     {
         return $this->usrId;
     }

Here is the caller graph for this function:

◆ ignore()

ilBuddySystemRelation::ignore ( )

Returns: self

Exceptions

ilBuddySystemRelationStateException

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

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

Referenced by ilBuddyList\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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isIgnored()

ilBuddySystemRelation::isIgnored ( )

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

References getState().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isLinked()

ilBuddySystemRelation::isLinked ( )

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

References getState().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isOwnedByActor()

ilBuddySystemRelation::isOwnedByActor ( )

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

References $isOwnedByActor.

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

                                     : bool
     {
         return $this->isOwnedByActor;
     }

Here is the caller graph for this function:

◆ isRequested()

ilBuddySystemRelation::isRequested ( )

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

References getState().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isUnlinked()

ilBuddySystemRelation::isUnlinked ( )

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

References getState().

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

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

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

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

Referenced by ilBuddyList\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;
     }

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

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

Referenced by ilBuddyList\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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPriorState()

ilBuddySystemRelation::setPriorState ( ilBuddySystemRelationState $prior_state )

private

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

Referenced by setState().

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

Here is the caller graph for this function:

◆ setState()

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

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

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

Referenced by __construct(), ilBuddySystemRequestedRelationState\ignore(), ilBuddySystemIgnoredRequestRelationState\link(), ilBuddySystemRequestedRelationState\link(), ilBuddySystemUnlinkedRelationState\request(), ilBuddySystemLinkedRelationState\unlink(), ilBuddySystemIgnoredRequestRelationState\unlink(), and ilBuddySystemRequestedRelationState\unlink().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unlink()

ilBuddySystemRelation::unlink ( )

Returns: self

Exceptions

ilBuddySystemRelationStateException

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

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

Referenced by ilBuddyList\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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wasIgnored()

ilBuddySystemRelation::wasIgnored ( )

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

References getPriorState().

Referenced by ilBuddySystemRelationRepository\save().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wasLinked()

ilBuddySystemRelation::wasLinked ( )

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

References getPriorState().

Referenced by ilBuddySystemRelationRepository\save().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wasRequested()

ilBuddySystemRelation::wasRequested ( )

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

References getPriorState().

Referenced by ilBuddySystemRelationRepository\save().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wasUnlinked()

ilBuddySystemRelation::wasUnlinked ( )

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

References getPriorState().

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

Here is the call graph for this function:

◆ withBuddyUsrId()

ilBuddySystemRelation::withBuddyUsrId ( int $buddyUsrId )

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

References $buddyUsrId.

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

◆ withIsOwnedByActor()

ilBuddySystemRelation::withIsOwnedByActor ( bool $isOwnedByActor )

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

References $isOwnedByActor.

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

◆ withTimestamp()

ilBuddySystemRelation::withTimestamp ( int $timestamp )

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

References $timestamp.

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

◆ withUsrId()

ilBuddySystemRelation::withUsrId ( int $usrId )

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

References $usrId.

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