ilBuddyList Class Reference

Class ilBuddyList. More...

Collaboration diagram for ilBuddyList:

Public Member Functions
	reset ()
	Remove the singleton instance from static array, used for unit tests. More...
	getRepository ()
	setRepository (ilBuddySystemRelationRepository $repository)
	readFromRepository ()
	getRelations ()
	setRelations (ilBuddySystemRelationCollection $relations)
	getOwnerId ()
	Returns the user id of the buddy list owner. More...
	getLinkedRelations ()
	Gets all linked/approved relations. More...
	getRequestRelationsForOwner ()
	Gets all requested relations the buddy list owner has to interact with. More...
	getRequestRelationsByOwner ()
	Gets all requested relations the buddy list owner initiated. More...
	getRequestedRelations ()
	Gets all requested relations. More...
	getIgnoredRelationsForOwner ()
	Gets all ignored relations the buddy list owner has to interact with. More...
	getIgnoredRelationsByOwner ()
	Gets all ignored relations the buddy list owner initiated. More...
	getIgnoredRelations ()
	Gets all ignored relations: ilBuddySystemRelationCollection. More...
	getRelationUserIds ()
	Returns an array of all user ids the buddy list owner has a relation with. More...
	setOwnerId (int $ownerId)
	getRelationByUserId (int $usrId)
	link (ilBuddySystemRelation $relation)
	unlink (ilBuddySystemRelation $relation)
	request (ilBuddySystemRelation $relation)
	ignore (ilBuddySystemRelation $relation)
	destroy ()
	Removes all buddy system references of the user (persistently) More...

Static Public Member Functions
static	getInstanceByUserId (int $usrId)
static	getInstanceByGlobalUser (?ilObjUser $user=null)

Protected Member Functions
	__construct (int $ownerId, ?ilAppEventHandler $event_handler=null)
	performLazyLoading ()
	getRelationTargetUserId (ilBuddySystemRelation $relation)

Protected Attributes
int	$ownerId
ilBuddySystemRelationRepository	$repository
bool	$relationsRead = false
ilAppEventHandler	$eventHandler
ilBuddySystemRelationCollection	$relations = null

Static Protected Attributes
static array	$instances = []

Detailed Description

Class ilBuddyList.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilBuddyList::__construct ( int  $ownerId, ?ilAppEventHandler  $event_handler = null  )

protected

Definition at line 67 of file class.ilBuddyList.php.

References $DIC, getOwnerId(), setOwnerId(), and setRepository().

    {
        global $DIC;

        $this->eventHandler = $event_handler ?? $DIC['ilAppEventHandler'];

        $this->setOwnerId($ownerId);
        $this->setRepository(new ilBuddySystemRelationRepository($this->getOwnerId()));
    }

Here is the call graph for this function:

Member Function Documentation

destroy()

ilBuddyList::destroy

(

)

Removes all buddy system references of the user (persistently)

Definition at line 381 of file class.ilBuddyList.php.

References getRelations(), and getRepository().

                             : self
    {
        $this->getRepository()->destroy();
        $this->getRelations()->clear();
        return $this;
    }

Here is the call graph for this function:

getIgnoredRelations()

ilBuddyList::getIgnoredRelations

(

)

Gets all ignored relations: ilBuddySystemRelationCollection.

Definition at line 195 of file class.ilBuddyList.php.

References $relation, getRelations(), and ilBuddySystemRelation\isIgnored().

Referenced by getIgnoredRelationsByOwner(), and getIgnoredRelationsForOwner().

                                         : ilBuddySystemRelationCollection
    {
        return $this->getRelations()->filter(
            static fn(ilBuddySystemRelation $relation): bool => $relation->isIgnored()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getIgnoredRelationsByOwner()

ilBuddyList::getIgnoredRelationsByOwner

(

)

Gets all ignored relations the buddy list owner initiated.

Definition at line 185 of file class.ilBuddyList.php.

References $relation, getIgnoredRelations(), getOwnerId(), and ilBuddySystemRelation\getUsrId().

                                                : ilBuddySystemRelationCollection
    {
        return $this->getIgnoredRelations()->filter(
            fn(ilBuddySystemRelation $relation): bool => $relation->getUsrId() === $this->getOwnerId()
        );
    }

Here is the call graph for this function:

getIgnoredRelationsForOwner()

ilBuddyList::getIgnoredRelationsForOwner

(

)

Gets all ignored relations the buddy list owner has to interact with.

Definition at line 175 of file class.ilBuddyList.php.

References $relation, ilBuddySystemRelation\getBuddyUsrId(), getIgnoredRelations(), and getOwnerId().

                                                 : ilBuddySystemRelationCollection
    {
        return $this->getIgnoredRelations()->filter(
            fn(ilBuddySystemRelation $relation): bool => $relation->getBuddyUsrId() === $this->getOwnerId()
        );
    }

Here is the call graph for this function:

getInstanceByGlobalUser()

static ilBuddyList::getInstanceByGlobalUser ( ?ilObjUser  $user = null )

static

Definition at line 56 of file class.ilBuddyList.php.

References $DIC, and null.

Referenced by ilBuddySystemLinkButton\__construct(), ilBuddySystemGUI\__construct(), ILIAS\Contact\BuddySystem\Tables\RelationsTable\__construct(), ilMailSearchObjectGUI\cancel(), ilContactUserActionProvider\collectActionsForTargetUser(), ilMailingListsGUI\executeCommand(), ilMailSearchObjectMembershipsTableGUI\fillRow(), ilAwarenessUserProviderContactRequests\getInitialUserSet(), ilAwarenessUserProviderApprovedContacts\getInitialUserSet(), ILIAS\Contact\Provider\ContactNotificationProvider\getNotifications(), ilUsersGalleryContacts\getRelationSequence(), ilMailingListsGUI\performDeleteMembers(), ilMailingListsGUI\saveAssignmentForm(), ilMailFormGUI\showForm(), ilMailingListsGUI\showMembersList(), ilMailSearchGUI\showResults(), ilContactGUI\showSubTabs(), ilBuddyListTestCase\testInstanceCanBeCreatedByGlobalUserObject(), ilBuddyListTestCase\testInstanceCannotBeCreatedByAnonymousGlobalUserObject(), ilBuddySystemGUI\transitionCommand(), and ilContactGUI\updateRelationState().

                                                                           : self
    {
        global $DIC;

        if (null === $user) {
            $user = $DIC->user();
        }

        return self::getInstanceByUserId($user->getId());
    }

Here is the caller graph for this function:

getInstanceByUserId()

static ilBuddyList::getInstanceByUserId ( int  $usrId )

static

Exceptions

ilBuddySystemException

Definition at line 39 of file class.ilBuddyList.php.

References ilObjUser\_isAnonymous().

Referenced by ilContactAppEventListener\handleEvent(), ilBuddyListTestCase\testAlreadyGivenStateExceptionIsThrownWhenALinkedRelationShouldBeMarkedAsLinked(), ilBuddyListTestCase\testAlreadyGivenStateExceptionIsThrownWhenAnIgnoredRelationShouldBeMarkedAsIgnored(), ilBuddyListTestCase\testAlreadyGivenStateExceptionIsThrownWhenAnUnlinkedRelationShouldBeMarkedAsUnlinked(), ilBuddyListTestCase\testAlreadyGivenStateExceptionIsThrownWhenARequestedRelationShouldBeMarkedAsRequested(), ilBuddyListTestCase\testDifferentRelationStatesCanBeRetrieved(), ilBuddyListTestCase\testInstanceByBeCreatedBySingletonMethod(), ilBuddyListTestCase\testListIsInitiallyEmpty(), ilBuddyListTestCase\testRelationCannotBeRequestedForAnonymous(), ilBuddyListTestCase\testRelationCannotBeRequestedForUnknownUserAccounts(), ilBuddyListTestCase\testRelationRequestCanBeApprovedByTheRelationTarget(), ilBuddyListTestCase\testRelationRequestCanBeIgnoredByTheRelationTarget(), ilBuddyListTestCase\testRelationRequestCannotBeApprovedByTheRelationOwner(), ilBuddyListTestCase\testRelationRequestCannotBeIgnoredByTheRelationOwner(), ilBuddyListTestCase\testRepositoryIsEnquiredOnlyOnceToFetchRelationsWhenCalledImplicitly(), ilBuddyListTestCase\testRepositoryIsEnquiredToFetchRelationsWhenRequestedExplicitly(), ilBuddyListTestCase\testRepositoryIsEnquiredWhenBuddyListShouldBeDestroyed(), ilBuddyListTestCase\testStateTransitionExceptionIsThrownWhenALinkedRelationShouldBeMarkedAsIgnored(), ilBuddyListTestCase\testUnlinkedRelationIsReturnedWhenRelationWasRequestedForAnUnknownBuddyId(), and ilBuddyListTestCase\testValuesCanBeFetchedByGettersWhenSetBySetters().

                                                          : self
    {
        if (ilObjUser::_isAnonymous($usrId)) {
            throw new ilBuddySystemException(sprintf(
                'You cannot create an instance for the anonymous user (id: %s)',
                $usrId
            ));
        }

        if (isset(self::$instances[$usrId])) {
            return self::$instances[$usrId];
        }

        self::$instances[$usrId] = new self($usrId);
        return self::$instances[$usrId];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLinkedRelations()

ilBuddyList::getLinkedRelations

(

)

Gets all linked/approved relations.

Definition at line 135 of file class.ilBuddyList.php.

References $relation, getRelations(), and ilBuddySystemRelation\isLinked().

                                        : ilBuddySystemRelationCollection
    {
        return $this->getRelations()->filter(
            static fn(ilBuddySystemRelation $relation): bool => $relation->isLinked()
        );
    }

Here is the call graph for this function:

getOwnerId()

ilBuddyList::getOwnerId

(

)

Returns the user id of the buddy list owner.

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

References $ownerId.

Referenced by __construct(), getIgnoredRelationsByOwner(), getIgnoredRelationsForOwner(), getRelationByUserId(), getRelationTargetUserId(), getRequestRelationsByOwner(), getRequestRelationsForOwner(), ignore(), link(), and reset().

                                : int
    {
        return $this->ownerId;
    }

Here is the caller graph for this function:

getRelationByUserId()

ilBuddyList::getRelationByUserId

(

int

$usrId

)

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

References $relation, ilBuddySystemRelationStateFactory\getInstance(), getOwnerId(), and getRelations().

                                                   : ilBuddySystemRelation
    {
        if ($this->getRelations()->containsKey($usrId)) {
            return $this->getRelations()->get($usrId);
        }

        $relation = new ilBuddySystemRelation(
            ilBuddySystemRelationStateFactory::getInstance()->getInitialState(),
            $this->getOwnerId(),
            $usrId,
            true,
            time()
        );

        $this->getRelations()->set($usrId, $relation);

        return $relation;
    }

Here is the call graph for this function:

getRelations()

ilBuddyList::getRelations

(

)

Definition at line 110 of file class.ilBuddyList.php.

References $relations, null, and performLazyLoading().

Referenced by destroy(), getIgnoredRelations(), getLinkedRelations(), getRelationByUserId(), getRelationUserIds(), getRequestedRelations(), ignore(), link(), request(), and unlink().

                                  : ilBuddySystemRelationCollection
    {
        if (null === $this->relations) {
            $this->performLazyLoading();
        }

        return $this->relations;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRelationTargetUserId()

ilBuddyList::getRelationTargetUserId ( ilBuddySystemRelation  $relation )

protected

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

References ilBuddySystemRelation\getBuddyUsrId(), getOwnerId(), and ilBuddySystemRelation\getUsrId().

Referenced by ignore(), link(), request(), and unlink().

                                                                               : int
    {
        return ($relation->getUsrId() === $this->getOwnerId() ? $relation->getBuddyUsrId() : $relation->getUsrId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRelationUserIds()

ilBuddyList::getRelationUserIds

(

)

Returns an array of all user ids the buddy list owner has a relation with.

Returns

int[]

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

References getRelations().

                                        : array
    {
        return $this->getRelations()->getKeys();
    }

Here is the call graph for this function:

getRepository()

ilBuddyList::getRepository

(

)

Definition at line 87 of file class.ilBuddyList.php.

References $repository.

Referenced by destroy(), ignore(), link(), readFromRepository(), request(), and unlink().

                                   : ilBuddySystemRelationRepository
    {
        return $this->repository;
    }

Here is the caller graph for this function:

getRequestedRelations()

ilBuddyList::getRequestedRelations

(

)

Gets all requested relations.

Definition at line 165 of file class.ilBuddyList.php.

References $relation, getRelations(), and ilBuddySystemRelation\isRequested().

Referenced by getRequestRelationsByOwner(), and getRequestRelationsForOwner().

                                           : ilBuddySystemRelationCollection
    {
        return $this->getRelations()->filter(
            static fn(ilBuddySystemRelation $relation): bool => $relation->isRequested()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRequestRelationsByOwner()

ilBuddyList::getRequestRelationsByOwner

(

)

Gets all requested relations the buddy list owner initiated.

Definition at line 155 of file class.ilBuddyList.php.

References $relation, getOwnerId(), getRequestedRelations(), and ilBuddySystemRelation\getUsrId().

                                                : ilBuddySystemRelationCollection
    {
        return $this->getRequestedRelations()->filter(
            fn(ilBuddySystemRelation $relation): bool => $relation->getUsrId() === $this->getOwnerId()
        );
    }

Here is the call graph for this function:

getRequestRelationsForOwner()

ilBuddyList::getRequestRelationsForOwner

(

)

Gets all requested relations the buddy list owner has to interact with.

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

References $relation, ilBuddySystemRelation\getBuddyUsrId(), getOwnerId(), and getRequestedRelations().

                                                 : ilBuddySystemRelationCollection
    {
        return $this->getRequestedRelations()->filter(
            fn(ilBuddySystemRelation $relation): bool => $relation->getBuddyUsrId() === $this->getOwnerId()
        );
    }

Here is the call graph for this function:

ignore()

ilBuddyList::ignore

(

ilBuddySystemRelation

$relation

)

Exceptions

ilBuddySystemException

Definition at line 344 of file class.ilBuddyList.php.

References Vendor\Package\$e, getOwnerId(), getRelations(), getRelationTargetUserId(), getRepository(), ilBuddySystemRelation\getUsrId(), ilBuddySystemRelation\ignore(), ilBuddySystemRelation\isIgnored(), and ilBuddySystemRelation\isLinked().

                                                           : self
    {
        try {
            if ($relation->isLinked()) {
                throw new ilBuddySystemRelationStateTransitionException('buddy_bs_action_already_linked');
            }

            if ($this->getOwnerId() === $relation->getUsrId()) {
                throw new ilBuddySystemException('You can only ignore a request when you are not the initiator');
            }

            $relation->ignore();

            $this->getRepository()->save($relation);
            $this->getRelations()->set($this->getRelationTargetUserId($relation), $relation);
        } catch (ilBuddySystemException $e) {
            if ($relation->isIgnored()) {
                throw new ilBuddySystemRelationStateAlreadyGivenException('buddy_bs_action_already_ignored', $e->getCode(), $e);
            }

            throw $e;
        }

        $this->eventHandler->raise(
            'components/ILIAS/Contact',
            'contactIgnored',
            [
                'relation' => $relation
            ]
        );

        return $this;
    }

Here is the call graph for this function:

link()

ilBuddyList::link

(

ilBuddySystemRelation

$relation

)

Exceptions

ilBuddySystemException

Definition at line 243 of file class.ilBuddyList.php.

References getOwnerId(), getRelations(), getRelationTargetUserId(), getRepository(), ilBuddySystemRelation\getUsrId(), ilBuddySystemRelation\isLinked(), and ilBuddySystemRelation\link().

                                                         : self
    {
        if ($relation->isLinked()) {
            throw new ilBuddySystemRelationStateAlreadyGivenException('buddy_bs_action_already_linked');
        }

        if ($this->getOwnerId() === $relation->getUsrId()) {
            throw new ilBuddySystemException('You can only accept a request when you are not the initiator');
        }

        $relation->link();

        $this->getRepository()->save($relation);
        $this->getRelations()->set($this->getRelationTargetUserId($relation), $relation);

        $this->eventHandler->raise(
            'components/ILIAS/Contact',
            'relationLinked',
            [
                'relation' => $relation
            ]
        );

        return $this;
    }

Here is the call graph for this function:

performLazyLoading()

ilBuddyList::performLazyLoading ( )

protected

Definition at line 102 of file class.ilBuddyList.php.

References readFromRepository().

Referenced by getRelations().

                                           : void
    {
        if (!$this->relationsRead) {
            $this->readFromRepository();
            $this->relationsRead = true;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readFromRepository()

ilBuddyList::readFromRepository

(

)

Definition at line 97 of file class.ilBuddyList.php.

References getRepository(), and setRelations().

Referenced by performLazyLoading().

                                        : void
    {
        $this->setRelations(new ilBuddySystemRelationCollection($this->getRepository()->getAll()));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

request()

ilBuddyList::request

(

ilBuddySystemRelation

$relation

)

Exceptions

ilBuddySystemException

Definition at line 300 of file class.ilBuddyList.php.

References Vendor\Package\$e, ilObjUser\_isAnonymous(), ilObjUser\_lookupLogin(), getRelations(), getRelationTargetUserId(), getRepository(), ilBuddySystemRelation\isRequested(), and ilBuddySystemRelation\request().

                                                            : self
    {
        if (ilObjUser::_isAnonymous($this->getRelationTargetUserId($relation))) {
            throw new ilBuddySystemException(sprintf(
                'You cannot add the anonymous user to the list (id: %s)',
                $this->getRelationTargetUserId($relation)
            ));
        }

        $login = ilObjUser::_lookupLogin($this->getRelationTargetUserId($relation));
        if ($login === '') {
            throw new ilBuddySystemException(sprintf(
                'You cannot add a non existing user (id: %s)',
                $this->getRelationTargetUserId($relation)
            ));
        }

        try {
            $relation->request();
            $this->getRepository()->save($relation);
            $this->getRelations()->set($this->getRelationTargetUserId($relation), $relation);
        } catch (ilBuddySystemException $e) {
            if ($relation->isRequested()) {
                throw new ilBuddySystemRelationStateAlreadyGivenException('buddy_bs_action_already_requested', $e->getCode(), $e);
            }

            throw $e;
        }

        $this->eventHandler->raise(
            'components/ILIAS/Contact',
            'contactRequested',
            [
                'usr_id' => $this->getRelationTargetUserId($relation),
                'relation' => $relation
            ]
        );

        return $this;
    }

Here is the call graph for this function:

reset()

ilBuddyList::reset

(

)

Remove the singleton instance from static array, used for unit tests.

Definition at line 80 of file class.ilBuddyList.php.

References getOwnerId(), and null.

                           : void
    {
        $this->relationsRead = false;
        $this->relations = null;
        unset(self::$instances[$this->getOwnerId()]);
    }

Here is the call graph for this function:

setOwnerId()

ilBuddyList::setOwnerId

(

int

$ownerId

)

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

References $ownerId.

Referenced by __construct().

                                            : void
    {
        $this->ownerId = $ownerId;
    }

Here is the caller graph for this function:

setRelations()

ilBuddyList::setRelations

(

ilBuddySystemRelationCollection

$relations

)

Definition at line 119 of file class.ilBuddyList.php.

References $relations.

Referenced by readFromRepository().

                                                                            : void
    {
        $this->relations = $relations;
    }

Here is the caller graph for this function:

setRepository()

ilBuddyList::setRepository

(

ilBuddySystemRelationRepository

$repository

)

Definition at line 92 of file class.ilBuddyList.php.

References $repository, and ILIAS\UI\examples\Deck\repository().

Referenced by __construct().

                                                                              : void
    {
        $this->repository = $repository;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

unlink()

ilBuddyList::unlink

(

ilBuddySystemRelation

$relation

)

Exceptions

ilBuddySystemException

Definition at line 272 of file class.ilBuddyList.php.

References Vendor\Package\$e, getRelations(), getRelationTargetUserId(), getRepository(), ilBuddySystemRelation\isUnlinked(), and ilBuddySystemRelation\unlink().

                                                           : self
    {
        try {
            $relation->unlink();
            $this->getRepository()->save($relation);
            $this->getRelations()->set($this->getRelationTargetUserId($relation), $relation);
        } catch (ilBuddySystemException $e) {
            if ($relation->isUnlinked()) {
                throw new ilBuddySystemRelationStateAlreadyGivenException('buddy_bs_action_already_unlinked', $e->getCode(), $e);
            }

            throw $e;
        }

        $this->eventHandler->raise(
            'components/ILIAS/Contact',
            'relationUnlinked',
            [
                'relation' => $relation
            ]
        );

        return $this;
    }

Here is the call graph for this function:

Field Documentation

$eventHandler

ilAppEventHandler ilBuddyList::$eventHandler

protected

Definition at line 33 of file class.ilBuddyList.php.

$instances

array ilBuddyList::$instances = []

staticprotected

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

$ownerId

int ilBuddyList::$ownerId

protected

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

Referenced by getOwnerId(), and setOwnerId().

$relations

ilBuddySystemRelationCollection ilBuddyList::$relations = null

protected

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

Referenced by getRelations(), and setRelations().

$relationsRead

bool ilBuddyList::$relationsRead = false

protected

Definition at line 32 of file class.ilBuddyList.php.

$repository

ilBuddySystemRelationRepository ilBuddyList::$repository

protected

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

Referenced by getRepository(), and setRepository().

---

The documentation for this class was generated from the following file:

• components/ILIAS/Contact/BuddySystem/classes/class.ilBuddyList.php