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 ($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. More...
	getRelationUserIds ()
	Returns an array of all user ids the buddy list owner has a relation with. More...
	setOwnerId ($owner_id)
	getRelationByUserId ($usr_id)
	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 ($usr_id)
static	getInstanceByGlobalUser ()

Protected Member Functions
	__construct ($owner_id)
	performLazyLoading ()
	getRelationTargetUserId (ilBuddySystemRelation $relation)

Protected Attributes
	$owner_id
	$relations
	$repository
	$relations_read = false
	$event_handler

Static Protected Attributes
static	$instances = array()

Detailed Description

Class ilBuddyList.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilBuddyList::__construct (   $owner_id )

protected

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

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

    {
        global $DIC;

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

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

Here is the call graph for this function:

Member Function Documentation

destroy()

ilBuddyList::destroy

(

)

Removes all buddy system references of the user (persistently)

Returns

self

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

References getRelations(), and getRepository().

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

Here is the call graph for this function:

getIgnoredRelations()

ilBuddyList::getIgnoredRelations

(

)

Gets all ignored relations.

Returns

ilBuddySystemRelationCollection

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

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

Referenced by getIgnoredRelationsByOwner(), and getIgnoredRelationsForOwner().

    {
        return $this->getRelations()->filter(function (ilBuddySystemRelation $relation) {
            return $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.

Returns

ilBuddySystemRelationCollection

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

References getIgnoredRelations(), getOwnerId(), and ilBuddySystemRelation\getUserId().

    {
        $owner = $this->getOwnerId();
        return $this->getIgnoredRelations()->filter(function (ilBuddySystemRelation $relation) use ($owner) {
            return $relation->getUserId() == $owner;
        });
    }

Here is the call graph for this function:

getIgnoredRelationsForOwner()

ilBuddyList::getIgnoredRelationsForOwner

(

)

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

Returns

ilBuddySystemRelationCollection

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

References ilBuddySystemRelation\getBuddyUserId(), getIgnoredRelations(), and getOwnerId().

    {
        $owner = $this->getOwnerId();
        return $this->getIgnoredRelations()->filter(function (ilBuddySystemRelation $relation) use ($owner) {
            return $relation->getBuddyUserId() == $owner;
        });
    }

Here is the call graph for this function:

getInstanceByGlobalUser()

static ilBuddyList::getInstanceByGlobalUser ( )

static

Returns

self

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

References $DIC.

Referenced by ilBuddySystemLinkButton\__construct(), ilBuddySystemGUI\__construct(), ilContactUserActionProvider\collectActionsForTargetUser(), ilMailingListsGUI\executeCommand(), ilMailSearchCoursesMembersTableGUI\fillRow(), ilAwarenessUserProviderContactRequests\getInitialUserSet(), ilAwarenessUserProviderApprovedContacts\getInitialUserSet(), ilUsersGalleryContacts\getRelationSequence(), ilMailingListsGUI\performDeleteMembers(), ilBuddySystemRelationsTableGUI\populate(), ilUsersGalleryGUI\populateTemplate(), ilMailingListsGUI\saveAssignmentForm(), ilMailFormGUI\showForm(), ilMailSearchGroupsGUI\showMembers(), ilMailSearchCoursesGUI\showMembers(), ilMailSearchGUI\showResults(), ilContactGUI\showSubTabs(), ilBuddyListTest\testInstanceCanBeCreatedByGlobalUserObject(), ilBuddyListTest\testInstanceCannotBeCreatedByAnonymousGlobalUserObject(), and ilBuddySystemGUI\transitionCommand().

    {
        global $DIC;

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

Here is the caller graph for this function:

getInstanceByUserId()

static ilBuddyList::getInstanceByUserId (   $usr_id )

static

Parameters

int

$usr_id

Returns

self

Exceptions

ilBuddySystemException

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

References ilObjUser\_isAnonymous().

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getLinkedRelations()

ilBuddyList::getLinkedRelations

(

)

Gets all linked/approved relations.

Returns

ilBuddySystemRelationCollection

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

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

    {
        return $this->getRelations()->filter(function (ilBuddySystemRelation $relation) {
            return $relation->isLinked();
        });
    }

Here is the call graph for this function:

getOwnerId()

ilBuddyList::getOwnerId

(

)

Returns the user id of the buddy list owner.

Returns

int

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

References $owner_id.

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

    {
        return $this->owner_id;
    }

Here is the caller graph for this function:

getRelationByUserId()

ilBuddyList::getRelationByUserId

(

$usr_id

)

Parameters

int

$usr_id

Exceptions

InvalidArgumentException

Returns

ilBuddySystemRelation

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

References ilBuddySystemRelationStateFactory\getInstance(), getOwnerId(), getRelations(), and time.

    {
        if (!is_numeric($usr_id)) {
            throw new InvalidArgumentException(sprintf("Please pass a numeric owner id, given: %s", var_export($usr_id, 1)));
        }

        if ($this->getRelations()->containsKey($usr_id)) {
            return $this->getRelations()->get($usr_id);
        }

        require_once 'Services/Contact/BuddySystem/classes/states/class.ilBuddySystemRelationStateFactory.php';
        $relation = new ilBuddySystemRelation(ilBuddySystemRelationStateFactory::getInstance()->getInitialState());
        $relation->setIsOwnedByRequest(true);
        $relation->setUserId($this->getOwnerId());
        $relation->setBuddyUserId($usr_id);
        $relation->setTimestamp(time());

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

        return $relation;
    }

Here is the call graph for this function:

getRelations()

ilBuddyList::getRelations

(

)

Returns

ilBuddySystemRelationCollection

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

References $relations, and performLazyLoading().

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

    {
        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

Parameters

ilBuddySystemRelation

$relation

Returns

int

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

References ilBuddySystemRelation\getBuddyUserId(), getOwnerId(), and ilBuddySystemRelation\getUserId().

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

    {
        return ($relation->getUserId() == $this->getOwnerId() ? $relation->getBuddyUserId() : $relation->getUserId());
    }

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 251 of file class.ilBuddyList.php.

References getRelations().

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

Here is the call graph for this function:

getRepository()

ilBuddyList::getRepository

(

)

Returns

ilBuddySystemRelationRepository

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

References $repository.

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

    {
        return $this->repository;
    }

Here is the caller graph for this function:

getRequestedRelations()

ilBuddyList::getRequestedRelations

(

)

Gets all requested relations.

Returns

ilBuddySystemRelationCollection

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

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

Referenced by getRequestRelationsByOwner(), and getRequestRelationsForOwner().

    {
        return $this->getRelations()->filter(function (ilBuddySystemRelation $relation) {
            return $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.

Returns

ilBuddySystemRelationCollection

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

References getOwnerId(), getRequestedRelations(), and ilBuddySystemRelation\getUserId().

    {
        $owner = $this->getOwnerId();
        return $this->getRequestedRelations()->filter(function (ilBuddySystemRelation $relation) use ($owner) {
            return $relation->getUserId() == $owner;
        });
    }

Here is the call graph for this function:

getRequestRelationsForOwner()

ilBuddyList::getRequestRelationsForOwner

(

)

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

Returns

ilBuddySystemRelationCollection

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

References ilBuddySystemRelation\getBuddyUserId(), getOwnerId(), and getRequestedRelations().

    {
        $owner = $this->getOwnerId();
        return $this->getRequestedRelations()->filter(function (ilBuddySystemRelation $relation) use ($owner) {
            return $relation->getBuddyUserId() == $owner;
        });
    }

Here is the call graph for this function:

ignore()

ilBuddyList::ignore

(

ilBuddySystemRelation

$relation

)

Parameters

ilBuddySystemRelation

$relation

Returns

self

Exceptions

ilBuddySystemException

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

References getOwnerId(), getRelations(), getRelationTargetUserId(), getRepository(), ilBuddySystemRelation\getUserId(), ilBuddySystemRelation\ignore(), ilBuddySystemRelation\isIgnored(), and ilBuddySystemRelation\isLinked().

    {
        try {
            if ($relation->isLinked()) {
                require_once 'Services/Contact/BuddySystem/exceptions/class.ilBuddySystemRelationStateTransitionException.php';
                throw new ilBuddySystemRelationStateTransitionException('buddy_bs_action_already_linked');
            }

            if ($this->getOwnerId() == $relation->getUserId()) {
                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()) {
                require_once 'Services/Contact/BuddySystem/exceptions/class.ilBuddySystemRelationStateAlreadyGivenException.php';
                throw new ilBuddySystemRelationStateAlreadyGivenException('buddy_bs_action_already_ignored');
            }

            throw $e;
        }

        return $this;
    }

Here is the call graph for this function:

link()

ilBuddyList::link

(

ilBuddySystemRelation

$relation

)

Parameters

ilBuddySystemRelation

$relation

Returns

self

Exceptions

ilBuddySystemException

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

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

    {
        try {
            if ($relation->isLinked()) {
                require_once 'Services/Contact/BuddySystem/exceptions/class.ilBuddySystemRelationStateAlreadyGivenException.php';
                throw new ilBuddySystemRelationStateAlreadyGivenException('buddy_bs_action_already_linked');
            }

            if ($this->getOwnerId() == $relation->getUserId()) {
                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);
        } catch (ilBuddySystemRelationStateException $e) {
            throw $e;
        }

        return $this;
    }

Here is the call graph for this function:

performLazyLoading()

ilBuddyList::performLazyLoading ( )

protected

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

References readFromRepository().

Referenced by getRelations().

    {
        if (!$this->relations_read) {
            $this->readFromRepository();
            $this->relations_read = true;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readFromRepository()

ilBuddyList::readFromRepository

(

)

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

References array, getRepository(), and setRelations().

Referenced by performLazyLoading().

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

Here is the call graph for this function:

Here is the caller graph for this function:

request()

ilBuddyList::request

(

ilBuddySystemRelation

$relation

)

Parameters

ilBuddySystemRelation

$relation

Returns

self

Exceptions

ilBuddySystemException

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

References ilObjUser\_isAnonymous(), ilObjUser\_lookupLogin(), array, getRelations(), getRelationTargetUserId(), getRepository(), ilBuddySystemRelation\isRequested(), and ilBuddySystemRelation\request().

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

        if (!strlen(ilObjUser::_lookupLogin($this->getRelationTargetUserId($relation)))) {
            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()) {
                require_once 'Services/Contact/BuddySystem/exceptions/class.ilBuddySystemRelationStateAlreadyGivenException.php';
                throw new ilBuddySystemRelationStateAlreadyGivenException('buddy_bs_action_already_requested');
            }

            throw $e;
        }

        $this->event_handler->raise(
            'Services/Contact',
            'contactRequested',
            array(
                'usr_id' => $this->getRelationTargetUserId($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 95 of file class.ilBuddyList.php.

References getOwnerId().

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

Here is the call graph for this function:

setOwnerId()

ilBuddyList::setOwnerId

(

$owner_id

)

Parameters

int

$owner_id

Exceptions

InvalidArgumentException

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

References $owner_id.

Referenced by __construct().

    {
        if (!is_numeric($owner_id)) {
            throw new InvalidArgumentException(sprintf("Please pass a numeric owner id, given: %s", var_export($owner_id, 1)));
        }

        $this->owner_id = $owner_id;
    }

Here is the caller graph for this function:

setRelations()

ilBuddyList::setRelations

(

ilBuddySystemRelationCollection

$relations

)

Parameters

ilBuddySystemRelationCollection

$relations

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

References $relations.

Referenced by readFromRepository().

    {
        $this->relations = $relations;
    }

Here is the caller graph for this function:

setRepository()

ilBuddyList::setRepository

(

$repository

)

Parameters

ilBuddySystemRelationRepository

$repository

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

References $repository.

Referenced by __construct().

    {
        $this->repository = $repository;
    }

Here is the caller graph for this function:

unlink()

ilBuddyList::unlink

(

ilBuddySystemRelation

$relation

)

Parameters

ilBuddySystemRelation

$relation

Exceptions

ilBuddySystemException

Returns

self

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

References getRelations(), getRelationTargetUserId(), getRepository(), ilBuddySystemRelation\isUnlinked(), and ilBuddySystemRelation\unlink().

    {
        try {
            $relation->unlink();
            $this->getRepository()->save($relation);
            $this->getRelations()->set($this->getRelationTargetUserId($relation), $relation);
        } catch (ilBuddySystemException $e) {
            if ($relation->isUnlinked()) {
                require_once 'Services/Contact/BuddySystem/exceptions/class.ilBuddySystemRelationStateAlreadyGivenException.php';
                throw new ilBuddySystemRelationStateAlreadyGivenException('buddy_bs_action_already_unlinked');
            }

            throw $e;
        }

        return $this;
    }

Here is the call graph for this function:

Field Documentation

$event_handler

ilBuddyList::$event_handler

protected

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

$instances

ilBuddyList::$instances = array()

staticprotected

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

$owner_id

int ilBuddyList::$owner_id

protected

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

Referenced by __construct(), getOwnerId(), and setOwnerId().

$relations

ilBuddyList::$relations

protected

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

Referenced by getRelations(), and setRelations().

$relations_read

ilBuddyList::$relations_read = false

protected

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

$repository

ilBuddyList::$repository

protected

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

Referenced by getRepository(), and setRepository().

---

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

• Services/Contact/BuddySystem/classes/class.ilBuddyList.php