Collaboration diagram for ilBuddySystemRelation:

Public Member Functions
	__construct (ilBuddySystemRelationState $state)

	setState (ilBuddySystemRelationState $state, $remember_prior_state=true)

	getState ()

	getPriorState ()

	isOwnedByRequest ()

	setIsOwnedByRequest ($is_owned_by_request)

	getBuddyUserId ()

	setBuddyUserId ($buddy_user_id)

	getUserId ()

	setUserId ($user_id)

	getTimestamp ()

	setTimestamp ($timestamp)

	getCurrentPossibleTargetStates ()

	link ()

	unlink ()

	request ()

	ignore ()

	isLinked ()

	isUnlinked ()

	isRequested ()

	isIgnored ()

	wasLinked ()

	wasUnlinked ()

	wasRequested ()

	wasIgnored ()

Protected Attributes
	$is_owned_by_request = false

	$user_id

	$buddy_user_id

	$timestamp

	$state

	$prior_state

Private Member Functions
	setPriorState ($prior_state)

Detailed Description

Class ilBuddySystemRelation.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilBuddySystemRelation::__construct ( ilBuddySystemRelationState $state )

Parameters

ilBuddySystemRelationState $state

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

References setState().

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

Here is the call graph for this function:

Member Function Documentation

◆ getBuddyUserId()

ilBuddySystemRelation::getBuddyUserId ( )

Returns: int

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

References $buddy_user_id.

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

         {
                 return $this->buddy_user_id;
         }

Here is the caller graph for this function:

◆ getCurrentPossibleTargetStates()

ilBuddySystemRelation::getCurrentPossibleTargetStates ( )

Returns: ilBuddySystemCollection|ilBuddySystemRelationState[]

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

References ilBuddySystemRelationStateFilterRuleFactory\getInstance().

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

Here is the call graph for this function:

◆ getPriorState()

ilBuddySystemRelation::getPriorState ( )

Returns: ilBuddySystemRelationState|null

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

References $prior_state.

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

         {
                 return $this->prior_state;
         }

Here is the caller graph for this function:

◆ getState()

ilBuddySystemRelation::getState ( )

Returns: ilBuddySystemRelationState

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

References $state.

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

         {
                 return $this->state;
         }

Here is the caller graph for this function:

◆ getTimestamp()

ilBuddySystemRelation::getTimestamp ( )

Returns: int

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

References $timestamp.

Referenced by ilBuddySystemRelationRepository\addToApprovedBuddies(), and ilBuddySystemRelationRepository\addToRequestedBuddies().

         {
                 return $this->timestamp;
         }

Here is the caller graph for this function:

◆ getUserId()

ilBuddySystemRelation::getUserId ( )

Returns: int

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

References $user_id.

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

         {
                 return $this->user_id;
         }

Here is the caller graph for this function:

◆ ignore()

ilBuddySystemRelation::ignore ( )

Exceptions

ilBuddySystemRelationStateException

Returns: self

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

References getBuddyUserId(), getState(), and getUserId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isIgnored()

ilBuddySystemRelation::isIgnored ( )

Returns: bool

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

References getState().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isLinked()

ilBuddySystemRelation::isLinked ( )

Returns: bool

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

References getState().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isOwnedByRequest()

ilBuddySystemRelation::isOwnedByRequest ( )

Returns: bool

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

References $is_owned_by_request.

         {
                 return $this->is_owned_by_request;
         }

◆ isRequested()

ilBuddySystemRelation::isRequested ( )

Returns: bool

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

References getState().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isUnlinked()

ilBuddySystemRelation::isUnlinked ( )

Returns: bool

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

References getState().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ link()

ilBuddySystemRelation::link ( )

Exceptions

ilBuddySystemRelationStateException

Returns: self

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

References getBuddyUserId(), getState(), and getUserId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ request()

ilBuddySystemRelation::request ( )

Exceptions

ilBuddySystemRelationStateException

Returns: self

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

References getBuddyUserId(), getState(), and getUserId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBuddyUserId()

ilBuddySystemRelation::setBuddyUserId ( $buddy_user_id )

Parameters

int $buddy_user_id

Returns: self

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

References $buddy_user_id.

         {
                 $this->buddy_user_id = $buddy_user_id;
                 return $this;
         }

◆ setIsOwnedByRequest()

ilBuddySystemRelation::setIsOwnedByRequest ( $is_owned_by_request )

Parameters

bool $is_owned_by_request

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

References $is_owned_by_request.

         {
                 $this->is_owned_by_request = $is_owned_by_request;
         }

◆ setPriorState()

ilBuddySystemRelation::setPriorState ( $prior_state )

private

Parameters

ilBuddySystemRelationState $prior_state

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

References $prior_state.

Referenced by setState().

         {
                 $this->prior_state = $prior_state;
         }

Here is the caller graph for this function:

◆ setState()

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

Parameters

ilBuddySystemRelationState	$state
	$remember_prior_state	boolean

Returns: self

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

         {
                 if($remember_prior_state)
                 {
                         $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:

◆ setTimestamp()

ilBuddySystemRelation::setTimestamp ( $timestamp )

Parameters

int $timestamp

Returns: self

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

References $timestamp.

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

◆ setUserId()

ilBuddySystemRelation::setUserId ( $user_id )

Parameters

int $user_id

Returns: self

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

References $user_id.

         {
                 $this->user_id = $user_id;
                 return $this;
         }

◆ unlink()

ilBuddySystemRelation::unlink ( )

Exceptions

ilBuddySystemRelationStateException

Returns: self

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

References getBuddyUserId(), getState(), and getUserId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wasIgnored()

ilBuddySystemRelation::wasIgnored ( )

Returns: bool

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

References getPriorState().

Referenced by ilBuddySystemRelationRepository\save().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wasLinked()

ilBuddySystemRelation::wasLinked ( )

Returns: bool

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

References getPriorState().

Referenced by ilBuddySystemRelationRepository\save().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wasRequested()

ilBuddySystemRelation::wasRequested ( )

Returns: bool

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

References getPriorState().

Referenced by ilBuddySystemRelationRepository\save().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wasUnlinked()

ilBuddySystemRelation::wasUnlinked ( )

Returns: bool

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

References getPriorState().

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

Here is the call graph for this function:

Field Documentation

◆ $buddy_user_id

ilBuddySystemRelation::$buddy_user_id

protected

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

Referenced by getBuddyUserId(), and setBuddyUserId().

◆ $is_owned_by_request

ilBuddySystemRelation::$is_owned_by_request = false

protected

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

Referenced by isOwnedByRequest(), and setIsOwnedByRequest().

◆ $prior_state

ilBuddySystemRelation::$prior_state

protected

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

Referenced by getPriorState(), and setPriorState().

◆ $state

ilBuddySystemRelation::$state

protected

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

Referenced by getState(), and setState().

◆ $timestamp

ilBuddySystemRelation::$timestamp

protected

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

Referenced by getTimestamp(), and setTimestamp().

◆ $user_id

ilBuddySystemRelation::$user_id

protected

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

Referenced by getUserId(), and setUserId().

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

◆ getBuddyUserId()

◆ getCurrentPossibleTargetStates()

◆ getPriorState()

◆ getState()

◆ getTimestamp()

◆ getUserId()

◆ ignore()

◆ isIgnored()

◆ isLinked()

◆ isOwnedByRequest()

◆ isRequested()

◆ isUnlinked()

◆ link()

◆ request()

◆ setBuddyUserId()

◆ setIsOwnedByRequest()

◆ setPriorState()

◆ setState()

◆ setTimestamp()

◆ setUserId()

◆ unlink()

◆ wasIgnored()

◆ wasLinked()

◆ wasRequested()

◆ wasUnlinked()

Field Documentation

◆ $buddy_user_id

◆ $is_owned_by_request

◆ $prior_state

◆ $state

◆ $timestamp

◆ $user_id