ilTagging Class Reference

Collaboration diagram for ilTagging:

Public Member Functions
	__construct ()

Static Public Member Functions
static	writeTagsForUserAndObject (int $a_obj_id, string $a_obj_type, int $a_sub_obj_id, string $a_sub_obj_type, int $a_user_id, array $a_tags)
static	getTagsForUserAndObject (int $a_obj_id, string $a_obj_type, int $a_sub_obj_id, string $a_sub_obj_type, int $a_user_id)
static	getTagsForObject (int $a_obj_id, string $a_obj_type, int $a_sub_obj_id, string $a_sub_obj_type, bool $a_only_online=true)
static	getTagsForUser (int $a_user_id, int $a_max=0, bool $a_only_online=true)
static	getObjectsForTagAndUser (int $a_user_id, string $a_tag)
static	getRelevanceClass (int $cnt, int $max)
static	setTagsOfObjectOffline (int $a_obj_id, string $a_obj_type, int $a_sub_obj_id, string $a_sub_obj_type, bool $a_offline=true)
static	deleteTagsOfObject (int $a_obj_id, string $a_obj_type, int $a_sub_obj_id, string $a_sub_obj_type)
static	deleteTagOfObjectForUser (int $a_user_id, int $a_obj_id, string $a_obj_type, int $a_sub_obj_id, string $a_sub_obj_type, string $a_tag)
static	getUsersForTag (string $a_tag)
static	_countTags (array $a_obj_ids, bool $a_all_users=false)
	Count all tags for repository objects. More...
static	_getTagCloudForObjects (array $a_obj_ids, ?int $a_user_id=null, int $a_divide=0)
	Count tags for given object ids. More...
static	_findObjectsByTag (string $a_tag, ?int $a_user_id=null, bool $a_invert=false)
	Find all objects with given tag. More...
static	_getListTagsForObjects (array $a_obj_ids, ?int $a_user_id=null)
	Get tags for given object ids. More...

Detailed Description

Definition at line 21 of file class.ilTagging.php.

Constructor & Destructor Documentation

__construct()

ilTagging::__construct

(

)

Definition at line 23 of file class.ilTagging.php.

    {
    }

Member Function Documentation

_countTags()

static ilTagging::_countTags ( array  $a_obj_ids, bool  $a_all_users = false  )

static

Count all tags for repository objects.

Parameters

int[]	$a_obj_ids
bool	$a_all_users

Returns

int[] key is object id

Definition at line 339 of file class.ilTagging.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
        $ilUser = $DIC->user();
 
        $q = "SELECT count(*) c, obj_id FROM il_tag WHERE " .
            $ilDB->in("obj_id", $a_obj_ids, false, "integer");
        // PHP8 Review: Type cast is unnecessary
        if (!(bool) $a_all_users) {
            $q .= " AND user_id = " . $ilDB->quote($ilUser->getId(), "integer");
        }
        $q .= " GROUP BY obj_id";
 
        $cnt = array();
        $set = $ilDB->query($q);
        while ($rec = $ilDB->fetchAssoc($set)) {
            $cnt[$rec["obj_id"]] = $rec["c"];
        }
 
        return $cnt;
    }

References $ilDB, and $q.

_findObjectsByTag()

static ilTagging::_findObjectsByTag ( string  $a_tag, ?int  $a_user_id = null, bool  $a_invert = false  )

static

Find all objects with given tag.

Parameters

?int	$a_user_id

Returns

int[]

Definition at line 419 of file class.ilTagging.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $res = array();
 
        $sql = "SELECT obj_id, obj_type" .
            " FROM il_tag" .
            " WHERE tag = " . $ilDB->quote($a_tag, "text") .
            " AND is_offline = " . $ilDB->quote(0, "integer");
        if ($a_user_id) {
            if (!$a_invert) {
                $sql .= " AND user_id = " . $ilDB->quote($a_user_id, "integer");
            } else {
                $sql .= " AND user_id <> " . $ilDB->quote($a_user_id, "integer");
            }
        }
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[$row["obj_id"]] = $row["obj_type"];
        }
 
        return $res;
    }

Referenced by ilTaggingClassificationProvider\getFilteredObjects().

Here is the caller graph for this function:

_getListTagsForObjects()

static ilTagging::_getListTagsForObjects ( array  $a_obj_ids, ?int  $a_user_id = null  )

static

Get tags for given object ids.

Parameters

array	$a_obj_ids
	?int	$a_user_id

Returns

array

Definition at line 455 of file class.ilTagging.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
        $ilUser = $DIC->user();
 
        $res = array();
 
        $sql = "SELECT obj_id, tag, user_id" .
            " FROM il_tag" .
            " WHERE " . $ilDB->in("obj_id", $a_obj_ids, false, "integer") .
            " AND is_offline = " . $ilDB->quote(0, "integer");
        if ($a_user_id) {
            $sql .= " AND user_id = " . $ilDB->quote($a_user_id, "integer");
        }
        $sql .= " ORDER BY tag";
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            $tag = $row["tag"];
            $res[$row["obj_id"]][$tag] = false;
            if ($row["user_id"] == $ilUser->getId()) {
                $res[$row["obj_id"]][$tag] = true;
            }
        }
 
        return $res;
    }

Referenced by ilTaggingGUI\getHTML().

Here is the caller graph for this function:

_getTagCloudForObjects()

static ilTagging::_getTagCloudForObjects ( array  $a_obj_ids, ?int  $a_user_id = null, int  $a_divide = 0  )

static

Count tags for given object ids.

Parameters

int[]

$a_obj_ids

Definition at line 369 of file class.ilTagging.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $res = array();
 
        $sql = "SELECT obj_id, obj_type, tag, user_id" .
            " FROM il_tag" .
            " WHERE " . $ilDB->in("obj_id", array_keys($a_obj_ids), false, "integer") .
            " AND is_offline = " . $ilDB->quote(0, "integer");
        if ($a_user_id) {
            $sql .= " AND user_id = " . $ilDB->quote($a_user_id, "integer");
        }
        $sql .= " ORDER BY tag";
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            if ($a_obj_ids[$row["obj_id"]] == $row["obj_type"]) {
                $tag = $row["tag"];
 
                if ($a_divide > 0) {
                    if ($row["user_id"] == $a_divide) {
                        $res["personal"][$tag] = isset($res["personal"][$tag])
                            ? $res["personal"][$tag]++
                            : 1;
                    } else {
                        $res["other"][$tag] = isset($res["other"][$tag])
                            ? $res["other"][$tag]++
                            : 1;
                    }
                } else {
                    $res[$tag] = isset($res[$tag])
                        ? $res[$tag]++
                        : 1;
                }
            }
        }
 
        return $res;
    }

Referenced by ilTaggingClassificationProvider\getSubTreeTags().

Here is the caller graph for this function:

deleteTagOfObjectForUser()

static ilTagging::deleteTagOfObjectForUser ( int  $a_user_id, int  $a_obj_id, string  $a_obj_type, int  $a_sub_obj_id, string  $a_sub_obj_type, string  $a_tag  )

static

Definition at line 284 of file class.ilTagging.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if ($a_sub_obj_type == "") {
            $a_sub_obj_type = "-";
        }
 
        $ilDB->manipulateF(
            "DELETE FROM il_tag " .
            "WHERE " .
            "user_id = %s AND " .
            "obj_id = %s AND " .
            "obj_type = %s AND " .
            "sub_obj_id = %s AND " .
            $ilDB->equals("sub_obj_type", $a_sub_obj_type, "text", true) . " AND " .
            "tag = %s",
            array("integer", "integer", "text", "integer", "text"),
            array($a_user_id, $a_obj_id, $a_obj_type, $a_sub_obj_id, $a_tag)
        );
    }

Referenced by ilTaggingSlateContentGUI\removeTagsWithoutAccess().

Here is the caller graph for this function:

deleteTagsOfObject()

static ilTagging::deleteTagsOfObject ( int  $a_obj_id, string  $a_obj_type, int  $a_sub_obj_id, string  $a_sub_obj_type  )

static

Definition at line 257 of file class.ilTagging.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if ($a_sub_obj_type == "") {
            $a_sub_obj_type = "-";
        }
 
        $ilDB->manipulateF(
            "DELETE FROM il_tag " .
            "WHERE " .
            "obj_id = %s AND " .
            "obj_type = %s AND " .
            "sub_obj_id = %s AND " .
            $ilDB->equals("sub_obj_type", $a_sub_obj_type, "text", true),
            array("integer", "text", "integer"),
            array($a_obj_id, $a_obj_type, $a_sub_obj_id)
        );
    }

Referenced by ilTaggingAppEventListener\handleEvent().

Here is the caller graph for this function:

getObjectsForTagAndUser()

static ilTagging::getObjectsForTagAndUser ( int  $a_user_id, string  $a_tag  )

static

Definition at line 176 of file class.ilTagging.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $q = "SELECT * FROM il_tag WHERE " .
            "user_id = " . $ilDB->quote($a_user_id, "integer") .
            " AND tag = " . $ilDB->quote($a_tag, "text");
 
        $set = $ilDB->query($q);
        $objects = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            if (ilObject::_exists((int) $rec["obj_id"])) {
                if ($rec["sub_obj_type"] == "-") {
                    $rec["sub_obj_type"] = "";
                }
                $objects[] = $rec;
            } else {
                ilTagging::deleteTagsOfObject(
                    (int) $rec["obj_id"],
                    $rec["obj_type"],
                    (int) $rec["sub_obj_id"],
                    $rec["sub_obj_type"]
                );
            }
        }
 
        return $objects;
    }

Referenced by ilTaggingSlateContentGUI\removeTagsWithoutAccess(), and ilTaggingSlateContentGUI\renderResourcesForTag().

Here is the caller graph for this function:

getRelevanceClass()

static ilTagging::getRelevanceClass ( int  $cnt, int  $max  )

static

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

     : string {
        $m = $cnt / $max;
        if ($m >= 0.8) {
            return "ilTagRelVeryHigh";
        } elseif ($m >= 0.6) {
            return "ilTagRelHigh";
        } elseif ($m >= 0.4) {
            return "ilTagRelMiddle";
        } elseif ($m >= 0.2) {
            return "ilTagRelLow";
        }
 
        return "ilTagRelVeryLow";
    }

Referenced by ilTaggingGUI\getAllUserTagsForObjectHTML(), ilTaggingSlateContentGUI\renderTagCloud(), and TagRelevanceTest\testTagRelevance().

Here is the caller graph for this function:

getTagsForObject()

static ilTagging::getTagsForObject ( int  $a_obj_id, string  $a_obj_type, int  $a_sub_obj_id, string  $a_sub_obj_type, bool  $a_only_online = true  )

static

Definition at line 110 of file class.ilTagging.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $online_str = ($a_only_online)
            ? $online_str = " AND is_offline = " . $ilDB->quote(0, "integer") . " "
            : "";
 
        if ($a_sub_obj_type == "") {
            $a_sub_obj_type = "-";
        }
 
        $q = "SELECT count(user_id) as cnt, tag FROM il_tag WHERE " .
            "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) .
            $online_str .
            "GROUP BY tag ORDER BY tag ASC";
        $set = $ilDB->query($q);
        $tags = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $tags[] = $rec;
        }
 
        return $tags;
    }

Referenced by ilTaggingGUI\getAllUserTagsForObjectHTML().

Here is the caller graph for this function:

getTagsForUser()

static ilTagging::getTagsForUser ( int  $a_user_id, int  $a_max = 0, bool  $a_only_online = true  )

static

Definition at line 146 of file class.ilTagging.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $online_str = ($a_only_online)
            ? $online_str = " AND is_offline = " . $ilDB->quote(0, "integer") . " "
            : "";
 
        $set = $ilDB->query("SELECT count(*) as cnt, tag FROM il_tag WHERE " .
            "user_id = " . $ilDB->quote($a_user_id, "integer") . " " .
            $online_str .
            " GROUP BY tag ORDER BY cnt DESC");
        $tags = array();
        $cnt = 1;
        while (($rec = $ilDB->fetchAssoc($set)) &&
            ($a_max == 0 || $cnt <= $a_max)) {
            $tags[] = $rec;
            $cnt++;
        }
        $tags = ilArrayUtil::sortArray($tags, "tag", "asc");
 
        return $tags;
    }

Referenced by ilTaggingSlateContentGUI\__construct().

Here is the caller graph for this function:

getTagsForUserAndObject()

static ilTagging::getTagsForUserAndObject ( int  $a_obj_id, string  $a_obj_type, int  $a_sub_obj_id, string  $a_sub_obj_type, int  $a_user_id  )

static

Definition at line 77 of file class.ilTagging.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if ($a_sub_obj_type == "") {
            $a_sub_obj_type = "-";
        }
 
        $q = "SELECT * FROM il_tag 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 " .
            // PHP8 Review: Type cast is unnecessary
            "sub_obj_id = " . $ilDB->quote((int) $a_sub_obj_id, "integer") . " AND " .
            $ilDB->equals("sub_obj_type", $a_sub_obj_type, "text", true) .
            " ORDER BY tag";
        $set = $ilDB->query($q);
        $tags = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $tags[] = $rec["tag"];
        }
 
        return $tags;
    }

Referenced by ilObjectListGUI\getHeaderAction(), ilTaggingGUI\getHTML(), and ilTaggingGUI\getTaggingInputHTML().

Here is the caller graph for this function:

getUsersForTag()

static ilTagging::getUsersForTag ( string  $a_tag )

static

Definition at line 315 of file class.ilTagging.php.

     : array {
        global $DIC;
        $ilDB = $DIC->database();
 
        $set = $ilDB->query(
            "SELECT DISTINCT user_id, firstname, lastname FROM il_tag JOIN usr_data ON (user_id = usr_id) " .
            " WHERE LOWER(tag) = LOWER(" . $ilDB->quote($a_tag, "text") . ")" .
            " ORDER BY lastname, firstname"
        );
        $users = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $users[] = array("id" => $rec["user_id"]);
        }
        return $users;
    }

Referenced by ilUserForTagTableGUI\__construct().

Here is the caller graph for this function:

setTagsOfObjectOffline()

static ilTagging::setTagsOfObjectOffline ( int  $a_obj_id, string  $a_obj_type, int  $a_sub_obj_id, string  $a_sub_obj_type, bool  $a_offline = true  )

static

Definition at line 229 of file class.ilTagging.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if ($a_sub_obj_type == "") {
            $a_sub_obj_type = "-";
        }
 
        $ilDB->manipulateF(
            "UPDATE il_tag SET is_offline = %s " .
            "WHERE " .
            "obj_id = %s AND " .
            "obj_type = %s AND " .
            "sub_obj_id = %s AND " .
            $ilDB->equals("sub_obj_type", $a_sub_obj_type, "text", true),
            array("boolean", "integer", "text", "integer"),
            array($a_offline, $a_obj_id, $a_obj_type, $a_sub_obj_id)
        );
    }

Referenced by ilTaggingAppEventListener\handleEvent().

Here is the caller graph for this function:

writeTagsForUserAndObject()

static ilTagging::writeTagsForUserAndObject ( int  $a_obj_id, string  $a_obj_type, int  $a_sub_obj_id, string  $a_sub_obj_type, int  $a_user_id, array  $a_tags  )

static

Definition at line 28 of file class.ilTagging.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if ($a_sub_obj_type == "") {
            $a_sub_obj_type = "-";
        }
 
        $ilDB->manipulate("DELETE FROM il_tag 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 " .
            // PHP8 Review: Type cast is unnecessary
            "sub_obj_id = " . $ilDB->quote((int) $a_sub_obj_id, "integer") . " AND " .
            $ilDB->equals("sub_obj_type", $a_sub_obj_type, "text", true));
 
        if (is_array($a_tags)) {
            $inserted = array();
            foreach ($a_tags as $tag) {
                if (!in_array(strtolower($tag), $inserted)) {
                    $ilDB->replace(
                        "il_tag",
                        [        // pk
                        "user_id" => ["integer", $a_user_id],
                        "obj_id" => ["integer", $a_obj_id],
                        "obj_type" => ["text", $a_obj_type],
                        "sub_obj_id" => ["integer", $a_sub_obj_id],
                        "sub_obj_type" => ["text", $a_sub_obj_type],
                        "tag" => ["text", $tag]
                    ],
                        [
                            "is_offline" => ["integer", 0]
                        ]
                    );
                    $inserted[] = strtolower($tag);
                }
            }
        }
    }

Referenced by ilTaggingGUI\saveInput(), and ilTaggingGUI\saveJS().

Here is the caller graph for this function:

---

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

• components/ILIAS/Tagging/classes/class.ilTagging.php