ilBuddySystemRelation Class Reference

Class ilBuddySystemRelation. More...

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.

References setState().

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

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.

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

                                    : int
    {
        return $this->buddyUsrId;
    }

Here is the caller graph for this function:

getCurrentPossibleTargetStates()

ilBuddySystemRelation::getCurrentPossibleTargetStates

(

)

Returns

ilBuddySystemCollection

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

(

)

Returns

ilBuddySystemRelationState|null

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

(

)

Returns

ilBuddySystemRelationState

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

(

)

Returns

int

Definition at line 135 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

(

)

Returns

int

Definition at line 117 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 204 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

(

)

Returns

bool

Definition at line 241 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

(

)

Returns

bool

Definition at line 217 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

(

)

Returns

bool

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

References $isOwnedByActor.

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

                                     : bool
    {
        return $this->isOwnedByActor;
    }

Here is the caller graph for this function:

isRequested()

ilBuddySystemRelation::isRequested

(

)

Returns

bool

Definition at line 233 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

(

)

Returns

bool

Definition at line 225 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 162 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 190 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:

setBuddyUsrId()

ilBuddySystemRelation::setBuddyUsrId

(

int

$buddyUsrId

)

Parameters

int

$buddyUsrId

Returns

self

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

References $buddyUsrId.

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

setIsOwnedByActor()

ilBuddySystemRelation::setIsOwnedByActor

(

bool

$isOwnedByActor

)

Parameters

bool

$isOwnedByActor

Returns

ilBuddySystemRelation

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

References $isOwnedByActor, and isOwnedByActor().

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

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.

Referenced by setState().

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

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.

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:

setTimestamp()

ilBuddySystemRelation::setTimestamp

(

int

$timestamp

)

Parameters

int

$timestamp

Returns

self

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

References $timestamp.

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

setUsrId()

ilBuddySystemRelation::setUsrId

(

int

$usrId

)

Parameters

int

$usrId

Returns

self

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

References $usrId.

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

unlink()

ilBuddySystemRelation::unlink

(

)

Returns

self

Exceptions

ilBuddySystemRelationStateException

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

(

)

Returns

bool

Definition at line 273 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

(

)

Returns

bool

Definition at line 249 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

(

)

Returns

bool

Definition at line 265 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

(

)

Returns

bool

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

References getPriorState().

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

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