ilTaggingSlateContentGUI Class Reference

Tagging slate UI. More...

Collaboration diagram for ilTaggingSlateContentGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	executeCommand ()
	Execute command. More...
	render ()
	Render. More...
	removeTagsWithoutAccess ()
	Remove tasg without access. More...
	getNoTagsUsedMessage ()
	No tags used message box. More...

Data Fields
const	CURRENT_TAG_KEY = "tag_current_tag"

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

Protected Attributes
	$ctrl
	$user
	$ui
	$lng
	$access
	$tree
	$http
	$requested_tag
	$store

Detailed Description

Tagging slate UI.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilTaggingSlateContentGUI::__construct

(

)

Constructor.

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

References $DIC, getCurrentTag(), ilTagging\getTagsForUser(), ILIAS\FileDelivery\http(), ui(), and user().

    {
        global $DIC;

        $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);

        $this->requested_tag = str_replace(
            "-->",
            "",
            $this->http->request()->getQueryParams()["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

Clear current tag.

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

Referenced by renderTagCloud().

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

Here is the caller graph for this function:

executeCommand()

ilTaggingSlateContentGUI::executeCommand

(

)

Execute command.

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

References $ctrl.

    {
        $ctrl = $this->ctrl;

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

        switch ($next_class) {
            default:
                if (in_array($cmd, array("showResourcesForTag", "showTagCloud"))) {
                    $this->$cmd();
                }
        }
    }

getCurrentTag()

ilTaggingSlateContentGUI::getCurrentTag ( )

protected

Get current tag.

Returns

string

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

Referenced by __construct(), and render().

    {
        return $this->store->get(self::CURRENT_TAG_KEY);
    }

Here is the caller graph for this function:

getNoTagsUsedMessage()

ilTaggingSlateContentGUI::getNoTagsUsedMessage

(

)

No tags used message box.

Returns

ILIAS

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

References $txt, ilLink\_getStaticLink(), getRepositoryTitle(), and 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

Returns

string

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

References $nd.

Referenced by getNoTagsUsedMessage().

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

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

        return $title;
    }

Here is the caller graph for this function:

removeTagsWithoutAccess()

ilTaggingSlateContentGUI::removeTagsWithoutAccess

(

)

Remove tasg without access.

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

References $access, $ctrl, $ilUser, $lng, $requested_tag, $type, $user, ilObject\_getAllReferences(), ilTagging\deleteTagOfObjectForUser(), and ilTagging\getObjectsForTagAndUser().

    {
        $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($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(), $obj["obj_id"], $obj["obj_type"], $obj["sub_obj_id"], $obj["sub_obj_type"], $tag);
                }
            }
        }

        ilUtil::sendSuccess($lng->txt("tag_tags_deleted"), true);

        $ilCtrl->returnToParent($this);
    }

Here is the call graph for this function:

render()

ilTaggingSlateContentGUI::render

(

)

Render.

Returns

string

Exceptions

ilTemplateException

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

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

    {
        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

Render resources.

Returns

string

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

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

Referenced by render(), and showResourcesForTag().

    {
        $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
        include_once("./Services/Tagging/classes/class.ilTagging.php");
        $objs = ilTagging::getObjectsForTagAndUser($ilUser->getId(), $tag);

        $f = $this->ui->factory();
        $item_groups = [];
        $items = [];
        foreach ($objs as $key => $obj) {
            $ref_ids = ilObject::_getAllReferences($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($obj["obj_id"]);
                $items[] = $f->item()->standard(
                    $f->link()->standard($title, ilLink::_getLink($ref_id))
                )->withLeadIcon($f->symbol()->icon()->custom(ilObject::_getIcon($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))
            );
            $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

Get tag cloud.

Returns

string

Exceptions

ilTemplateException

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

References $ctrl, $tpl, clearCurrentTag(), getNoTagsUsedMessage(), ilTagging\getRelevanceClass(), and 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($tag["cnt"], $max)
                );
                $tpl->parseCurrentBlock();
            }
            return $tpl->get();
        } else {
            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

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

References ILIAS\FileDelivery\http().

Referenced by showResourcesForTag(), and showTagCloud().

    {
        $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

Set current tag.

Parameters

string

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

Referenced by renderResourcesForTag().

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

Here is the caller graph for this function:

showResourcesForTag()

ilTaggingSlateContentGUI::showResourcesForTag ( )

protected

show resources

Exceptions

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

References renderResourcesForTag(), and send().

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

Here is the call graph for this function:

showTagCloud()

ilTaggingSlateContentGUI::showTagCloud ( )

protected

Show tag cloud.

Exceptions

ilTemplateException

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

References renderTagCloud(), and send().

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

Here is the call graph for this function:

Field Documentation

$access

ilTaggingSlateContentGUI::$access

protected

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

Referenced by removeTagsWithoutAccess(), and renderResourcesForTag().

$ctrl

ilTaggingSlateContentGUI::$ctrl

protected

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

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

$http

ilTaggingSlateContentGUI::$http

protected

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

$lng

ilTaggingSlateContentGUI::$lng

protected

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

Referenced by removeTagsWithoutAccess(), and renderResourcesForTag().

$requested_tag

ilTaggingSlateContentGUI::$requested_tag

protected

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

Referenced by removeTagsWithoutAccess(), and renderResourcesForTag().

$store

ilTaggingSlateContentGUI::$store

protected

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

$tree

ilTaggingSlateContentGUI::$tree

protected

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

$ui

ilTaggingSlateContentGUI::$ui

protected

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

Referenced by renderResourcesForTag().

$user

ilTaggingSlateContentGUI::$user

protected

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

Referenced by removeTagsWithoutAccess(), and renderResourcesForTag().

CURRENT_TAG_KEY

const ilTaggingSlateContentGUI::CURRENT_TAG_KEY = "tag_current_tag"

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

---

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

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