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.

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

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

Here is the call graph for this function:

Member Function Documentation

◆ getBuddyUsrId()

ilBuddySystemRelation::getBuddyUsrId ( )

Definition at line 86 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(), ilMailingListsGUI\showMembersList(), and unlink().

Here is the caller graph for this function:

◆ getCurrentPossibleTargetStates()

ilBuddySystemRelation::getCurrentPossibleTargetStates ( )

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

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

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

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

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

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

                                    : bool
    {
        return $this->isOwnedByActor;
    }

References $isOwnedByActor.

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

Here is the caller graph for this function:

◆ isRequested()

ilBuddySystemRelation::isRequested ( )

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

Definition at line 191 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 134 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 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()->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:

◆ setPriorState()

ilBuddySystemRelation::setPriorState ( ilBuddySystemRelationState $prior_state )

private

Definition at line 48 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 53 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:

◆ unlink()

ilBuddySystemRelation::unlink ( )

Returns: self

Exceptions

ilBuddySystemRelationStateException

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

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

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

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

Definition at line 211 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 91 of file class.ilBuddySystemRelation.php.

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

References $buddyUsrId.

◆ withIsOwnedByActor()

ilBuddySystemRelation::withIsOwnedByActor ( bool $isOwnedByActor )

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

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

References $isOwnedByActor.

◆ withTimestamp()

ilBuddySystemRelation::withTimestamp ( int $timestamp )

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

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

References $timestamp.

◆ withUsrId()

ilBuddySystemRelation::withUsrId ( int $usrId )

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

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

References $usrId.

Field Documentation

◆ $buddyUsrId

int ilBuddySystemRelation::$buddyUsrId

protected

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

Referenced by __construct(), getBuddyUsrId(), and withBuddyUsrId().

◆ $isOwnedByActor

bool ilBuddySystemRelation::$isOwnedByActor

protected

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

Referenced by __construct(), isOwnedByActor(), and withIsOwnedByActor().

◆ $priorState

ilBuddySystemRelationState ilBuddySystemRelation::$priorState = null

protected

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

◆ $timestamp

int ilBuddySystemRelation::$timestamp

protected

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

Referenced by __construct(), getTimestamp(), and withTimestamp().

◆ $usrId

int ilBuddySystemRelation::$usrId

protected

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

Referenced by __construct(), getUsrId(), and withUsrId().

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

◆ setPriorState()

◆ setState()

◆ unlink()

◆ wasIgnored()

◆ wasLinked()

◆ wasRequested()

◆ wasUnlinked()

◆ withBuddyUsrId()

◆ withIsOwnedByActor()

◆ withTimestamp()

◆ withUsrId()

Field Documentation

◆ $buddyUsrId

◆ $isOwnedByActor

◆ $priorState

◆ $state

◆ $timestamp

◆ $usrId