class.ilLikeData.php

Go to the documentation of this file.

<?php

class ilLikeData
{
    public const TYPE_LIKE = 0;
    public const TYPE_DISLIKE = 1;
    public const TYPE_LOVE = 2;
    public const TYPE_LAUGH = 3;
    public const TYPE_ASTOUNDED = 4;
    public const TYPE_SAD = 5;
    public const TYPE_ANGRY = 6;

    protected array $data = array();
    protected ilDBInterface $db;
    protected ilLanguage $lng;

    public function __construct(
        array $a_obj_ids = array(),
        ?ilDBInterface $db = null,
        ?ilLanguage $lng = null
    ) {
        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");
    }

    public function getExpressionTypes(): 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")
        );
    }


    public function 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
    ): 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())
            )
        );
    }

    public function 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
    ): 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")
        );
    }

    protected function loadDataForObjects(
        array $a_obj_ids = array()
    ): 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"];
        }
    }

    public function getExpressionCounts(
        int $obj_id,
        string $obj_type,
        int $sub_obj_id,
        string $sub_obj_type,
        int $news_id
    ): 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;
    }

    public function 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
    ): 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;
    }

    public function getExpressionEntries(
        int $obj_id,
        string $obj_type,
        int $sub_obj_id,
        string $sub_obj_type,
        int $news_id
    ): 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;
    }

    public function getExpressionEntriesForObject(
        int $obj_id,
        ?string $since_ts = null
    ): 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;
    }
}