ilTaggingSlateContentGUI Class Reference

Tagging slate UI. More...

Inheritance diagram for ilTaggingSlateContentGUI:

Collaboration diagram for ilTaggingSlateContentGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	executeCommand ()
	render ()
	Render. More...
	removeTagsWithoutAccess ()
	getNoTagsUsedMessage ()

Data Fields
const	CURRENT_TAG_KEY = "tag_current_tag"

Protected Member Functions
	renderTagCloud ()
	renderResourcesForTag ()
	showResourcesForTag ()
	show resources More...
	showTagCloud ()
	Show tag cloud. More...
	getRepositoryTitle ()
	send (string $output)
	Send. More...
	setCurrentTag (string $tag)
	getCurrentTag ()
	clearCurrentTag ()

Protected Attributes
ilCtrl	$ctrl
ilObjUser	$user
ILIAS DI UIServices	$ui
ilLanguage	$lng
ilAccessHandler	$access
ilTree	$tree
ILIAS HTTP Services	$http
string	$requested_tag
ilSessionIStorage	$store
array	$tags

Private Attributes
ilGlobalTemplateInterface	$main_tpl

Detailed Description

Tagging slate UI.

Author

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

Definition at line 29 of file class.ilTaggingSlateContentGUI.php.

Constructor & Destructor Documentation

__construct()

ilTaggingSlateContentGUI::__construct

(

)

Constructor.

Definition at line 48 of file class.ilTaggingSlateContentGUI.php.

References $DIC, $params, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), getCurrentTag(), ilTagging\getTagsForUser(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

    {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();

        $this->ctrl = $DIC->ctrl();
        $this->user = $DIC->user();
        $this->ui = $DIC->ui();
        $this->lng = $DIC->language();
        $this->access = $DIC->access();
        $this->tree = $DIC->repositoryTree();
        $this->http = $DIC->http();
        $this->store = new ilSessionIStorage("tag");

        $this->lng->loadLanguageModule("tagging");

        $this->tags = ilTagging::getTagsForUser($this->user->getId(), 1000000);

        $params = $this->http->request()->getQueryParams();
        $this->requested_tag = str_replace(
            "-->",
            "",
            $params["tag"] ?? ""
        );
        if ($this->requested_tag == "") {
            $this->requested_tag = $this->getCurrentTag();
        }
    }

Here is the call graph for this function:

Member Function Documentation

clearCurrentTag()

ilTaggingSlateContentGUI::clearCurrentTag ( )

protected

Definition at line 323 of file class.ilTaggingSlateContentGUI.php.

Referenced by renderTagCloud().

                                        : void
    {
        $this->store->set(self::CURRENT_TAG_KEY, "");
    }

Here is the caller graph for this function:

executeCommand()

ilTaggingSlateContentGUI::executeCommand

(

)

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

References $ctrl, ilCtrl\getCmd(), and ilCtrl\getNextClass().

                                    : void
    {
        $ctrl = $this->ctrl;

        $next_class = $ctrl->getNextClass($this);
        $cmd = $ctrl->getCmd();

        // PHP8 Review: 'switch' with single 'case'
        switch ($next_class) {
            default:
                if (in_array($cmd, array("showResourcesForTag", "showTagCloud"))) {
                    $this->$cmd();
                }
        }
    }

Here is the call graph for this function:

getCurrentTag()

ilTaggingSlateContentGUI::getCurrentTag ( )

protected

Definition at line 317 of file class.ilTaggingSlateContentGUI.php.

Referenced by __construct(), and render().

                                      : string
    {
        // PHP8 Review: Type cast is unnecessary
        return (string) $this->store->get(self::CURRENT_TAG_KEY);
    }

Here is the caller graph for this function:

getNoTagsUsedMessage()

ilTaggingSlateContentGUI::getNoTagsUsedMessage

(

)

Definition at line 272 of file class.ilTaggingSlateContentGUI.php.

References $txt, ilLink\_getStaticLink(), getRepositoryTitle(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Referenced by renderTagCloud().

                                          : ILIAS\UI\Component\MessageBox\MessageBox
    {
        $txt = $this->lng->txt("no_tag_text_1") . "<br>";
        $txt .= sprintf(
            $this->lng->txt('no_tag_text_2'),
            $this->getRepositoryTitle()
        ) . "<br>";
        $txt .= $this->lng->txt("no_tag_text_3");
        $mbox = $this->ui->factory()->messageBox()->info($txt);
        $mbox = $mbox->withLinks([$this->ui->factory()->link()->standard($this->getRepositoryTitle(), ilLink::_getStaticLink(1, 'root', true))]);

        return $mbox;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRepositoryTitle()

ilTaggingSlateContentGUI::getRepositoryTitle ( )

protected

Definition at line 286 of file class.ilTaggingSlateContentGUI.php.

References $nd, and ILIAS\Repository\lng().

Referenced by getNoTagsUsedMessage().

                                           : string
    {
        $nd = $this->tree->getNodeData($this->tree->getRootId());
        $title = $nd['title'];

        if ($title === 'ILIAS') {
            $title = $this->lng->txt('repository');
        }

        return $title;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

removeTagsWithoutAccess()

ilTaggingSlateContentGUI::removeTagsWithoutAccess

(

)

Definition at line 228 of file class.ilTaggingSlateContentGUI.php.

References $access, $ctrl, $ilUser, ILIAS\LTI\ToolProvider\$key, $lng, $ref_id, $requested_tag, $type, $user, ilObject\_getAllReferences(), ilTagging\deleteTagOfObjectForUser(), ilTagging\getObjectsForTagAndUser(), and ILIAS\Repository\int().

Referenced by renderResourcesForTag().

                                             : void
    {
        $ilCtrl = $this->ctrl;
        $ilAccess = $this->access;
        $ilUser = $this->user;
        $lng = $this->lng;
        $tag = $this->requested_tag;

        // get resources
        $objs = ilTagging::getObjectsForTagAndUser($ilUser->getId(), $tag);

        foreach ($objs as $key => $obj) {
            $ref_ids = ilObject::_getAllReferences((int) $obj["obj_id"]);
            if (count($ref_ids) == 0) {
                $inaccessible = true;
            } else {
                $inaccessible = false;
            }
            foreach ($ref_ids as $ref_id) {
                $type = $obj["obj_type"];

                if ($type == "") {
                    $inaccessible = true;
                    continue;
                }
                if (!$ilAccess->checkAccess("visible", "", $ref_id) &&
                    !$ilAccess->checkAccess("read", "", $ref_id) &&
                    !$ilAccess->checkAccess("write", "", $ref_id)) {
                    $inaccessible = true;
                }
                if ($inaccessible) {
                    ilTagging::deleteTagOfObjectForUser(
                        $ilUser->getId(),
                        (int) $obj["obj_id"],
                        (string) $obj["obj_type"],
                        (int) $obj["sub_obj_id"],
                        (string) $obj["sub_obj_type"],
                        $tag
                    );
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

render()

ilTaggingSlateContentGUI::render

(

)

Render.

Returns

string

Exceptions

ilTemplateException

Definition at line 98 of file class.ilTaggingSlateContentGUI.php.

References getCurrentTag(), renderResourcesForTag(), and renderTagCloud().

                            : string
    {
        if ($this->getCurrentTag() != "") {
            $content = $this->renderResourcesForTag();
        } else {
            $content = $this->renderTagCloud();
        }
        return "<div id='il-tag-slate-container'>" . $content . "</div>";
    }

Here is the call graph for this function:

renderResourcesForTag()

ilTaggingSlateContentGUI::renderResourcesForTag ( )

protected

Definition at line 151 of file class.ilTaggingSlateContentGUI.php.

References $access, $ctrl, Vendor\Package\$f, $id, $ilUser, ILIAS\LTI\ToolProvider\$key, $lng, $panel, $ref_id, $requested_tag, $type, $ui, $user, ilObject\_getAllReferences(), ilObject\_getIcon(), ilLink\_getLink(), ilObject\_lookupTitle(), ilCtrl\getLinkTarget(), ilTagging\getObjectsForTagAndUser(), removeTagsWithoutAccess(), ilUtil\secureString(), setCurrentTag(), ILIAS\Repository\ui(), and ILIAS\UI\Implementation\Component\withOnLoadCode().

Referenced by render(), and showResourcesForTag().

                                              : string
    {
        $ui = $this->ui;
        $lng = $this->lng;
        $ctrl = $this->ctrl;
        $access = $this->access;
        $ilUser = $this->user;
        $tag = $this->requested_tag;
        $this->setCurrentTag($tag);

        // back button
        $tag_cmd = $ctrl->getLinkTarget($this, "showTagCloud", "", true, false);
        $back_button = $ui->factory()->button()->bulky($ui->factory()->symbol()->glyph()->back(), $lng->txt("back"), "#")->withOnLoadCode(function ($id) use ($tag_cmd) {
            return
                "$(\"#$id\").click(function() { il.Util.ajaxReplaceInner('$tag_cmd', 'il-tag-slate-container'); return false;});";
        });

        // resource list
        $objs = ilTagging::getObjectsForTagAndUser($ilUser->getId(), $tag);

        $f = $this->ui->factory();
        $item_groups = [];
        $items = [];
        foreach ($objs as $key => $obj) {
            $ref_ids = ilObject::_getAllReferences((int) $obj["obj_id"]);
            foreach ($ref_ids as $ref_id) {
                $type = $obj["obj_type"];

                if ($type == "" || (!$access->checkAccess("visible", "", $ref_id) &&
                        !$access->checkAccess("read", "", $ref_id))) {
                    continue;
                }

                $title = ilObject::_lookupTitle((int) $obj["obj_id"]);
                $items[] = $f->item()->standard(
                    $f->link()->standard($title, ilLink::_getLink($ref_id))
                )->withLeadIcon($f->symbol()->icon()->custom(ilObject::_getIcon((int) $obj["obj_id"]), $title));
            }
        }
        $item_groups[] = $f->item()->group(sprintf(
            $lng->txt("tagging_resources_for_tag"),
            "<i>" . ilUtil::secureString($tag) . "</i>"
        ), $items);
        $panel = $f->panel()->secondary()->listing("", $item_groups);

        $components = [$back_button, $panel];
        if (count($items) == 0) {
            $mbox = $f->messageBox()->info(
                sprintf($lng->txt("tagging_no_obj_for_tag"), ilUtil::secureString($tag))
            );
            $this->removeTagsWithoutAccess();
            $components = [$back_button, $mbox];
        }

        return $ui->renderer()->renderAsync($components);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderTagCloud()

ilTaggingSlateContentGUI::renderTagCloud ( )

protected

Definition at line 109 of file class.ilTaggingSlateContentGUI.php.

References $ctrl, $tpl, clearCurrentTag(), getNoTagsUsedMessage(), ilTagging\getRelevanceClass(), and ILIAS\Repository\ui().

Referenced by render(), and showTagCloud().

                                       : string
    {
        $ilCtrl = $this->ctrl;
        $this->clearCurrentTag();

        $tpl = new ilTemplate(
            "tpl.tag_cloud.html",
            true,
            true,
            "Services/Tagging"
        );
        $max = 1;
        foreach ($this->tags as $tag) {
            $max = max($tag["cnt"], $max);
        }
        reset($this->tags);

        if (count($this->tags) > 0) {
            foreach ($this->tags as $tag) {
                $tpl->setCurrentBlock("linked_tag");
                $ilCtrl->setParameter($this, "tag", rawurlencode($tag["tag"]));
                $list_cmd = $ilCtrl->getLinkTarget($this, "showResourcesForTag");
                $tpl->setVariable(
                    "ON_CLICK",
                    "il.Util.ajaxReplaceInner('$list_cmd', 'il-tag-slate-container'); return false;"
                );
                $tpl->setVariable("TAG_TITLE", $tag["tag"]);
                $tpl->setVariable("HREF_TAG", "#");
                $tpl->setVariable(
                    "REL_CLASS",
                    ilTagging::getRelevanceClass((int) $tag["cnt"], (int) $max)
                );
                $tpl->parseCurrentBlock();
            }
            return $tpl->get();
        }

        return $this->ui->renderer()->render($this->getNoTagsUsedMessage());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

send()

ilTaggingSlateContentGUI::send ( string  $output )

protected

Send.

Parameters

string

$output

Exceptions

ResponseSendingException

Definition at line 303 of file class.ilTaggingSlateContentGUI.php.

References ILIAS\FileDelivery\http().

Referenced by showResourcesForTag(), and showTagCloud().

                                           : void
    {
        $this->http->saveResponse($this->http->response()->withBody(
            Streams::ofString($output)
        ));
        $this->http->sendResponse();
        $this->http->close();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setCurrentTag()

ilTaggingSlateContentGUI::setCurrentTag ( string  $tag )

protected

Definition at line 312 of file class.ilTaggingSlateContentGUI.php.

Referenced by renderResourcesForTag().

                                                 : void
    {
        $this->store->set(self::CURRENT_TAG_KEY, $tag);
    }

Here is the caller graph for this function:

showResourcesForTag()

ilTaggingSlateContentGUI::showResourcesForTag ( )

protected

show resources

Exceptions

ResponseSendingException

Definition at line 212 of file class.ilTaggingSlateContentGUI.php.

References renderResourcesForTag(), and send().

                                            : void
    {
        $this->send($this->renderResourcesForTag());
    }

Here is the call graph for this function:

showTagCloud()

ilTaggingSlateContentGUI::showTagCloud ( )

protected

Show tag cloud.

Exceptions

ResponseSendingException

Definition at line 221 of file class.ilTaggingSlateContentGUI.php.

References renderTagCloud(), and send().

                                     : void
    {
        $this->send($this->renderTagCloud());
    }

Here is the call graph for this function:

Field Documentation

$access

ilAccessHandler ilTaggingSlateContentGUI::$access

protected

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

Referenced by removeTagsWithoutAccess(), and renderResourcesForTag().

$ctrl

ilCtrl ilTaggingSlateContentGUI::$ctrl

protected

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

Referenced by executeCommand(), removeTagsWithoutAccess(), renderResourcesForTag(), and renderTagCloud().

$http

ILIAS HTTP Services ilTaggingSlateContentGUI::$http

protected

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

$lng

ilLanguage ilTaggingSlateContentGUI::$lng

protected

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

Referenced by removeTagsWithoutAccess(), and renderResourcesForTag().

$main_tpl

ilGlobalTemplateInterface ilTaggingSlateContentGUI::$main_tpl

private

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

$requested_tag

string ilTaggingSlateContentGUI::$requested_tag

protected

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

Referenced by removeTagsWithoutAccess(), and renderResourcesForTag().

$store

ilSessionIStorage ilTaggingSlateContentGUI::$store

protected

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

$tags

array ilTaggingSlateContentGUI::$tags

protected

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

$tree

ilTree ilTaggingSlateContentGUI::$tree

protected

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

$ui

ILIAS DI UIServices ilTaggingSlateContentGUI::$ui

protected

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

Referenced by renderResourcesForTag().

$user

ilObjUser ilTaggingSlateContentGUI::$user

protected

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

Referenced by removeTagsWithoutAccess(), and renderResourcesForTag().

CURRENT_TAG_KEY

const ilTaggingSlateContentGUI::CURRENT_TAG_KEY = "tag_current_tag"

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

---

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

• Services/Tagging/classes/class.ilTaggingSlateContentGUI.php