class.ilBuddyList.php

Go to the documentation of this file.

<?php declare(strict_types=1);
/* Copyright (c) 1998-2015 ILIAS open source, Extended GPL, see docs/LICENSE */
 
class ilBuddyList
{
    protected $ownerId;
 
    protected $relations;
 
    protected $repository;
 
    protected static $instances = [];
 
    protected $relationsRead = false;
 
    protected $eventHandler;
 
    public static function getInstanceByUserId(int $usrId) : 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];
    }
 
    public static function getInstanceByGlobalUser() : self
    {
        global $DIC;
 
        return self::getInstanceByUserId((int) $DIC->user()->getId());
    }
 
    protected function __construct(int $ownerId)
    {
        global $DIC;
 
        $this->setOwnerId($ownerId);
        $this->setRepository(new ilBuddySystemRelationRepository($this->getOwnerId()));
 
        $this->eventHandler = $DIC['ilAppEventHandler'];
    }
 
    public function reset() : void
    {
        $this->relationsRead = false;
        $this->relations = null;
        unset(self::$instances[$this->getOwnerId()]);
    }
 
    public function getRepository() : ilBuddySystemRelationRepository
    {
        return $this->repository;
    }
 
    public function setRepository(ilBuddySystemRelationRepository $repository) : void
    {
        $this->repository = $repository;
    }
 
    public function readFromRepository() : void
    {
        $this->setRelations(new ilBuddySystemRelationCollection((array) $this->getRepository()->getAll()));
    }
 
    protected function performLazyLoading() : void
    {
        if (!$this->relationsRead) {
            $this->readFromRepository();
            $this->relationsRead = true;
        }
    }
 
    public function getRelations() : ilBuddySystemRelationCollection
    {
        if (null === $this->relations) {
            $this->performLazyLoading();
        }
 
        return $this->relations;
    }
 
    public function setRelations(ilBuddySystemRelationCollection $relations) : void
    {
        $this->relations = $relations;
    }
 
    public function getOwnerId() : int
    {
        return $this->ownerId;
    }
 
    public function getLinkedRelations() : ilBuddySystemRelationCollection
    {
        return $this->getRelations()->filter(function (ilBuddySystemRelation $relation) {
            return $relation->isLinked();
        });
    }
 
    public function getRequestRelationsForOwner() : ilBuddySystemRelationCollection
    {
        return $this->getRequestedRelations()->filter(function (ilBuddySystemRelation $relation) {
            return $relation->getBuddyUsrId() === $this->getOwnerId();
        });
    }
 
    public function getRequestRelationsByOwner() : ilBuddySystemRelationCollection
    {
        return $this->getRequestedRelations()->filter(function (ilBuddySystemRelation $relation) {
            return $relation->getUsrId() === $this->getOwnerId();
        });
    }
 
    public function getRequestedRelations() : ilBuddySystemRelationCollection
    {
        return $this->getRelations()->filter(function (ilBuddySystemRelation $relation) {
            return $relation->isRequested();
        });
    }
 
    public function getIgnoredRelationsForOwner() : ilBuddySystemRelationCollection
    {
        return $this->getIgnoredRelations()->filter(function (ilBuddySystemRelation $relation) {
            return $relation->getBuddyUsrId() === $this->getOwnerId();
        });
    }
 
    public function getIgnoredRelationsByOwner() : ilBuddySystemRelationCollection
    {
        return $this->getIgnoredRelations()->filter(function (ilBuddySystemRelation $relation) {
            return $relation->getUsrId() === $this->getOwnerId();
        });
    }
 
    public function getIgnoredRelations() : ilBuddySystemRelationCollection
    {
        return $this->getRelations()->filter(function (ilBuddySystemRelation $relation) {
            return $relation->isIgnored();
        });
    }
 
    public function getRelationUserIds() : array
    {
        return $this->getRelations()->getKeys();
    }
 
    public function setOwnerId(int $ownerId) : void
    {
        $this->ownerId = $ownerId;
    }
 
    protected function getRelationTargetUserId(ilBuddySystemRelation $relation) : int
    {
        return ($relation->getUsrId() === $this->getOwnerId() ? $relation->getBuddyUsrId() : $relation->getUsrId());
    }
 
    public function getRelationByUserId(int $usrId) : ilBuddySystemRelation
    {
        if ($this->getRelations()->containsKey($usrId)) {
            return $this->getRelations()->get($usrId);
        }
 
        $relation = new ilBuddySystemRelation(ilBuddySystemRelationStateFactory::getInstance()->getInitialState());
        $relation->setIsOwnedByActor(true);
        $relation->setUsrId($this->getOwnerId());
        $relation->setBuddyUsrId($usrId);
        $relation->setTimestamp(time());
 
        $this->getRelations()->set($usrId, $relation);
 
        return $relation;
    }
 
    public function link(ilBuddySystemRelation $relation) : self
    {
        try {
            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);
        } catch (ilBuddySystemRelationStateException $e) {
            throw $e;
        }
 
        return $this;
    }
 
    public function unlink(ilBuddySystemRelation $relation) : 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');
            }
 
            throw $e;
        }
 
        return $this;
    }
 
    public function request(ilBuddySystemRelation $relation) : 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)
            ));
        }
 
        if (!strlen((string) 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()) {
                throw new ilBuddySystemRelationStateAlreadyGivenException('buddy_bs_action_already_requested');
            }
 
            throw $e;
        }
 
        $this->eventHandler->raise(
            'Services/Contact',
            'contactRequested',
            [
                'usr_id' => $this->getRelationTargetUserId($relation)
            ]
        );
 
        return $this;
    }
 
    public function ignore(ilBuddySystemRelation $relation) : 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');
            }
 
            throw $e;
        }
 
        return $this;
    }
 
    public function destroy() : self
    {
        $this->getRepository()->destroy();
        $this->getRelations()->clear();
        return $this;
    }
}