ilBuddySystemRelationRepository Class Reference

Class ilBuddySystemRelationRepository. More...

Collaboration diagram for ilBuddySystemRelationRepository:

Public Member Functions
	__construct (protected int $usrId, ilDBInterface $db=null)
	getAll ()
	Reads all items from database. More...
	destroy ()
	save (ilBuddySystemRelation $relation)

Protected Attributes
ilDBInterface	$db

Private Member Functions
	getRelationByDatabaseRecord (array $row)
	addToApprovedBuddies (ilBuddySystemRelation $relation)
	removeFromApprovedBuddies (ilBuddySystemRelation $relation)
	addToRequestedBuddies (ilBuddySystemRelation $relation, bool $ignored)
	removeFromRequestedBuddies (ilBuddySystemRelation $relation)

Private Attributes
const	TYPE_APPROVED = 'app'
const	TYPE_REQUESTED = 'req'
const	TYPE_IGNORED = 'ign'

Detailed Description

Class ilBuddySystemRelationRepository.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilBuddySystemRelationRepository::__construct	(	protected int	$usrId,
		ilDBInterface	$db = null
	)

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

References $DIC.

    {
        global $DIC;

        $this->db = $db ?? $DIC->database();
    }

Member Function Documentation

addToApprovedBuddies()

ilBuddySystemRelationRepository::addToApprovedBuddies ( ilBuddySystemRelation  $relation )

private

Definition at line 139 of file class.ilBuddySystemRelationRepository.php.

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

Referenced by save().

                                                                          : void
    {
        $this->db->replace(
            'buddylist',
            [
                'usr_id' => ['integer', $relation->getUsrId()],
                'buddy_usr_id' => ['integer', $relation->getBuddyUsrId()]
            ],
            [
                'ts' => ['integer', $relation->getTimestamp()]
            ]
        );

        $this->db->replace(
            'buddylist',
            [
                'usr_id' => ['integer', $relation->getBuddyUsrId()],
                'buddy_usr_id' => ['integer', $relation->getUsrId()]
            ],
            [
                'ts' => ['integer', $relation->getTimestamp()]
            ]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addToRequestedBuddies()

ilBuddySystemRelationRepository::addToRequestedBuddies ( ilBuddySystemRelation  $relation, bool  $ignored  )

private

Definition at line 179 of file class.ilBuddySystemRelationRepository.php.

References ilBuddySystemRelation\getBuddyUsrId(), ilBuddySystemRelation\getTimestamp(), ilBuddySystemRelation\getUsrId(), and ILIAS\Repository\int().

Referenced by save().

                                                                                          : void
    {
        $this->db->replace(
            'buddylist_requests',
            [
                'usr_id' => ['integer', $relation->getUsrId()],
                'buddy_usr_id' => ['integer', $relation->getBuddyUsrId()]
            ],
            [
                'ts' => ['integer', $relation->getTimestamp()],
                'ignored' => ['integer', (int) $ignored]
            ]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

destroy()

ilBuddySystemRelationRepository::destroy

(

)

Definition at line 124 of file class.ilBuddySystemRelationRepository.php.

                             : void
    {
        $this->db->manipulateF(
            'DELETE FROM buddylist WHERE usr_id = %s OR buddy_usr_id = %s',
            ['integer', 'integer'],
            [$this->usrId, $this->usrId]
        );

        $this->db->manipulateF(
            'DELETE FROM buddylist_requests WHERE usr_id = %s OR buddy_usr_id = %s',
            ['integer', 'integer'],
            [$this->usrId, $this->usrId]
        );
    }

getAll()

ilBuddySystemRelationRepository::getAll

(

)

Reads all items from database.

Returns

ilBuddySystemRelation[]

Definition at line 44 of file class.ilBuddySystemRelationRepository.php.

References ILIAS\LTI\ToolProvider\$key, $relation, $res, and getRelationByDatabaseRecord().

                            : array
    {
        $relations = [];

        $res = $this->db->queryF(
            '
                        SELECT
                               buddylist.usr_id, buddylist.buddy_usr_id, buddylist.ts, %s rel_type
            FROM buddylist
                        INNER JOIN usr_data ud
                ON ud.usr_id = buddylist.usr_id
            INNER JOIN usr_data udbuddy
                ON udbuddy.usr_id = buddylist.buddy_usr_id
                        WHERE buddylist.usr_id = %s
                        UNION
                        SELECT
                               buddylist_requests.usr_id, buddylist_requests.buddy_usr_id, buddylist_requests.ts, (CASE WHEN ignored = 1 THEN %s ELSE %s END) rel_type
                        FROM buddylist_requests
                        INNER JOIN usr_data ud ON ud.usr_id = buddylist_requests.usr_id
                        INNER JOIN usr_data udbuddy ON udbuddy.usr_id = buddylist_requests.buddy_usr_id
                        WHERE buddylist_requests.usr_id = %s OR buddylist_requests.buddy_usr_id = %s
                        ',
            [
                'text',
                'integer',
                'text',
                'text',
                'integer',
                'integer'
            ],
            [
                self::TYPE_APPROVED,
                $this->usrId,
                self::TYPE_IGNORED,
                self::TYPE_REQUESTED,
                $this->usrId,
                $this->usrId
            ]
        );

        while ($row = $this->db->fetchAssoc($res)) {
            $relation = $this->getRelationByDatabaseRecord($row);
            $key = $this->usrId === $relation->getUsrId() ? $relation->getBuddyUsrId() : $relation->getUsrId();
            $relations[$key] = $relation;
        }

        return $relations;
    }

Here is the call graph for this function:

getRelationByDatabaseRecord()

ilBuddySystemRelationRepository::getRelationByDatabaseRecord ( array  $row )

private

Definition at line 93 of file class.ilBuddySystemRelationRepository.php.

Referenced by getAll().

                                                            : ilBuddySystemRelation
    {
        if (self::TYPE_APPROVED === $row['rel_type']) {
            return new ilBuddySystemRelation(
                new ilBuddySystemLinkedRelationState(),
                (int) $row['usr_id'],
                (int) $row['buddy_usr_id'],
                (int) $row['usr_id'] === $this->usrId,
                (int) $row['ts']
            );
        }

        if (self::TYPE_IGNORED === $row['rel_type']) {
            return new ilBuddySystemRelation(
                new ilBuddySystemIgnoredRequestRelationState(),
                (int) $row['usr_id'],
                (int) $row['buddy_usr_id'],
                (int) $row['usr_id'] === $this->usrId,
                (int) $row['ts']
            );
        }

        return new ilBuddySystemRelation(
            new ilBuddySystemRequestedRelationState(),
            (int) $row['usr_id'],
            (int) $row['buddy_usr_id'],
            (int) $row['usr_id'] === $this->usrId,
            (int) $row['ts']
        );
    }

Here is the caller graph for this function:

removeFromApprovedBuddies()

ilBuddySystemRelationRepository::removeFromApprovedBuddies ( ilBuddySystemRelation  $relation )

private

Definition at line 164 of file class.ilBuddySystemRelationRepository.php.

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

Referenced by save().

                                                                               : void
    {
        $this->db->manipulateF(
            'DELETE FROM buddylist WHERE usr_id = %s AND buddy_usr_id = %s',
            ['integer', 'integer'],
            [$relation->getUsrId(), $relation->getBuddyUsrId()]
        );

        $this->db->manipulateF(
            'DELETE FROM buddylist WHERE buddy_usr_id = %s AND usr_id = %s',
            ['integer', 'integer'],
            [$relation->getUsrId(), $relation->getBuddyUsrId()]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

removeFromRequestedBuddies()

ilBuddySystemRelationRepository::removeFromRequestedBuddies ( ilBuddySystemRelation  $relation )

private

Definition at line 194 of file class.ilBuddySystemRelationRepository.php.

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

Referenced by save().

                                                                                : void
    {
        $this->db->manipulateF(
            'DELETE FROM buddylist_requests WHERE usr_id = %s AND buddy_usr_id = %s',
            ['integer', 'integer'],
            [$relation->getUsrId(), $relation->getBuddyUsrId()]
        );

        $this->db->manipulateF(
            'DELETE FROM buddylist_requests WHERE buddy_usr_id = %s AND usr_id = %s',
            ['integer', 'integer'],
            [$relation->getUsrId(), $relation->getBuddyUsrId()]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilBuddySystemRelationRepository::save

(

ilBuddySystemRelation

$relation

)

Definition at line 209 of file class.ilBuddySystemRelationRepository.php.

References $ilDB, addToApprovedBuddies(), addToRequestedBuddies(), ilBuddySystemRelation\isIgnored(), ilBuddySystemRelation\isLinked(), ilBuddySystemRelation\isRequested(), removeFromApprovedBuddies(), removeFromRequestedBuddies(), ilBuddySystemRelation\wasIgnored(), ilBuddySystemRelation\wasLinked(), and ilBuddySystemRelation\wasRequested().

                                                         : void
    {
        $ilAtomQuery = $this->db->buildAtomQuery();
        $ilAtomQuery->addTableLock('buddylist_requests');
        $ilAtomQuery->addTableLock('buddylist');

        $ilAtomQuery->addQueryCallable(function (ilDBInterface $ilDB) use ($relation): void {
            if ($relation->isLinked()) {
                $this->addToApprovedBuddies($relation);
            } elseif ($relation->wasLinked()) {
                $this->removeFromApprovedBuddies($relation);
            }

            if ($relation->isRequested()) {
                $this->addToRequestedBuddies($relation, false);
            } elseif ($relation->isIgnored()) {
                $this->addToRequestedBuddies($relation, true);
            } elseif ($relation->wasRequested() || $relation->wasIgnored()) {
                $this->removeFromRequestedBuddies($relation);
            }
        });

        $ilAtomQuery->run();
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilBuddySystemRelationRepository::$db

protected

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

TYPE_APPROVED

const ilBuddySystemRelationRepository::TYPE_APPROVED = 'app'

private

Definition at line 27 of file class.ilBuddySystemRelationRepository.php.

TYPE_IGNORED

const ilBuddySystemRelationRepository::TYPE_IGNORED = 'ign'

private

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

TYPE_REQUESTED

const ilBuddySystemRelationRepository::TYPE_REQUESTED = 'req'

private

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

---

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

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