Recommended content db repository. More...

Collaboration diagram for ilRecommendedContentDBRepository:

Public Member Functions
	__construct (\ilDBInterface $db=null)
	Constructor. More...

	addRoleRecommendation (int $role_id, int $ref_id)
	Add role recommendation. More...

	removeRoleRecommendation (int $role_id, int $ref_id)
	Remove role recommendation. More...

	addObjectRecommendation (int $user_id, int $ref_id)
	Add object recommendation. More...

	removeObjectRecommendation (int $user_id, int $ref_id)
	Remove object recommendation. More...

	removeRecommendationsOfRefId (int $ref_id)
	Remove all recommendations of a ref id (role and user/object related) More...

	removeRecommendationsOfUser (int $user_id)
	Remove all recommendations of a user. More...

	removeRecommendationsOfRole (int $role_id)
	Remove all recommendations of a role. More...

	declineObjectRecommendation (int $user_id, int $ref_id)
	Decline object recommendation. More...

	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)
	Does object recommendation exist? More...

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

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

Protected Attributes
	$db

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Definition at line 29 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
	)

Add object recommendation.

Parameters

int	$role_id
int	$ref_id

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

    {
        $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, and ifExistsObjectRecommendation().

Here is the call graph for this function:

◆ addRoleRecommendation()

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

Add role recommendation.

Parameters

int	$role_id
int	$ref_id

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

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

References $db.

◆ declineObjectRecommendation()

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

Decline object recommendation.

Parameters

int	$user_id
int	$ref_id

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

    {
        $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, and ifExistsObjectRecommendation().

Here is the call graph for this function:

◆ getDeclinedUserObjectRecommendations()

ilRecommendedContentDBRepository::getDeclinedUserObjectRecommendations ( int $user_id )

protected

Get declined user object recommendations.

Parameters

int $user_id

Returns: int[] ref ids of declined recommendations

Definition at line 263 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_column($db->fetchAll($set), "ref_id");
    }

References $db.

Referenced by getOpenRecommendationsOfUser().

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	$user_id
int[]	$role_ids

Returns: int[] ref ids of open recommendations

Definition at line 284 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, function ($i) use ($declined_recommendations) {
            return !in_array($i, $declined_recommendations);
        });
    }

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

Here is the call graph for this function:

◆ getRecommendationsOfRoles()

ilRecommendedContentDBRepository::getRecommendationsOfRoles ( array $role_ids )

Get recommendations of roles.

Parameters

$role_ids int[] role ids

Returns: int[] ref ids of recommendations

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

    {
        $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_column($db->fetchAll($set), "ref_id");
    }

References $db.

Referenced by getOpenRecommendationsOfUser().

Here is the caller graph for this function:

◆ getUserObjectRecommendations()

ilRecommendedContentDBRepository::getUserObjectRecommendations ( int $user_id )

protected

Get user object recommendations.

Parameters

int $user_id

Returns: int[] ref ids of recommendations

Definition at line 244 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_column($db->fetchAll($set), "ref_id");
    }

References $db.

Referenced by getOpenRecommendationsOfUser().

Here is the caller graph for this function:

◆ ifExistsObjectRecommendation()

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

protected

Does object recommendation exist?

Parameters

return bool

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

    {
        $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.

Referenced by addObjectRecommendation(), and declineObjectRecommendation().

Here is the caller graph for this function:

◆ removeObjectRecommendation()

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

Remove object recommendation.

Parameters

int	$user_id
int	$ref_id

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

    {
        $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.

◆ removeRecommendationsOfRefId()

ilRecommendedContentDBRepository::removeRecommendationsOfRefId ( int $ref_id )

Remove all recommendations of a ref id (role and user/object related)

Parameters

int $ref_id

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

    {
        $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.

◆ removeRecommendationsOfRole()

ilRecommendedContentDBRepository::removeRecommendationsOfRole ( int $role_id )

Remove all recommendations of a role.

Parameters

int $role_id

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

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

References $db.

◆ removeRecommendationsOfUser()

ilRecommendedContentDBRepository::removeRecommendationsOfUser ( int $user_id )

Remove all recommendations of a user.

Parameters

int $user_id

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

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

References $db.

◆ removeRoleRecommendation()

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

Remove role recommendation.

Parameters

int	$role_id
int	$ref_id

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

    {
        $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.

Field Documentation

◆ $db

ilRecommendedContentDBRepository::$db

protected

Definition at line 24 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:

Services/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