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

Collaboration diagram for ilLikeData:

Public Member Functions
	__construct (array $a_obj_ids=array(), ?ilDBInterface $db=null, ?ilLanguage $lng=null)

	getExpressionTypes ()
	Get types. More...

	addExpression (int $a_user_id, int $a_like_type, int $a_obj_id, string $a_obj_type, int $a_sub_obj_id=0, string $a_sub_obj_type="", int $a_news_id=0)
	Add expression for a user and object. More...

	removeExpression (int $a_user_id, int $a_like_type, int $a_obj_id, string $a_obj_type, int $a_sub_obj_id=0, string $a_sub_obj_type="", int $a_news_id=0)
	Remove expression for a user and object. More...

	getExpressionCounts (int $obj_id, string $obj_type, int $sub_obj_id, string $sub_obj_type, int $news_id)
	Get expression counts for obj/subobj/news. More...

	isExpressionSet (int $a_user_id, int $a_like_type, int $a_obj_id, string $a_obj_type, int $a_sub_obj_id=0, string $a_sub_obj_type="", int $a_news_id=0)
	Is expression set for a user and object? More...

	getExpressionEntries (int $obj_id, string $obj_type, int $sub_obj_id, string $sub_obj_type, int $news_id)
	Get expression entries for obj/subobj/news. More...

	getExpressionEntriesForObject (int $obj_id, ?string $since_ts=null)
	Get expression entries for obj/subobj/news. More...

Data Fields
const	TYPE_LIKE = 0

const	TYPE_DISLIKE = 1

const	TYPE_LOVE = 2

const	TYPE_LAUGH = 3

const	TYPE_ASTOUNDED = 4

const	TYPE_SAD = 5

const	TYPE_ANGRY = 6

Protected Member Functions
	loadDataForObjects (array $a_obj_ids=array())
	Load data (for objects) More...

Protected Attributes
array	$data = array()

ilDBInterface	$db

ilLanguage	$lng

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 Data class for like feature. DB related operations.

The like table only holds a record if an expression has been added. After a "dislike" the record disappears. This reduces space and increases performance. But we do not know "when" something has been disliked.

Since the subobject_type column is pk it must be not null and does not allow "" due to the abstract DB handling. We internally save "" as "-" here.

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

Definition at line 30 of file class.ilLikeData.php.

Constructor & Destructor Documentation

◆ __construct()

ilLikeData::__construct	(	array	$a_obj_ids = `array()`,
		?ilDBInterface	$db = `null`,
		?ilLanguage	$lng = `null`
	)

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

      {
        global $DIC;
 
        $this->db = ($db == null)
            ? $DIC->database()
            : $db;
 
        $this->lng = ($lng == null)
            ? $DIC->language()
            : $lng;
        $this->loadDataForObjects($a_obj_ids);
        $this->lng->loadLanguageModule("like");
    }

References $db, $DIC, $lng, ILIAS\Repository\lng(), and loadDataForObjects().

Here is the call graph for this function:

Member Function Documentation

◆ addExpression()

ilLikeData::addExpression	(	int	$a_user_id,
		int	$a_like_type,
		int	$a_obj_id,
		string	$a_obj_type,
		int	$a_sub_obj_id = `0`,
		string	$a_sub_obj_type = `""`,
		int	$a_news_id = `0`
	)

Add expression for a user and object.

Parameters

int	$a_user_id	user id (who is liking)
int	$a_like_type	one of self::TYPE_LIKE to self::TYPE_ANGRY
int	$a_obj_id	object id (must be an repository object id)
string	$a_obj_type	object type (redundant, for performance reasons)
int	$a_sub_obj_id	subobject id (as defined by the module being responsible for main object type)
string	$a_sub_obj_type	subobject type (as defined by the module being responsible for main object type)
int	$a_news_id	news is (optional news id, if like action is dedicated to a news for the object/subobject)

Definition at line 90 of file class.ilLikeData.php.

     : void {
        $ilDB = $this->db;
 
        if ($a_user_id == ANONYMOUS_USER_ID) {
            return;
        }
 
        $this->data[$a_obj_id][$a_sub_obj_id][$a_sub_obj_type][$a_news_id][$a_like_type][$a_user_id] = 1;
 
        if ($a_sub_obj_type == "") {
            $a_sub_obj_type = "-";
        }
 
        $ilDB->replace(
            "like_data",
            array(
                "user_id" => array("integer", $a_user_id),
                "obj_id" => array("integer", $a_obj_id),
                "obj_type" => array("text", $a_obj_type),
                "sub_obj_id" => array("integer", $a_sub_obj_id),
                "sub_obj_type" => array("text", $a_sub_obj_type),
                "news_id" => array("integer", $a_news_id),
                "like_type" => array("integer", $a_like_type)
                ),
            array(
                "exp_ts" => array("timestamp", ilUtil::now())
            )
        );
    }

◆ getExpressionCounts()

ilLikeData::getExpressionCounts	(	int	$obj_id,
		string	$obj_type,
		int	$sub_obj_id,
		string	$sub_obj_type,
		int	$news_id
	)

Get expression counts for obj/subobj/news.

Parameters

int	$obj_id
string	$obj_type
int	$sub_obj_id
string	$sub_obj_type
int	$news_id

Returns: int[] counts per expression type

Exceptions

ilLikeDataException

Definition at line 210 of file class.ilLikeData.php.

     : array {
        if (!is_array($this->data[$obj_id])) {
            throw new ilLikeDataException("No data loaded for object $obj_id.");
        }
 
        if ($sub_obj_type == "-") {
            $sub_obj_type = "";
        }
 
        $cnt = array();
        foreach ($this->getExpressionTypes() as $k => $txt) {
            $cnt[$k] = 0;
            if (isset($this->data[$obj_id][$sub_obj_id][$sub_obj_type][$news_id][$k])) {
                $cnt[$k] = count($this->data[$obj_id][$sub_obj_id][$sub_obj_type][$news_id][$k]);
            }
        }
        return $cnt;
    }

◆ getExpressionEntries()

ilLikeData::getExpressionEntries	(	int	$obj_id,
		string	$obj_type,
		int	$sub_obj_id,
		string	$sub_obj_type,
		int	$news_id
	)

Get expression entries for obj/subobj/news.

Exceptions

ilLikeDataException

Definition at line 266 of file class.ilLikeData.php.

     : array {
        if (!is_array($this->data[$obj_id])) {
            throw new ilLikeDataException("No data loaded for object $obj_id.");
        }
 
        if ($sub_obj_type == "-") {
            $sub_obj_type = "";
        }
 
        $exp = array();
        foreach ($this->getExpressionTypes() as $k => $txt) {
            if (isset($this->data[$obj_id][$sub_obj_id][$sub_obj_type][$news_id][$k])) {
                foreach ($this->data[$obj_id][$sub_obj_id][$sub_obj_type][$news_id][$k] as $user => $ts) {
                    $exp[] = array(
                        "expression" => $k,
                        "user_id" => $user,
                        "timestamp" => $ts
                    );
                }
            }
        }
 
        $exp = ilArrayUtil::sortArray($exp, "timestamp", "desc");
        return $exp;
    }

◆ getExpressionEntriesForObject()

ilLikeData::getExpressionEntriesForObject	(	int	$obj_id,
		?string	$since_ts = `null`
	)

Get expression entries for obj/subobj/news.

Parameters

int	$obj_id
	?string	$since_ts timestamp (show only data since...)

Returns: array

Exceptions

ilLikeDataException

Definition at line 306 of file class.ilLikeData.php.

     : array {
        if (!is_array($this->data[$obj_id])) {
            throw new ilLikeDataException("No data loaded for object $obj_id.");
        }
        $exp = array();
        foreach ($this->data[$obj_id] as $sub_obj_id => $si) {
            foreach ($si as $sub_obj_type => $so) {
                foreach ($so as $news_id => $ni) {
                    foreach ($ni as $exp_type => $entry) {
                        foreach ($entry as $user => $ts) {
                            if ($since_ts == null || $ts > $since_ts) {
                                $exp[] = array(
                                    "sub_obj_id" => $sub_obj_id,
                                    "sub_obj_type" => $sub_obj_type,
                                    "news_id" => $news_id,
                                    "expression" => $exp_type,
                                    "user_id" => $user,
                                    "timestamp" => $ts
                                );
                            }
                        }
                    }
                }
            }
        }
 
        $exp = ilArrayUtil::sortArray($exp, "timestamp", "desc");
        return $exp;
    }

◆ getExpressionTypes()

ilLikeData::getExpressionTypes ( )

Get types.

Definition at line 65 of file class.ilLikeData.php.

                                        : array
    {
        return array(
            self::TYPE_LIKE => $this->lng->txt("like_like"),
            self::TYPE_DISLIKE => $this->lng->txt("like_dislike"),
            self::TYPE_LOVE => $this->lng->txt("like_love"),
            self::TYPE_LAUGH => $this->lng->txt("like_laugh"),
            self::TYPE_ASTOUNDED => $this->lng->txt("like_astounded"),
            self::TYPE_SAD => $this->lng->txt("like_sad"),
            self::TYPE_ANGRY => $this->lng->txt("like_angry")
        );
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ isExpressionSet()

ilLikeData::isExpressionSet	(	int	$a_user_id,
		int	$a_like_type,
		int	$a_obj_id,
		string	$a_obj_type,
		int	$a_sub_obj_id = `0`,
		string	$a_sub_obj_type = `""`,
		int	$a_news_id = `0`
	)

Is expression set for a user and object?

Parameters

int	$a_user_id	user id (who is liking)
int	$a_like_type	one of self::TYPE_LIKE to self::TYPE_ANGRY
int	$a_obj_id	object id (must be an repository object id)
string	$a_obj_type	object type (redundant, for performance reasons)
int	$a_sub_obj_id	subobject id (as defined by the module being responsible for main object type)
string	$a_sub_obj_type	subobject type (as defined by the module being responsible for main object type)
int	$a_news_id	news is (optional news id, if like action is dedicated to a news for the object/subobject)

Returns: bool

Definition at line 247 of file class.ilLikeData.php.

     : bool {
        if (isset($this->data[$a_obj_id][$a_sub_obj_id][$a_sub_obj_type][$a_news_id][$a_like_type][$a_user_id])) {
            return true;
        }
        return false;
    }

◆ loadDataForObjects()

ilLikeData::loadDataForObjects ( array $a_obj_ids = array() )

protected

Load data (for objects)

Parameters

int[] $a_obj_ids load data for objects

Definition at line 178 of file class.ilLikeData.php.

     : void {
        $ilDB = $this->db;
 
        foreach ($a_obj_ids as $id) {
            $this->data[$id] = array();
        }
 
        $set = $ilDB->query("SELECT * FROM like_data " .
            " WHERE " . $ilDB->in("obj_id", $a_obj_ids, false, "integer") .
            " ORDER by exp_ts DESC");
        while ($rec = $ilDB->fetchAssoc($set)) {
            $subtype = $rec["sub_obj_type"] == "-"
                ? ""
                : $rec["sub_obj_type"];
            $this->data[$rec["obj_id"]][$rec["sub_obj_id"]][$subtype][$rec["news_id"]][$rec["like_type"]][$rec["user_id"]] =
                $rec["exp_ts"];
        }
    }

References $id.

Referenced by __construct().

Here is the caller graph for this function:

◆ removeExpression()

ilLikeData::removeExpression	(	int	$a_user_id,
		int	$a_like_type,
		int	$a_obj_id,
		string	$a_obj_type,
		int	$a_sub_obj_id = `0`,
		string	$a_sub_obj_type = `""`,
		int	$a_news_id = `0`
	)

Remove expression for a user and object.

Parameters

int	$a_user_id	user id (who is liking)
int	$a_like_type	one of self::TYPE_LIKE to self::TYPE_ANGRY
int	$a_obj_id	object id (must be an repository object id)
string	$a_obj_type	object type (redundant, for performance reasons)
int	$a_sub_obj_id	subobject id (as defined by the module being responsible for main object type)
string	$a_sub_obj_type	subobject type (as defined by the module being responsible for main object type)
int	$a_news_id	news is (optional news id, if like action is dedicated to a news for the object/subobject)

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

     : void {
        $ilDB = $this->db;
 
        if ($a_user_id == ANONYMOUS_USER_ID) {
            return;
        }
 
        if (isset($this->data[$a_obj_id][$a_sub_obj_id][$a_sub_obj_type][$a_news_id][$a_like_type][$a_user_id])) {
            unset($this->data[$a_obj_id][$a_sub_obj_id][$a_sub_obj_type][$a_news_id][$a_like_type][$a_user_id]);
        }
 
        if ($a_sub_obj_type == "") {
            $a_sub_obj_type = "-";
        }
 
        $ilDB->manipulate(
            "DELETE FROM like_data 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 sub_obj_type = " . $ilDB->quote($a_sub_obj_type, "text") .
            " AND news_id = " . $ilDB->quote($a_news_id, "integer") .
            " AND like_type = " . $ilDB->quote($a_like_type, "integer")
        );
    }

Field Documentation

◆ $data

array ilLikeData::$data = array()

protected

Definition at line 40 of file class.ilLikeData.php.

◆ $db

ilDBInterface ilLikeData::$db

protected

Definition at line 41 of file class.ilLikeData.php.

Referenced by __construct().

◆ $lng

ilLanguage ilLikeData::$lng

protected

Definition at line 42 of file class.ilLikeData.php.

Referenced by __construct().

◆ TYPE_ANGRY

const ilLikeData::TYPE_ANGRY = 6

Definition at line 38 of file class.ilLikeData.php.

Referenced by ilLikeGUI\getExpressionText(), and ilLikeGUI\getGlyphForConst().

◆ TYPE_ASTOUNDED

const ilLikeData::TYPE_ASTOUNDED = 4

Definition at line 36 of file class.ilLikeData.php.

Referenced by ilLikeGUI\getExpressionText(), and ilLikeGUI\getGlyphForConst().

◆ TYPE_DISLIKE

const ilLikeData::TYPE_DISLIKE = 1

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

Referenced by ilLikeGUI\getExpressionText(), and ilLikeGUI\getGlyphForConst().

◆ TYPE_LAUGH

const ilLikeData::TYPE_LAUGH = 3

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

Referenced by ilLikeGUI\getExpressionText(), and ilLikeGUI\getGlyphForConst().

◆ TYPE_LIKE

const ilLikeData::TYPE_LIKE = 0

Definition at line 32 of file class.ilLikeData.php.

Referenced by ilLikeGUI\getExpressionText(), and ilLikeGUI\getGlyphForConst().

◆ TYPE_LOVE

const ilLikeData::TYPE_LOVE = 2

Definition at line 34 of file class.ilLikeData.php.

Referenced by ilLikeGUI\getExpressionText(), and ilLikeGUI\getGlyphForConst().

◆ TYPE_SAD

const ilLikeData::TYPE_SAD = 5

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

Referenced by ilLikeGUI\getExpressionText(), and ilLikeGUI\getGlyphForConst().

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

components/ILIAS/Like/classes/class.ilLikeData.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addExpression()

◆ getExpressionCounts()

◆ getExpressionEntries()

◆ getExpressionEntriesForObject()

◆ getExpressionTypes()

◆ isExpressionSet()

◆ loadDataForObjects()

◆ removeExpression()

Field Documentation

◆ $data

◆ $db

◆ $lng

◆ TYPE_ANGRY

◆ TYPE_ASTOUNDED

◆ TYPE_DISLIKE

◆ TYPE_LAUGH

◆ TYPE_LIKE

◆ TYPE_LOVE

◆ TYPE_SAD