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

Collaboration diagram for ilRating:

Static Public Member Functions
static	writeRatingForUserAndObject (int $a_obj_id, string $a_obj_type, ?int $a_sub_obj_id, ?string $a_sub_obj_type, int $a_user_id, int $a_rating, int $a_category_id=0)
	Write rating for a user and an object. More...

static	resetRatingForUserAndObject (int $a_obj_id, string $a_obj_type, int $a_sub_obj_id, string $a_sub_obj_type, int $a_user_id)
	Reset rating for a user and an object. More...

static	getRatingForUserAndObject (int $a_obj_id, string $a_obj_type, int $a_sub_obj_id, string $a_sub_obj_type, int $a_user_id, ?int $a_category_id=null)
	Get rating for a user and an object. More...

static	getOverallRatingForObject (int $a_obj_id, string $a_obj_type, ?int $a_sub_obj_id=null, ?string $a_sub_obj_type=null, ?int $a_category_id=null)
	Get overall rating for an object. More...

static	getExportData (int $a_obj_id, string $a_obj_type, ?array $a_category_ids=null)
	Get export data. More...

static	preloadListGUIData (array $a_obj_ids)
	Preload rating data for list guis. More...

static	hasRatingInListGUI (int $a_obj_id, string $a_obj_type)

Static Protected Attributes
static array	$list_data = []

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 Class ilRating

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

Definition at line 24 of file class.ilRating.php.

Member Function Documentation

◆ getExportData()

static ilRating::getExportData	(	int	$a_obj_id,
		string	$a_obj_type,
		?array	$a_category_ids = `null`
	)

static

Get export data.

Parameters

int	$a_obj_id
string	$a_obj_type
	?array	$a_category_ids

Returns: array

Definition at line 225 of file class.ilRating.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $res = array();
        $q = "SELECT sub_obj_id, sub_obj_type, rating, category_id, user_id, tstamp " .
            "FROM il_rating WHERE " .
            "obj_id = " . $ilDB->quote($a_obj_id, "integer") . " AND " .
            "obj_type = " . $ilDB->quote($a_obj_type, "text") .
            " ORDER BY tstamp";
        if ($a_category_ids) {
            $q .= " AND " . $ilDB->in("category_id", $a_category_ids, "", "integer");
        }
        $set = $ilDB->query($q);
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[] = $row;
        }
        return $res;
    }

Referenced by ilRatingCategoryGUI\export().

Here is the caller graph for this function:

◆ getOverallRatingForObject()

static ilRating::getOverallRatingForObject	(	int	$a_obj_id,
		string	$a_obj_type,
		?int	$a_sub_obj_id = `null`,
		?string	$a_sub_obj_type = `null`,
		?int	$a_category_id = `null`
	)

static

Get overall rating for an object.

Parameters

int	$a_obj_id	Object ID
string	$a_obj_type	Object Type
	?int	$a_sub_obj_id Subobject ID
	?string	$a_sub_obj_type Subobject Type
	?int	$a_category_id Category ID

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

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if (isset(self::$list_data["all"][$a_obj_type . "/" . $a_obj_id])) {
            return self::$list_data["all"][$a_obj_type . "/" . $a_obj_id];
        }
 
        $q = "SELECT AVG(rating) av FROM il_rating" .
            " WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer") .
            " AND obj_type = " . $ilDB->quote($a_obj_type, "text");
        if ($a_sub_obj_id) {
            $q .= " AND sub_obj_id = " . $ilDB->quote($a_sub_obj_id, "integer") .
                " AND " . $ilDB->equals("sub_obj_type", $a_sub_obj_type, "text", true);
        } else {
            $q .= " AND sub_obj_type = " . $ilDB->quote("-", "text"); // #13913
        }
 
        if ($a_category_id !== null) {
            $q .= " AND category_id = " . $ilDB->quote($a_category_id, "integer");
        }
        $q .= " GROUP BY user_id";
        $set = $ilDB->query($q);
        $avg = $cnt = 0;
        while ($rec = $ilDB->fetchAssoc($set)) {
            $cnt++;
            $avg += $rec["av"];
        }
        if ($cnt > 0) {
            $avg = $avg / $cnt;
        } else {
            $avg = 0;
        }
        return array("cnt" => $cnt, "avg" => $avg);
    }

Referenced by ilWikiStat\getAverageRating(), ilDclRatingRecordFieldModel\getExportValue(), and ilDclRatingRecordFieldModel\getValue().

Here is the caller graph for this function:

◆ getRatingForUserAndObject()

static ilRating::getRatingForUserAndObject	(	int	$a_obj_id,
		string	$a_obj_type,
		int	$a_sub_obj_id,
		string	$a_sub_obj_type,
		int	$a_user_id,
		?int	$a_category_id = `null`
	)

static

Get rating for a user and an object.

Parameters

int	$a_obj_id	Object ID
string	$a_obj_type	Object Type
int	$a_sub_obj_id	Subobject ID
string	$a_sub_obj_type	Subobject Type
int	$a_user_id	User ID
	?int	$a_category_id Category ID

Definition at line 135 of file class.ilRating.php.

     : float {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if (isset(self::$list_data["user"][$a_obj_type . "/" . $a_obj_id])) {
            return self::$list_data["user"][$a_obj_type . "/" . $a_obj_id] ?? 0;
        }
 
        $q = "SELECT AVG(rating) av FROM il_rating WHERE " .
            "user_id = " . $ilDB->quote($a_user_id, "integer") . " AND " .
            "obj_id = " . $ilDB->quote($a_obj_id, "integer") . " AND " .
            "obj_type = " . $ilDB->quote($a_obj_type, "text") . " AND " .
            "sub_obj_id = " . $ilDB->quote($a_sub_obj_id, "integer") . " AND " .
            $ilDB->equals("sub_obj_type", $a_sub_obj_type, "text", true);
        if ($a_category_id !== null) {
            $q .= " AND category_id = " . $ilDB->quote($a_category_id, "integer");
        }
        $set = $ilDB->query($q);
        $rec = $ilDB->fetchAssoc($set);
        return (float) $rec["av"];
    }

Referenced by ilExcCriteriaRating\hasValue().

Here is the caller graph for this function:

◆ hasRatingInListGUI()

static ilRating::hasRatingInListGUI	(	int	$a_obj_id,
		string	$a_obj_type
	)

static

Definition at line 327 of file class.ilRating.php.

     : bool {
        return isset(self::$list_data["all"][$a_obj_type . "/" . $a_obj_id]);
    }

◆ preloadListGUIData()

static ilRating::preloadListGUIData ( array $a_obj_ids )

static

Preload rating data for list guis.

Parameters

int[] $a_obj_ids

Definition at line 255 of file class.ilRating.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
        $ilUser = $DIC->user();
 
        $tmp = $res = $res_user = array();
 
        // collapse by categories
        $q = "SELECT obj_id, obj_type, user_id, AVG(rating) av" .
            " FROM il_rating" .
            " WHERE " . $ilDB->in("obj_id", $a_obj_ids, "", "integer") .
            " AND sub_obj_id = " . $ilDB->quote(0, "integer") .
            " GROUP BY obj_id, obj_type, user_id";
        $set = $ilDB->query($q);
        while ($rec = $ilDB->fetchAssoc($set)) {
            $tmp[$rec["obj_type"] . "/" . $rec["obj_id"]][$rec["user_id"]] = (float) $rec["av"];
            if ($rec["user_id"] == $ilUser->getId()) {
                // add final average to user result (no sub-objects)
                $res_user[$rec["obj_type"] . "/" . $rec["obj_id"]] = (float) $rec["av"];
            }
        }
 
        // average for main objects without sub-objects
        foreach ($tmp as $obj_id => $votes) {
            $res[$obj_id] = array("avg" => array_sum($votes) / sizeof($votes),
                "cnt" => sizeof($votes));
        }
 
        // file/wiki/lm rating toggles
 
        $set = $ilDB->query("SELECT file_id, rating" .
            " FROM file_data" .
            " WHERE " . $ilDB->in("file_id", $a_obj_ids, "", 'integer'));
        while ($row = $ilDB->fetchAssoc($set)) {
            $id = "file/" . $row["file_id"];
            if ($row["rating"] && !isset($res[$id])) {
                $res[$id] = array("avg" => 0, "cnt" => 0);
            } elseif (!$row["rating"] && isset($res[$id])) {
                unset($res[$id]);
            }
        }
 
        $set = $ilDB->query("SELECT id, rating_overall" .
            " FROM il_wiki_data" .
            " WHERE " . $ilDB->in("id", $a_obj_ids, "", 'integer'));
        while ($row = $ilDB->fetchAssoc($set)) {
            $id = "wiki/" . $row["id"];
            if ($row["rating_overall"] && !isset($res[$id])) {
                $res[$id] = array("avg" => 0, "cnt" => 0);
            } elseif (!$row["rating_overall"] && isset($res[$id])) {
                unset($res[$id]);
            }
        }
 
        $set = $ilDB->query("SELECT id, rating" .
            " FROM content_object" .
            " WHERE " . $ilDB->in("id", $a_obj_ids, "", 'integer'));
        while ($row = $ilDB->fetchAssoc($set)) {
            $id = "lm/" . $row["id"];
            if ($row["rating"] && !isset($res[$id])) {
                $res[$id] = array("avg" => 0, "cnt" => 0);
            } elseif (!$row["rating"] && isset($res[$id])) {
                unset($res[$id]);
            }
        }
 
        self::$list_data = array("all" => $res, "user" => $res_user);
    }

Referenced by ilObjectListGUIPreloader\preload().

Here is the caller graph for this function:

◆ resetRatingForUserAndObject()

static ilRating::resetRatingForUserAndObject	(	int	$a_obj_id,
		string	$a_obj_type,
		int	$a_sub_obj_id,
		string	$a_sub_obj_type,
		int	$a_user_id
	)

static

Reset rating for a user and an object.

Parameters

int	$a_obj_id	Object ID
string	$a_obj_type	Object Type
int	$a_sub_obj_id	Subobject ID
string	$a_sub_obj_type	Subobject Type
int	$a_user_id	User ID

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

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $ilDB->manipulate("DELETE FROM il_rating WHERE " .
            "user_id = " . $ilDB->quote($a_user_id, "integer") . " AND " .
            "obj_id = " . $ilDB->quote($a_obj_id, "integer") . " AND " .
            "obj_type = " . $ilDB->quote($a_obj_type, "text") . " AND " .
            "sub_obj_id = " . $ilDB->quote($a_sub_obj_id, "integer") . " AND " .
            $ilDB->equals("sub_obj_type", $a_sub_obj_type, "text", true));
    }

Referenced by ilExcCriteriaRating\resetReview(), ilRatingGUI\resetUserRating(), and ilLMPresentationGUI\updatePageRating().

Here is the caller graph for this function:

◆ writeRatingForUserAndObject()

static ilRating::writeRatingForUserAndObject	(	int	$a_obj_id,
		string	$a_obj_type,
		?int	$a_sub_obj_id,
		?string	$a_sub_obj_type,
		int	$a_user_id,
		int	$a_rating,
		int	$a_category_id = `0`
	)

static

Write rating for a user and an object.

Parameters

int	$a_obj_id	Object ID
string	$a_obj_type	Object Type
	?int	$a_sub_obj_id Subobject ID
	?string	$a_sub_obj_type Subobject Type
int	$a_user_id	User ID
int	$a_rating	Rating
int	$a_category_id	Category ID

Definition at line 39 of file class.ilRating.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if ($a_rating < 0) {
            $a_rating = 0;
        }
 
        if ($a_rating > 5) {
            $a_rating = 5;
        }
 
        if ($a_user_id == ANONYMOUS_USER_ID) {
            return;
        }
 
        if ($a_category_id) {
            $ilDB->manipulate("DELETE FROM il_rating WHERE " .
                "user_id = " . $ilDB->quote($a_user_id, "integer") . " AND " .
                "obj_id = " . $ilDB->quote($a_obj_id, "integer") . " AND " .
                "obj_type = " . $ilDB->quote($a_obj_type, "text") . " AND " .
                "sub_obj_id = " . $ilDB->quote((int) $a_sub_obj_id, "integer") . " AND " .
                $ilDB->equals("sub_obj_type", $a_sub_obj_type, "text", true) . " AND " .
                "category_id = " . $ilDB->quote(0, "integer"));
        }
 
        $ilDB->manipulate("DELETE FROM il_rating WHERE " .
            "user_id = " . $ilDB->quote($a_user_id, "integer") . " AND " .
            "obj_id = " . $ilDB->quote($a_obj_id, "integer") . " AND " .
            "obj_type = " . $ilDB->quote($a_obj_type, "text") . " AND " .
            "sub_obj_id = " . $ilDB->quote((int) $a_sub_obj_id, "integer") . " AND " .
            $ilDB->equals("sub_obj_type", $a_sub_obj_type, "text", true) . " AND " .
            "category_id = " . $ilDB->quote($a_category_id, "integer"));
 
        if ($a_rating) {
            $ilDB->manipulate("INSERT INTO il_rating (user_id, obj_id, obj_type," .
                "sub_obj_id, sub_obj_type, category_id, rating, tstamp) VALUES (" .
                $ilDB->quote($a_user_id, "integer") . "," .
                $ilDB->quote($a_obj_id, "integer") . "," .
                $ilDB->quote($a_obj_type, "text") . "," .
                $ilDB->quote((int) $a_sub_obj_id, "integer") . "," .
                $ilDB->quote($a_sub_obj_type, "text") . "," .
                $ilDB->quote($a_category_id, "integer") . "," .
                $ilDB->quote($a_rating, "integer") . "," .
                $ilDB->quote(time(), "integer") . ")");
        }
    }

Referenced by ilRatingGUI\saveRating(), ilExcCriteriaRating\updateFromAjax(), and ilLMPresentationGUI\updatePageRating().

Here is the caller graph for this function:

Field Documentation

◆ $list_data

array ilRating::$list_data = []

staticprotected

Definition at line 26 of file class.ilRating.php.

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

components/ILIAS/Rating/classes/class.ilRating.php

Static Public Member Functions

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ getExportData()

◆ getOverallRatingForObject()

◆ getRatingForUserAndObject()

◆ hasRatingInListGUI()

◆ preloadListGUIData()

◆ resetRatingForUserAndObject()

◆ writeRatingForUserAndObject()

Field Documentation

◆ $list_data