Tag classification provider. More...

Inheritance diagram for ilTaggingClassificationProvider:

Collaboration diagram for ilTaggingClassificationProvider:

Public Member Functions
	__construct (int $a_parent_ref_id, int $a_parent_obj_id, string $a_parent_obj_type)

	render (array &$a_html, object $a_parent_gui)
	@inheritDoc More...

	importPostData (?array $a_saved=null)
	@inheritDoc More...

	setSelection (array $a_value)
	@inheritDoc More...

	getFilteredObjects ()
	@inheritDoc More...

	initListGUI (ilObjectListGUI $a_list_gui)
	Init list gui properties. More...

	__construct (int $a_parent_ref_id, int $a_parent_obj_id, string $a_parent_obj_type)

	render (array &$a_html, object $a_parent_gui)
	Render HTML chunks. More...

	importPostData (?array $a_saved=null)
	Import post data. More...

	setSelection (array $a_value)
	Set selection. More...

	getFilteredObjects ()
	Get filtered object ref ids. More...

	initListGUI (ilObjectListGUI $a_list_gui)
	Init list gui properties. More...

Static Public Member Functions
static	isActive (int $a_parent_ref_id, int $a_parent_obj_id, string $a_parent_obj_type)
	@inheritDoc More...

Static Public Member Functions inherited from ilClassificationProvider
static	getValidProviders (int $a_parent_ref_id, int $a_parent_obj_id, string $a_parent_obj_type)
	Get all valid providers (for parent container) More...

static	isActive (int $a_parent_ref_id, int $a_parent_obj_id, string $a_parent_obj_type)
	Is provider currently active? More...

Protected Member Functions
	init ()

	getSubTreeTags ()

	init ()

Protected Attributes
ilLanguage	$lng

ilObjUser	$user

ilTree	$tree

ilObjectDefinition	$obj_definition

ilCtrl	$ctrl

RequestInterface	$request

string	$requested_type

string	$requested_tag_code

bool	$enable_all_users = false

array	$selection

Protected Attributes inherited from ilClassificationProvider
int	$parent_ref_id

int	$parent_obj_id

string	$parent_type

RequestInterface	$request

Detailed Description

Tag classification provider.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilTaggingClassificationProvider::__construct	(	int	$a_parent_ref_id,
		int	$a_parent_obj_id,
		string	$a_parent_obj_type
	)

Reimplemented from ilClassificationProvider.

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

      {
        global $DIC;
        parent::__construct($a_parent_ref_id, $a_parent_obj_id, $a_parent_obj_type);
 
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->tree = $DIC->repositoryTree();
        $this->obj_definition = $DIC["objDefinition"];
        $this->ctrl = $DIC->ctrl();
        $this->request = $DIC->http()->request();
 
        $params = $this->request->getQueryParams();
        $body = $this->request->getParsedBody();
        $this->requested_type = trim($body["tag_type"] ?? ($params["tag_type"] ?? ""));
        $this->requested_tag_code = trim($body["tag"] ?? ($params["tag"] ?? ""));
    }

References $DIC, $params, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ getFilteredObjects()

ilTaggingClassificationProvider::getFilteredObjects ( )

@inheritDoc

Reimplemented from ilClassificationProvider.

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

                                        : array
    {
        $ilUser = $this->user;
 
        if (!$this->selection) {
            return[];
        }
 
        $types = array("personal");
        if ($this->enable_all_users) {
            $types[] = "other";
        }
 
        $found = array();
        foreach ($types as $type) {
            if (isset($this->selection[$type])) {
                $invert = ($type == "personal")
                    ? false
                    : true;
 
                foreach ($this->selection[$type] as $tag) {
                    $found[$tag] = array_keys(ilTagging::_findObjectsByTag((string) $tag, $ilUser->getId(), $invert));
                }
            }
        }
 
        /* OR
        $res = array();
        foreach($found as $tag => $ids)
        {
            $res = array_merge($res, $ids);
        }
        */
 
        // AND
        $res = null;
        foreach ($found as $tag => $ids) {
            if ($res === null) {
                $res = $ids;
            } else {
                $res = array_intersect($res, $ids);
            }
        }
 
        if (!is_null($res) && count($res) > 0) {
            return array_unique($res);
        }
        return [];
    }

References $ilUser, $res, $type, and ilTagging\_findObjectsByTag().

Here is the call graph for this function:

◆ getSubTreeTags()

ilTaggingClassificationProvider::getSubTreeTags ( )

protected

Definition at line 256 of file class.ilTaggingClassificationProvider.php.

                                       : array
    {
        $tree = $this->tree;
        $ilUser = $this->user;
        $sub_ids = array();
 
        // categories show only direct children and their tags
        if (ilObject::_lookupType($this->parent_ref_id, true) == "cat") {
            foreach ($tree->getChilds($this->parent_ref_id) as $sub_item) {
                if ($sub_item["ref_id"] != $this->parent_ref_id &&
                    $sub_item["type"] != "rolf" &&
                    !$tree->isDeleted((int) $sub_item["ref_id"])) {
                    $sub_ids[$sub_item["obj_id"]] = $sub_item["type"];
                }
            }
        } else {
            foreach ($tree->getSubTree($tree->getNodeData($this->parent_ref_id)) as $sub_item) {
                if ($sub_item["ref_id"] != $this->parent_ref_id &&
                    $sub_item["type"] != "rolf" &&
                    !$tree->isDeleted((int) $sub_item["ref_id"])) {
                    $sub_ids[$sub_item["obj_id"]] = $sub_item["type"];
                }
            }
        }
 
        if ($sub_ids) {
            $only_user = $this->enable_all_users
                ? null
                : $ilUser->getId();
 
            return ilTagging::_getTagCloudForObjects($sub_ids, $only_user, $ilUser->getId());
        }
        return [];
    }

References $ilUser, ilTagging\_getTagCloudForObjects(), ilObject\_lookupType(), ilTree\getChilds(), ilTree\getNodeData(), ilTree\getSubTree(), and ilTree\isDeleted().

Here is the call graph for this function:

◆ importPostData()

ilTaggingClassificationProvider::importPostData ( ?array $a_saved = null )

@inheritDoc

Reimplemented from ilClassificationProvider.

Definition at line 162 of file class.ilTaggingClassificationProvider.php.

                                                          : array
    {
        $type = $this->requested_type;
        $tag_code = $this->requested_tag_code;
        if ($type && $tag_code) {
            // code to tag
            $found = null;
            foreach ($this->getSubTreeTags() as $tags) {
                foreach (array_keys($tags) as $tag) {
                    if (md5((string) $tag) === $tag_code) {
                        $found = $tag;
                        break(2);
                    }
                }
            }
            if ($found) {
                // multi select
                if (isset($a_saved[$type]) &&
                    in_array($found, $a_saved[$type])) {
                    $key = array_search($found, $a_saved[$type]);
                    unset($a_saved[$type][$key]);
                    if (!sizeof($a_saved[$type])) {
                        unset($a_saved[$type]);
                    }
                } else {
                    $a_saved[$type][] = $found;
                }
            }
            return $a_saved ?? [];
        }
        return [];
    }

References ILIAS\LTI\ToolProvider\$key, and $type.

◆ init()

ilTaggingClassificationProvider::init ( )

protected

Reimplemented from ilClassificationProvider.

Definition at line 62 of file class.ilTaggingClassificationProvider.php.

                             : void
    {
        $tags_set = new ilSetting("tags");
        $this->enable_all_users = (bool) $tags_set->get("enable_all_users", '0');
    }

◆ initListGUI()

ilTaggingClassificationProvider::initListGUI ( ilObjectListGUI $a_list_gui )

Init list gui properties.

Reimplemented from ilClassificationProvider.

Definition at line 291 of file class.ilTaggingClassificationProvider.php.

                                                            : void
    {
        $a_list_gui->enableTags(true);
    }

References ilObjectListGUI\enableTags().

Here is the call graph for this function:

◆ isActive()

static ilTaggingClassificationProvider::isActive	(	int	$a_parent_ref_id,
		int	$a_parent_obj_id,
		string	$a_parent_obj_type
	)

static

@inheritDoc

Reimplemented from ilClassificationProvider.

Definition at line 71 of file class.ilTaggingClassificationProvider.php.

     : bool {
        global $DIC;
 
        $ilUser = $DIC->user();
 
        // we currently only check for the parent object setting
        // might change later on (parent containers)
        $valid = (bool) ilContainer::_lookupContainerSetting(
            $a_parent_obj_id,
            ilObjectServiceSettingsGUI::TAG_CLOUD,
            '0'
        );
 
        if ($valid) {
            $tags_set = new ilSetting("tags");
            if (!$tags_set->get("enable_all_users", '0') &&
                $ilUser->getId() === ANONYMOUS_USER_ID) {
                $valid = false;
            }
        }
 
        return $valid;
    }

References $ilUser, $valid, and ANONYMOUS_USER_ID.

◆ render()

ilTaggingClassificationProvider::render	(	array &	$a_html,
		object	$a_parent_gui
	)

@inheritDoc

Reimplemented from ilClassificationProvider.

Definition at line 102 of file class.ilTaggingClassificationProvider.php.

     : void {
        $lng = $this->lng;
        $ctrl = $this->ctrl;
 
        $lng->loadLanguageModule("tagging");
        $all_tags = $this->getSubTreeTags();
        if ($all_tags) {
            $map = array(
                "personal" => $lng->txt("tagging_my_tags"),
                "other" => $lng->txt("tagging_other_users")
            );
            foreach ($map as $type => $title) {
                $tags = $all_tags[$type] ?? null;
                if ($tags) {
                    $max = 1;
                    foreach ($tags as $tag => $counter) {
                        $max = max($counter, $max);
                    }
                    reset($tags);
 
                    $tpl = new ilTemplate("tpl.tag_cloud_block.html", true, true, "Services/Tagging");
 
                    $tpl->setCurrentBlock("tag_bl");
                    foreach ($tags as $tag => $counter) {
                        $ctrl->setParameter($a_parent_gui, "tag_type", $type);
                        $ctrl->setParameter($a_parent_gui, "tag", md5((string) $tag));
                        $tpl->setVariable("HREF", $ctrl->getLinkTarget($a_parent_gui, "toggle"));
 
                        $tpl->setVariable("TAG_TYPE", $type);
                        $tpl->setVariable("TAG_TITLE", $tag);
                        $tpl->setVariable("TAG_CODE", md5((string) $tag));
                        $tpl->setVariable(
                            "REL_CLASS",
                            ilTagging::getRelevanceClass($counter, $max)
                        );
                        if (isset($this->selection[$type]) &&
                            in_array($tag, $this->selection[$type])) {
                            $tpl->setVariable("HIGHL_CLASS", ' ilHighlighted');
                        }
 
                        $tpl->parseCurrentBlock();
                        $ctrl->setParameter($a_parent_gui, "tag_type", "");
                        $ctrl->setParameter($a_parent_gui, "tag", "");
                    }
 
                    $a_html[] = array(
                        "title" => $title,
                        "html" => $tpl->get()
                    );
                }
            }
        }
    }

◆ setSelection()

ilTaggingClassificationProvider::setSelection ( array $a_value )

@inheritDoc

Reimplemented from ilClassificationProvider.

Definition at line 198 of file class.ilTaggingClassificationProvider.php.

                                                : void
    {
        $this->selection = $a_value;
    }

Field Documentation

◆ $ctrl

ilCtrl ilTaggingClassificationProvider::$ctrl

protected

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

◆ $enable_all_users

bool ilTaggingClassificationProvider::$enable_all_users = false

protected

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

◆ $lng

ilLanguage ilTaggingClassificationProvider::$lng

protected

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

◆ $obj_definition

ilObjectDefinition ilTaggingClassificationProvider::$obj_definition

protected

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

◆ $request

RequestInterface ilTaggingClassificationProvider::$request

protected

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

◆ $requested_tag_code

string ilTaggingClassificationProvider::$requested_tag_code

protected

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

◆ $requested_type

string ilTaggingClassificationProvider::$requested_type

protected

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

◆ $selection

array ilTaggingClassificationProvider::$selection

protected

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

◆ $tree

ilTree ilTaggingClassificationProvider::$tree

protected

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

◆ $user

ilObjUser ilTaggingClassificationProvider::$user

protected

Definition at line 31 of file class.ilTaggingClassificationProvider.php.

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

Services/Tagging/classes/class.ilTaggingClassificationProvider.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getFilteredObjects()

◆ getSubTreeTags()

◆ importPostData()

◆ init()

◆ initListGUI()

◆ isActive()

◆ render()

◆ setSelection()

Field Documentation

◆ $ctrl

◆ $enable_all_users

◆ $lng

◆ $obj_definition

◆ $request

◆ $requested_tag_code

◆ $requested_type

◆ $selection

◆ $tree

◆ $user