This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilRecommendedContentDBRepository:

Public Member Functions
	__construct (?ilDBInterface $db=null)

	addRoleRecommendation (int $role_id, int $ref_id)

	removeRoleRecommendation (int $role_id, int $ref_id)

	addObjectRecommendation (int $user_id, int $ref_id)

	removeObjectRecommendation (int $user_id, int $ref_id)

	removeRecommendationsOfRefId (int $ref_id)

	removeRecommendationsOfUser (int $user_id)

	removeRecommendationsOfRole (int $role_id)

	declineObjectRecommendation (int $user_id, int $ref_id)

	getRecommendationsOfRoles (array $role_ids)
	Get recommendations of roles. More...

	getOpenRecommendationsOfUser (int $user_id, array $role_ids)
	Open recommendations of user (by role or object, without declined ones) More...

Protected Member Functions
	ifExistsObjectRecommendation (int $user_id, int $ref_id)

	getUserObjectRecommendations (int $user_id)
	Get user object recommendations. More...

	getDeclinedUserObjectRecommendations (int $user_id)
	Get declined user object recommendations. More...

Protected Attributes
ilDBInterface	$db

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Recommended content db repository

Table rep_rec_content_obj (A repo object is directly recommended for a user, users can decline recommendations)

user_id
ref_id
declined

Table rep_rec_content_role (A repo object is recommended for users of a role)

role_id
ref_id

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilRecommendedContentDBRepository::__construct ( ?ilDBInterface $db = null )

Definition at line 37 of file class.ilRecommendedContentDBRepository.php.

    {
        global $DIC;
 
        $this->db = (is_null($db))
            ? $DIC->database()
            : $db;
    }

References $db, and $DIC.

Member Function Documentation

◆ addObjectRecommendation()

ilRecommendedContentDBRepository::addObjectRecommendation	(	int	$user_id,
		int	$ref_id
	)

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

                                                                      : void
    {
        $db = $this->db;
 
        if (!$this->ifExistsObjectRecommendation($user_id, $ref_id)) {
            $db->insert("rep_rec_content_obj", [
                "user_id" => ["integer", $user_id],
                "ref_id" => ["integer", $ref_id],
                "declined" => ["integer", false]
            ]);
        }
    }

References $db, $ref_id, $user_id, ifExistsObjectRecommendation(), and ilDBInterface\insert().

Here is the call graph for this function:

◆ addRoleRecommendation()

ilRecommendedContentDBRepository::addRoleRecommendation	(	int	$role_id,
		int	$ref_id
	)

Definition at line 46 of file class.ilRecommendedContentDBRepository.php.

                                                                    : void
    {
        $db = $this->db;
 
        $db->replace(
            "rep_rec_content_role",
            [           // pk
            "role_id" => ["integer", $role_id],
            "ref_id" => ["integer", $ref_id]
        ],
            []
        );
    }

References $db, $ref_id, and ilDBInterface\replace().

Here is the call graph for this function:

◆ declineObjectRecommendation()

ilRecommendedContentDBRepository::declineObjectRecommendation	(	int	$user_id,
		int	$ref_id
	)

Definition at line 157 of file class.ilRecommendedContentDBRepository.php.

                                                                          : void
    {
        $db = $this->db;
 
        if ($this->ifExistsObjectRecommendation($user_id, $ref_id)) {
            $db->update(
                "rep_rec_content_obj",
                [
                    "declined" => ["integer", true]
                ],
                [       // where
                    "user_id" => ["integer", $user_id],
                    "ref_id" => ["integer", $ref_id]
                ]
            );
        } else {
            $db->insert("rep_rec_content_obj", [
                "user_id" => ["integer", $user_id],
                "ref_id" => ["integer", $ref_id],
                "declined" => ["integer", true]
            ]);
        }
    }

References $db, $ref_id, $user_id, ifExistsObjectRecommendation(), ilDBInterface\insert(), and ilDBInterface\update().

Here is the call graph for this function:

◆ getDeclinedUserObjectRecommendations()

ilRecommendedContentDBRepository::getDeclinedUserObjectRecommendations ( int $user_id )

protected

Get declined user object recommendations.

Returns: int[] ref ids of declined recommendations

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

                                                                         : array
    {
        $db = $this->db;
 
        $set = $db->queryF(
            "SELECT ref_id FROM rep_rec_content_obj " .
            " WHERE user_id = %s AND declined = %s",
            ["integer", "integer"],
            [$user_id, true]
        );
 
        return array_map('intval', array_column($db->fetchAll($set), "ref_id"));
    }

References $db, $user_id, ilDBInterface\fetchAll(), and ilDBInterface\queryF().

Referenced by getOpenRecommendationsOfUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOpenRecommendationsOfUser()

ilRecommendedContentDBRepository::getOpenRecommendationsOfUser	(	int	$user_id,
		array	$role_ids
	)

Open recommendations of user (by role or object, without declined ones)

Parameters

int[] $role_ids

Returns: int[] ref ids of open recommendations

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

                                                                               : array
    {
        // recommendations of role
        $role_recommendations = $this->getRecommendationsOfRoles($role_ids);
 
        // recommendations of user
        $obj_recommendations = $this->getUserObjectRecommendations($user_id);
 
        $recommendations = array_unique($role_recommendations + $obj_recommendations);
 
        // filter declined recommendations
        $declined_recommendations = $this->getDeclinedUserObjectRecommendations($user_id);
        return array_filter($recommendations, static function (int $i) use ($declined_recommendations): bool {
            return !in_array($i, $declined_recommendations, true);
        });
    }

References getDeclinedUserObjectRecommendations(), getRecommendationsOfRoles(), and getUserObjectRecommendations().

Referenced by ilRecommendedContentManager\getOpenRecommendationsOfUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecommendationsOfRoles()

ilRecommendedContentDBRepository::getRecommendationsOfRoles ( array $role_ids )

Get recommendations of roles.

Parameters

int[] $role_ids

Returns: int[] ref ids of recommendations

Definition at line 187 of file class.ilRecommendedContentDBRepository.php.

                                                              : array
    {
        $db = $this->db;
 
        $set = $db->query(
            "SELECT DISTINCT ref_id FROM rep_rec_content_role " .
            " WHERE " . $db->in("role_id", $role_ids, false, "integer")
        );
 
        return array_map('intval', array_column($db->fetchAll($set), "ref_id"));
    }

References $db, ilDBInterface\fetchAll(), ilDBInterface\in(), and ilDBInterface\query().

Referenced by getOpenRecommendationsOfUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUserObjectRecommendations()

ilRecommendedContentDBRepository::getUserObjectRecommendations ( int $user_id )

protected

Get user object recommendations.

Returns: int[] ref ids of recommendations

Definition at line 203 of file class.ilRecommendedContentDBRepository.php.

                                                                 : array
    {
        $db = $this->db;
 
        $set = $db->queryF(
            "SELECT ref_id FROM rep_rec_content_obj " .
            " WHERE user_id = %s AND declined = %s",
            ["integer", "integer"],
            [$user_id, false]
        );
 
        return array_map('intval', array_column($db->fetchAll($set), "ref_id"));
    }

References $db, $user_id, ilDBInterface\fetchAll(), and ilDBInterface\queryF().

Referenced by getOpenRecommendationsOfUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ifExistsObjectRecommendation()

ilRecommendedContentDBRepository::ifExistsObjectRecommendation	(	int	$user_id,
		int	$ref_id
	)

protected

Definition at line 141 of file class.ilRecommendedContentDBRepository.php.

                                                                              : bool
    {
        $db = $this->db;
 
        $set = $db->queryF(
            "SELECT * FROM rep_rec_content_obj " .
            " WHERE user_id = %s AND ref_id = %s",
            ["integer","integer"],
            [$user_id, $ref_id]
        );
        if ($rec = $db->fetchAssoc($set)) {
            return true;
        }
        return false;
    }

References $db, $ref_id, $user_id, ilDBInterface\fetchAssoc(), and ilDBInterface\queryF().

Referenced by addObjectRecommendation(), and declineObjectRecommendation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeObjectRecommendation()

ilRecommendedContentDBRepository::removeObjectRecommendation	(	int	$user_id,
		int	$ref_id
	)

Definition at line 85 of file class.ilRecommendedContentDBRepository.php.

                                                                         : void
    {
        $db = $this->db;
 
        $db->manipulateF(
            "DELETE FROM rep_rec_content_obj WHERE " .
            " user_id = %s AND ref_id = %s",
            ["integer", "integer"],
            [$user_id, $ref_id]
        );
    }

References $db, $ref_id, $user_id, and ilDBInterface\manipulateF().

Here is the call graph for this function:

◆ removeRecommendationsOfRefId()

ilRecommendedContentDBRepository::removeRecommendationsOfRefId ( int $ref_id )

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

                                                             : void
    {
        $db = $this->db;
 
        $db->manipulateF(
            "DELETE FROM rep_rec_content_obj WHERE " .
            " ref_id = %s",
            ["integer"],
            [$ref_id]
        );
 
        $db->manipulateF(
            "DELETE FROM rep_rec_content_role WHERE " .
            " ref_id = %s",
            ["integer"],
            [$ref_id]
        );
    }

References $db, $ref_id, and ilDBInterface\manipulateF().

Here is the call graph for this function:

◆ removeRecommendationsOfRole()

ilRecommendedContentDBRepository::removeRecommendationsOfRole ( int $role_id )

Definition at line 128 of file class.ilRecommendedContentDBRepository.php.

                                                             : void
    {
        $db = $this->db;
 
        $db->manipulateF(
            "DELETE FROM rep_rec_content_role WHERE " .
            " role_id = %s",
            ["integer"],
            [$role_id]
        );
    }

References $db, and ilDBInterface\manipulateF().

Here is the call graph for this function:

◆ removeRecommendationsOfUser()

ilRecommendedContentDBRepository::removeRecommendationsOfUser ( int $user_id )

Definition at line 116 of file class.ilRecommendedContentDBRepository.php.

                                                             : void
    {
        $db = $this->db;
 
        $db->manipulateF(
            "DELETE FROM rep_rec_content_obj WHERE " .
            " user_id = %s",
            ["integer"],
            [$user_id]
        );
    }

References $db, $user_id, and ilDBInterface\manipulateF().

Here is the call graph for this function:

◆ removeRoleRecommendation()

ilRecommendedContentDBRepository::removeRoleRecommendation	(	int	$role_id,
		int	$ref_id
	)

Definition at line 60 of file class.ilRecommendedContentDBRepository.php.

                                                                       : void
    {
        $db = $this->db;
 
        $db->manipulateF(
            "DELETE FROM rep_rec_content_role WHERE " .
            " role_id = %s AND ref_id = %s",
            ["integer", "integer"],
            [$role_id, $ref_id]
        );
    }

References $db, $ref_id, and ilDBInterface\manipulateF().

Here is the call graph for this function:

Field Documentation

◆ $db

ilDBInterface ilRecommendedContentDBRepository::$db

protected

Definition at line 35 of file class.ilRecommendedContentDBRepository.php.

Referenced by __construct(), addObjectRecommendation(), addRoleRecommendation(), declineObjectRecommendation(), getDeclinedUserObjectRecommendations(), getRecommendationsOfRoles(), getUserObjectRecommendations(), ifExistsObjectRecommendation(), removeObjectRecommendation(), removeRecommendationsOfRefId(), removeRecommendationsOfRole(), removeRecommendationsOfUser(), and removeRoleRecommendation().

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

components/ILIAS/Repository/RecommendedContent/classes/class.ilRecommendedContentDBRepository.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addObjectRecommendation()

◆ addRoleRecommendation()

◆ declineObjectRecommendation()

◆ getDeclinedUserObjectRecommendations()

◆ getOpenRecommendationsOfUser()

◆ getRecommendationsOfRoles()

◆ getUserObjectRecommendations()

◆ ifExistsObjectRecommendation()

◆ removeObjectRecommendation()

◆ removeRecommendationsOfRefId()

◆ removeRecommendationsOfRole()

◆ removeRecommendationsOfUser()

◆ removeRoleRecommendation()

Field Documentation

◆ $db