ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5
ilBuddySystemRelation Class Reference

Class ilBuddySystemRelation. More...

+ 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

Constructor & Destructor Documentation

◆ __construct()

ilBuddySystemRelation::__construct ( ilBuddySystemRelationState  $state)
Parameters
ilBuddySystemRelationState$state

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

References setState().

46  {
47  $this->setState($state, false);
48  }
setState(ilBuddySystemRelationState $state, $remember_prior_state=true)
+ Here is the call graph for this function:

Member Function Documentation

◆ getBuddyUserId()

◆ getCurrentPossibleTargetStates()

ilBuddySystemRelation::getCurrentPossibleTargetStates ( )
Returns
ilBuddySystemCollection|ilBuddySystemRelationState[]

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

References ilBuddySystemRelationStateFilterRuleFactory\getInstance().

164  {
165  require_once 'Services/Contact/BuddySystem/classes/states/class.ilBuddySystemRelationStateFilterRuleFactory.php';
166  $state_filter = ilBuddySystemRelationStateFilterRuleFactory::getInstance()->getFilterRuleByRelation($this);
167  return $state_filter->getStates();
168  }
+ 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().

+ Here is the caller graph for this function:

◆ getState()

◆ getTimestamp()

ilBuddySystemRelation::getTimestamp ( )
Returns
int

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

References $timestamp.

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

+ Here is the caller graph for this function:

◆ getUserId()

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

220  {
221  if($this->getUserId() == $this->getBuddyUserId())
222  {
223  throw new ilBuddySystemRelationStateException("Can't change a state when the requester equals the requestee.");
224  }
225 
226  $this->getState()->ignore($this);
227  return $this;
228  }
+ 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().

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

+ 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.

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

250  {
251  return $this->getState() instanceof ilBuddySystemRequestedRelationState;
252  }
+ 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().

242  {
243  return $this->getState() instanceof ilBuddySystemUnlinkedRelationState;
244  }
Class 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().

175  {
176  if($this->getUserId() == $this->getBuddyUserId())
177  {
178  throw new ilBuddySystemRelationStateException("Can't change a state when the requester equals the requestee.");
179  }
180 
181  $this->getState()->link($this);
182  return $this;
183  }
+ 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().

205  {
206  if($this->getUserId() == $this->getBuddyUserId())
207  {
208  throw new ilBuddySystemRelationStateException("Can't change a state when the requester equals the requestee.");
209  }
210 
211  $this->getState()->request($this);
212  return $this;
213  }
+ 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.

119  {
120  $this->buddy_user_id = $buddy_user_id;
121  return $this;
122  }

◆ 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.

102  {
103  $this->is_owned_by_request = $is_owned_by_request;
104  }

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

86  {
87  $this->prior_state = $prior_state;
88  }
+ Here is the caller graph for this function:

◆ setState()

ilBuddySystemRelation::setState ( ilBuddySystemRelationState  $state,
  $remember_prior_state = true 
)
Parameters
ilBuddySystemRelationState$state
$remember_prior_stateboolean
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().

56  {
57  if($remember_prior_state)
58  {
59  $this->setPriorState($this->getState());
60  }
61 
62  $this->state = $state;
63  return $this;
64  }
+ 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.

155  {
156  $this->timestamp = $timestamp;
157  return $this;
158  }

◆ setUserId()

ilBuddySystemRelation::setUserId (   $user_id)
Parameters
int$user_id
Returns
self

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

References $user_id.

137  {
138  $this->user_id = $user_id;
139  return $this;
140  }

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

190  {
191  if($this->getUserId() == $this->getBuddyUserId())
192  {
193  throw new ilBuddySystemRelationStateException("Can't change a state when the requester equals the requestee.");
194  }
195 
196  $this->getState()->unlink($this);
197  return $this;
198  }
+ 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().

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

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

282  {
283  return $this->getPriorState() instanceof ilBuddySystemRequestedRelationState;
284  }
+ 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().

274  {
275  return $this->getPriorState() instanceof ilBuddySystemUnlinkedRelationState;
276  }
Class 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: