Collaboration diagram for ilTagging:

Public Member Functions
	__construct ()
	Constructor. More...

Static Public Member Functions
static	writeTagsForUserAndObject ( $a_obj_id, $a_obj_type, $a_sub_obj_id, $a_sub_obj_type, $a_user_id, $a_tags)
	Write tags for a user and an object. More...

static	getTagsForUserAndObject ( $a_obj_id, $a_obj_type, $a_sub_obj_id, $a_sub_obj_type, $a_user_id)
	Get tags for a user and an object. More...

static	getTagsForObject ( $a_obj_id, $a_obj_type, $a_sub_obj_id, $a_sub_obj_type, $a_only_online=true)
	Get tags for an object. More...

static	getTagsForUser ($a_user_id, $a_max=0, $a_only_online=true)
	Get tags for a user. More...

static	getObjectsForTagAndUser ($a_user_id, $a_tag)
	Get objects for tag and user. More...

static	calculateFontSize ($cnt, $max)
	Returns 100(%) for 1 and 150(%) for $max y = a + mx 100 = a + m (1) 150 = a + m * max (2) (1): a = 100 - m (3) (2): a = 150 - maxm (4) (3)&(4): m - 100 = maxm - 150 (5) (5) 50 = (max-1)*m => m = 50/(max -1) => a = 100 - 50/(max -1) More...

static	getRelevanceClass ($cnt, $max)
	Get style class for tag relevance. More...

static	setTagsOfObjectOffline ( $a_obj_id, $a_obj_type, $a_sub_obj_id, $a_sub_obj_type, $a_offline=true)
	Set offline. More...

static	deleteTagsOfObject ($a_obj_id, $a_obj_type, $a_sub_obj_id, $a_sub_obj_type)
	Deletes tags of an object. More...

static	deleteTagOfObjectForUser ($a_user_id, $a_obj_id, $a_obj_type, $a_sub_obj_id, $a_sub_obj_type, $a_tag)
	Deletes tag of an object. More...

static	getUsersForTag ($a_tag)
	Get users for tag. More...

static	_countTags ($a_obj_ids, $a_all_users=false)
	Count all tags for repository objects. More...

static	_getTagCloudForObjects (array $a_obj_ids, $a_user_id=null, $a_divide=false)
	Count tags for given object ids. More...

static	_findObjectsByTag ($a_tag, $a_user_id=null, $a_invert=false)
	Find all objects with given tag. More...

static	_getListTagsForObjects (array $a_obj_ids, $a_user_id=null)
	Get tags for given object ids. More...

Protected Attributes
	$db

Detailed Description

Class ilTagging.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilTagging::__construct ( )

Constructor.

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

References $DIC.

     {
         global $DIC;
 
         $this->db = $DIC->database();
     }

Member Function Documentation

◆ _countTags()

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

static

Count all tags for repository objects.

Parameters

array	$a_obj_ids	repository object IDs array
bool	$a_all_users

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

References $DIC, $ilDB, $ilUser, and array.

Referenced by ilObjectListGUI\preloadCommonProperties().

     {
         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");
         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;
     }

Here is the caller graph for this function:

◆ _findObjectsByTag()

static ilTagging::_findObjectsByTag	(	$a_tag,
		$a_user_id = `null`,
		$a_invert = `false`
	)

static

Find all objects with given tag.

Parameters

string	$a_tag
int	$a_user_id

Returns: array

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

References $DIC, $ilDB, $res, $row, and array.

Referenced by ilTaggingClassificationProvider\getFilteredObjects().

     {
         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;
     }

Here is the caller graph for this function:

◆ _getListTagsForObjects()

static ilTagging::_getListTagsForObjects	(	array	$a_obj_ids,
			$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 518 of file class.ilTagging.php.

References $DIC, $ilDB, $ilUser, $res, $row, $tag, and array.

Referenced by ilTaggingGUI\getHTML(), and ilObjectListGUI\preloadCommonProperties().

     {
         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;
     }

Here is the caller graph for this function:

◆ _getTagCloudForObjects()

static ilTagging::_getTagCloudForObjects	(	array	$a_obj_ids,
			$a_user_id = `null`,
			$a_divide = `false`
	)

static

Count tags for given object ids.

Parameters

array	$a_obj_ids	obj_id => type
int	$a_user_id
int	$a_divide

Returns: array obj_id => counter

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

References $DIC, $ilDB, $res, $row, $tag, and array.

Referenced by ilTaggingClassificationProvider\getSubTreeTags().

     {
         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) {
                     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;
     }

Here is the caller graph for this function:

◆ calculateFontSize()

static ilTagging::calculateFontSize	(	$cnt,
		$max
	)

static

Returns 100(%) for 1 and 150(%) for $max y = a + mx 100 = a + m (1) 150 = a + m * max (2) (1): a = 100 - m (3) (2): a = 150 - max*m (4) (3)&(4): m - 100 = max*m - 150 (5) (5) 50 = (max-1)*m => m = 50/(max -1) => a = 100 - 50/(max -1)

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

References $m.

     {
         $m = ($max == 1)
             ? 0
             : 50 / ($max - 1);
         $a = 100 - $m;
         $font_size = round($a + ($m * $cnt));
         return (int) $font_size;
     }

◆ deleteTagOfObjectForUser()

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

static

Deletes tag of an object.

Parameters

int	$a_user_id	User Id
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
string	$a_tag	Tag

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

References $DIC, $ilDB, and array.

Referenced by ilPDTaggingBlockGUI\removeTagsWithoutAccess().

     {
         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)
         );
     }

Here is the caller graph for this function:

◆ deleteTagsOfObject()

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

static

Deletes tags of 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

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

References $DIC, $ilDB, and array.

Referenced by getObjectsForTagAndUser(), and ilTaggingAppEventListener\handleEvent().

     {
         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)
         );
     }

Here is the caller graph for this function:

◆ getObjectsForTagAndUser()

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

static

Get objects for tag and user.

Parameters

int $a_user_id User ID

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

References $DIC, $ilDB, ilObject\_exists(), array, and deleteTagsOfObject().

Referenced by ilPDTaggingBlockGUI\removeTagsWithoutAccess(), and ilPDTaggingBlockGUI\showResourcesForTag().

     {
         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($rec["obj_id"])) {
                 if ($rec["sub_obj_type"] == "-") {
                     $rec["sub_obj_type"] = "";
                 }
                 $objects[] = $rec;
             } else {
                 ilTagging::deleteTagsOfObject(
                     $rec["obj_id"],
                     $rec["obj_type"],
                     $rec["sub_obj_id"],
                     $rec["sub_obj_type"]
                 );
             }
         }
 
         return $objects;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRelevanceClass()

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

static

Get style class for tag relevance.

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

References $m.

Referenced by ilTaggingGUI\getAllUserTagsForObjectHTML(), ilPDTaggingBlockGUI\getTagCloud(), ilTaggingClassificationProvider\render(), and ilObjBlogGUI\renderNavigationByKeywords().

     {
         $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";
     }

Here is the caller graph for this function:

◆ getTagsForObject()

static ilTagging::getTagsForObject	(	$a_obj_id,
		$a_obj_type,
		$a_sub_obj_id,
		$a_sub_obj_type,
		$a_only_online = `true`
	)

static

Get tags 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

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

References $DIC, $ilDB, $tags, and array.

Referenced by ilTaggingGUI\getAllUserTagsForObjectHTML().

       {
         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;
     }

Here is the caller graph for this function:

◆ getTagsForUser()

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

static

Get tags for a user.

Parameters

int $a_user_id User ID

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

References $DIC, $ilDB, $tags, array, and ilUtil\sortArray().

Referenced by ilPDTaggingBlockGUI\fillDataSection().

     {
         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 = ilUtil::sortArray($tags, "tag", "asc");
 
         return $tags;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTagsForUserAndObject()

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

static

Get tags 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 96 of file class.ilTagging.php.

References $DIC, $ilDB, $tags, and array.

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

       {
         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 " .
             "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 ASC";
         $set = $ilDB->query($q);
         $tags = array();
         while ($rec = $ilDB->fetchAssoc($set)) {
             $tags[] = $rec["tag"];
         }
         
         return $tags;
     }

Here is the caller graph for this function:

◆ getUsersForTag()

static ilTagging::getUsersForTag ( $a_tag )

static

Get users for tag.

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

References $DIC, $ilDB, $users, and array.

Referenced by ilUserForTagTableGUI\__construct().

     {
         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;
     }

Here is the caller graph for this function:

◆ setTagsOfObjectOffline()

static ilTagging::setTagsOfObjectOffline	(	$a_obj_id,
		$a_obj_type,
		$a_sub_obj_id,
		$a_sub_obj_type,
		$a_offline = `true`
	)

static

Set offline.

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
boolean	$a_offline	Offline (true/false, true means offline!)

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

References $DIC, $ilDB, and array.

Referenced by ilTaggingAppEventListener\handleEvent().

       {
         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)
         );
     }

Here is the caller graph for this function:

◆ writeTagsForUserAndObject()

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

static

Write tags 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
array	$a_tags	Tags

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

References $DIC, $ilDB, $tag, and array.

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

       {
         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 " .
             "sub_obj_id = " . $ilDB->quote((int) $a_sub_obj_id, "integer") . " AND " .
             $ilDB->equals("sub_obj_type", $a_sub_obj_type, "text", true));
         //"sub_obj_type = ".$ilDB->quote($a_sub_obj_type, "text"));
         
         if (is_array($a_tags)) {
             $inserted = array();
             foreach ($a_tags as $tag) {
                 if (!in_array(strtolower($tag), $inserted)) {
                     //$tag = str_replace(" ", "_", trim($tag));
                     $ilDB->manipulate("INSERT INTO il_tag (user_id, obj_id, obj_type," .
                         "sub_obj_id, sub_obj_type, tag) 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($tag, "text") . ")");
 
                     $inserted[] = strtolower($tag);
                 }
             }
         }
     }

Here is the caller graph for this function:

Field Documentation

◆ $db

ilTagging::$db

protected

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

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

Services/Tagging/classes/class.ilTagging.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _countTags()

◆ _findObjectsByTag()

◆ _getListTagsForObjects()

◆ _getTagCloudForObjects()

◆ calculateFontSize()

◆ deleteTagOfObjectForUser()

◆ deleteTagsOfObject()

◆ getObjectsForTagAndUser()

◆ getRelevanceClass()

◆ getTagsForObject()

◆ getTagsForUser()

◆ getTagsForUserAndObject()

◆ getUsersForTag()

◆ setTagsOfObjectOffline()

◆ writeTagsForUserAndObject()

Field Documentation

◆ $db