ilTaggingGUI Class Reference

Class ilTaggingGUI. More...

Collaboration diagram for ilTaggingGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	executeCommand ()
	Execute command. More...
	setObject (int $a_obj_id, string $a_obj_type, int $a_sub_obj_id=0, string $a_sub_obj_type="")
	Set Object. More...
	setUserId (int $a_userid)
	getUserId ()
	setSaveCmd (string $a_savecmd)
	getSaveCmd ()
	setInputFieldName (string $a_inputfieldname)
	getInputFieldName ()
	getTaggingInputHTML ()
	saveInput ()
	isForbidden (string $a_tag)
	getAllUserTagsForObjectHTML ()
	getHTML ()
	Get HTML. More...
	saveJS ()
	Save JS. More...

Static Public Member Functions
static	initJavascript (string $a_ajax_url, ?ilGlobalTemplateInterface $a_main_tpl=null)
static	getModalTemplate ()
static	getListTagsJSCall (string $a_hash, ?string $a_update_code=null)

Protected Member Functions
	getTagsFromInput (string $input)

Protected Attributes
ilCtrl	$ctrl
ilObjUser	$user
ilLanguage	$lng
ILIAS DI UIServices	$ui
int	$obj_id = 0
string	$obj_type = ""
int	$sub_obj_id = 0
string	$sub_obj_type
array	$forbidden = []
int	$userid = 0
string	$savecmd = ""
string	$inputfieldname = ""
RequestInterface	$request
string	$mess = ""
string	$requested_mess = ""

Private Attributes
ilGlobalTemplateInterface	$main_tpl

Detailed Description

Class ilTaggingGUI.

User interface class for tagging engine.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilTaggingGUI::__construct

(

)

Constructor.

Definition at line 50 of file class.ilTaggingGUI.php.

References $DIC, $params, ILIAS\Repository\ctrl(), 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->lng = $DIC->language();
        $this->ui = $DIC->ui();
        $this->request = $DIC->http()->request();

        $params = $this->request->getQueryParams();
        $this->requested_mess = ($params["mess"] ?? "");
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilTaggingGUI::executeCommand

(

)

Execute command.

Definition at line 69 of file class.ilTaggingGUI.php.

References $ctrl, and ilCtrl\getNextClass().

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

        $next_class = $ilCtrl->getNextClass();
        // PHP8 Review: 'switch' with single 'case'
        switch ($next_class) {
            default:
                $cmd = $ilCtrl->getCmd();
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

getAllUserTagsForObjectHTML()

ilTaggingGUI::getAllUserTagsForObjectHTML

(

)

Definition at line 225 of file class.ilTaggingGUI.php.

References ilTagging\getRelevanceClass(), ilTagging\getTagsForObject(), and isForbidden().

                                                 : string
    {
        $ttpl = new ilTemplate("tpl.tag_cloud.html", true, true, "components/ILIAS/Tagging");
        $tags = ilTagging::getTagsForObject(
            $this->obj_id,
            $this->obj_type,
            $this->sub_obj_id,
            $this->sub_obj_type
        );

        $max = 1;
        foreach ($tags as $tag) {
            $max = max($max, $tag["cnt"]);
        }
        reset($tags);
        foreach ($tags as $tag) {
            if (!$this->isForbidden($tag["tag"])) {
                $ttpl->setCurrentBlock("unlinked_tag");
                $ttpl->setVariable(
                    "REL_CLASS",
                    ilTagging::getRelevanceClass((int) $tag["cnt"], (int) $max)
                );
                $ttpl->setVariable("TAG_TITLE", $tag["tag"]);
                $ttpl->parseCurrentBlock();
            }
        }

        return $ttpl->get();
    }

Here is the call graph for this function:

getHTML()

ilTaggingGUI::getHTML

(

)

Get HTML.

Definition at line 319 of file class.ilTaggingGUI.php.

References $ctrl, $lng, $mess, $obj_id, $ui, ilObject\_getIcon(), ilTagging\_getListTagsForObjects(), ilObject\_lookupTitle(), exit, ilUtil\getSystemMessageHTML(), ilTagging\getTagsForUserAndObject(), getUserId(), ilLanguage\loadLanguageModule(), null, ilLegacyFormElementsUtil\prepareFormOutput(), and ilLanguage\txt().

Referenced by saveJS().

                             : string
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ui = $this->ui;

        $lng->loadLanguageModule("tagging");
        $tpl = new ilTemplate("tpl.edit_tags.html", true, true, "components/ILIAS/Tagging");
        $tpl->setVariable("TXT_TAGS", $lng->txt("tagging_tags"));

        $mtxt = "";
        $mtype = "";
        $mess = $this->requested_mess != ""
            ? $this->requested_mess
            : $this->mess;
        // PHP8 Review: 'switch' with single 'case'
        switch ($mess) {
            case "mod":
                $mtype = "success";
                $mtxt = $lng->txt("msg_obj_modified");
                break;
        }
        if ($mtxt != "") {
            $tpl->setVariable("MESS", ilUtil::getSystemMessageHTML($mtxt, $mtype));
        } else {
            $tpl->setVariable("MESS", "");
        }

        $title = ilObject::_lookupTitle($this->obj_id);
        $icon = $ui->factory()->symbol()->icon()->custom(
            ilObject::_getIcon($this->obj_id),
            $title,
            "medium"
        );
        $tpl->setVariable("ICON", $ui->renderer()->render($icon));
        $tpl->setVariable("TXT_OBJ_TITLE", ilObject::_lookupTitle($this->obj_id));
        $tags = ilTagging::getTagsForUserAndObject(
            $this->obj_id,
            $this->obj_type,
            $this->sub_obj_id,
            $this->sub_obj_type,
            $this->getUserId()
        );
        $tpl->setVariable(
            "VAL_TAGS",
            ilLegacyFormElementsUtil::prepareFormOutput(implode(", ", $tags))
        );
        $tpl->setVariable("TXT_SAVE", $lng->txt("save"));
        $tpl->setVariable("TXT_COMMA_SEPARATED", $lng->txt("comma_separated"));
        $tpl->setVariable("CMD_SAVE", "saveJS");

        $os = "ilTagging.cmdAjaxForm(event, '" .
            $ilCtrl->getFormActionByClass("iltagginggui", "", "", true) .
            "');";
        $tpl->setVariable("ON_SUBMIT", $os);

        $tags_set = new ilSetting("tags");
        if ($tags_set->get("enable_all_users")) {
            $tpl->setVariable("TAGS_TITLE", $lng->txt("tagging_my_tags"));

            $all_obj_tags = ilTagging::_getListTagsForObjects(array($this->obj_id));
            $all_obj_tags = $all_obj_tags[$this->obj_id] ?? null;
            if (is_array($all_obj_tags) &&
                sizeof($all_obj_tags) != sizeof($tags)) {
                $tpl->setVariable("TITLE_OTHER", $lng->txt("tagging_other_users"));
                $tpl->setCurrentBlock("tag_other_bl");
                foreach ($all_obj_tags as $tag => $is_owner) {
                    if (!$is_owner) {
                        $tpl->setVariable("OTHER_TAG", $tag);
                        $tpl->parseCurrentBlock();
                    }
                }
            }
        }

        echo $tpl->get();
        exit;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInputFieldName()

ilTaggingGUI::getInputFieldName

(

)

Definition at line 142 of file class.ilTaggingGUI.php.

References $inputfieldname.

Referenced by getTaggingInputHTML(), and saveInput().

                                       : string
    {
        return $this->inputfieldname;
    }

Here is the caller graph for this function:

getListTagsJSCall()

static ilTaggingGUI::getListTagsJSCall ( string  $a_hash, ?string  $a_update_code = null  )

static

Definition at line 304 of file class.ilTaggingGUI.php.

References null.

Referenced by ilObjectListGUI\determineProperties(), ilObjectListGUI\getHeaderAction(), and ilObjectListGUI\insertCommonSocialCommands().

     : string {
        if ($a_update_code === null) {
            $a_update_code = "null";
        } else {
            $a_update_code = "'" . $a_update_code . "'";
        }
        return "ilTagging.listTags(event, '" . $a_hash . "', " . $a_update_code . ");";
    }

Here is the caller graph for this function:

getModalTemplate()

static ilTaggingGUI::getModalTemplate ( )

static

Definition at line 290 of file class.ilTaggingGUI.php.

References $DIC.

                                             : array
    {
        global $DIC;

        $ui = $DIC->ui();
        $modal = $ui->factory()->modal()->roundtrip('#tag_title#', $ui->factory()->legacy()->content(''));
        $modalt["show"] = $modal->getShowSignal()->getId();
        $modalt["close"] = $modal->getCloseSignal()->getId();
        $modalt["template"] = $ui->renderer()->renderAsync($modal);

        return $modalt;
    }

getSaveCmd()

ilTaggingGUI::getSaveCmd

(

)

Definition at line 132 of file class.ilTaggingGUI.php.

References $savecmd.

                                : string
    {
        return $this->savecmd;
    }

getTaggingInputHTML()

ilTaggingGUI::getTaggingInputHTML

(

)

Definition at line 147 of file class.ilTaggingGUI.php.

References $lng, getInputFieldName(), ilTagging\getTagsForUserAndObject(), getUserId(), ilLegacyFormElementsUtil\prepareFormOutput(), and ilLanguage\txt().

                                         : string
    {
        $lng = $this->lng;

        $ttpl = new ilTemplate("tpl.tags_input.html", true, true, "components/ILIAS/Tagging");
        $tags = ilTagging::getTagsForUserAndObject(
            $this->obj_id,
            $this->obj_type,
            $this->sub_obj_id,
            $this->sub_obj_type,
            $this->getUserId()
        );
        $ttpl->setVariable(
            "VAL_TAGS",
            ilLegacyFormElementsUtil::prepareFormOutput(implode(", ", $tags))
        );
        $ttpl->setVariable("TAG_LABEL", $lng->txt("tagging_my_tags"));
        $ttpl->setVariable("TXT_SAVE", $lng->txt("save"));
        $ttpl->setVariable("TXT_COMMA_SEPARATED", $lng->txt("comma_separated"));
        $ttpl->setVariable("CMD_SAVE", $this->savecmd);
        $ttpl->setVariable("NAME_TAGS", $this->getInputFieldName());

        return $ttpl->get();
    }

Here is the call graph for this function:

getTagsFromInput()

ilTaggingGUI::getTagsFromInput ( string  $input )

protected

Definition at line 172 of file class.ilTaggingGUI.php.

References ilUtil\stripSlashes().

Referenced by saveInput(), and saveJS().

                                                      : array
    {
        $input = ilUtil::stripSlashes($input);
        $input = str_replace("\r", "\n", $input);
        $input = str_replace("\n\n", "\n", $input);
        $input = str_replace("\n", ",", $input);
        $itags = explode(",", $input);
        return $itags;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUserId()

ilTaggingGUI::getUserId

(

)

Definition at line 122 of file class.ilTaggingGUI.php.

References $userid.

Referenced by getHTML(), getTaggingInputHTML(), saveInput(), and saveJS().

                               : int
    {
        return $this->userid;
    }

Here is the caller graph for this function:

initJavascript()

static ilTaggingGUI::initJavascript ( string  $a_ajax_url, ?ilGlobalTemplateInterface  $a_main_tpl = null  )

static

Definition at line 260 of file class.ilTaggingGUI.php.

References $DIC, ilYuiUtil\initConnection(), iljQueryUtil\initjQuery(), ilLanguage\loadLanguageModule(), null, and ilLanguage\toJS().

Referenced by ilObjectListGUI\prepareJsLinks().

     : void {
        global $DIC;

        if ($a_main_tpl != null) {
            $tpl = $a_main_tpl;
        } else {
            $tpl = $DIC["tpl"];
        }

        $lng = $DIC->language();

        $lng->loadLanguageModule("tagging");
        $lng->toJS("tagging_tags", $tpl);

        ilYuiUtil::initConnection($tpl);
        iljQueryUtil::initjQuery($tpl);
        $tpl->addJavaScript("assets/js/ilTagging.js");
        //$tpl->addJavaScript("../components/ILIAS/Tagging/resources/ilTagging.js");

        $modal_template = self::getModalTemplate();

        $tpl->addOnLoadCode("ilTagging.setAjaxUrl('" . $a_ajax_url . "');");
        $tpl->addOnLoadCode('ilTagging.setModalTemplate("' . addslashes(json_encode($modal_template["template"])) . '");');
        $tpl->addOnLoadCode("ilTagging.setShowSignal('" . $modal_template["show"] . "');");
        $tpl->addOnLoadCode("ilTagging.setCloseSignal('" . $modal_template["close"] . "');");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isForbidden()

ilTaggingGUI::isForbidden

(

string

$a_tag

)

Definition at line 211 of file class.ilTaggingGUI.php.

References Vendor\Package\$f.

Referenced by getAllUserTagsForObjectHTML(), saveInput(), and saveJS().

                                              : bool
    {
        foreach ($this->forbidden as $f) {
            if (is_int(strpos(strtolower(
                str_replace(array("+", "§", '"', "'", "*", "%", "&", "/", "\\", "(", ")", "=", ":", ";", ":", "-", "_", "\$",
                    "£" . "!" . "¨", "^", "`", "@", "<", ">"), "", $a_tag)
            ), $f))) {
                return true;
            }
        }
        return false;
    }

Here is the caller graph for this function:

saveInput()

ilTaggingGUI::saveInput

(

)

Definition at line 182 of file class.ilTaggingGUI.php.

References $lng, $request, getInputFieldName(), getTagsFromInput(), getUserId(), isForbidden(), ilLanguage\txt(), and ilTagging\writeTagsForUserAndObject().

                               : void
    {
        $lng = $this->lng;
        $request = $this->request;
        $body = $request->getParsedBody();

        $itags = $this->getTagsFromInput($body[$this->getInputFieldName()]);
        $tags = array();
        foreach ($itags as $itag) {
            $itag = trim($itag);
            if (!in_array($itag, $tags) && $itag != "") {
                if (!$this->isForbidden($itag)) {
                    $tags[] = $itag;
                }
            }
        }

        ilTagging::writeTagsForUserAndObject(
            $this->obj_id,
            $this->obj_type,
            $this->sub_obj_id,
            $this->sub_obj_type,
            $this->getUserId(),
            $tags
        );
        $this->main_tpl->setOnScreenMessage('success', $lng->txt('msg_obj_modified'));
    }

Here is the call graph for this function:

saveJS()

ilTaggingGUI::saveJS

(

)

Save JS.

Definition at line 401 of file class.ilTaggingGUI.php.

References $request, getHTML(), getTagsFromInput(), getUserId(), isForbidden(), and ilTagging\writeTagsForUserAndObject().

                            : void
    {
        $request = $this->request;
        $body = $request->getParsedBody();
        $itags = $this->getTagsFromInput($body["tags"]);
        $tags = array();
        foreach ($itags as $itag) {
            $itag = trim($itag);
            if (!in_array($itag, $tags) && $itag != "") {
                if (!$this->isForbidden($itag)) {
                    $tags[] = $itag;
                }
            }
        }

        ilTagging::writeTagsForUserAndObject(
            $this->obj_id,
            $this->obj_type,
            $this->sub_obj_id,
            $this->sub_obj_type,
            $this->getUserId(),
            $tags
        );

        $this->mess = "mod";

        $this->getHTML();
    }

Here is the call graph for this function:

setInputFieldName()

ilTaggingGUI::setInputFieldName

(

string

$a_inputfieldname

)

Definition at line 137 of file class.ilTaggingGUI.php.

Referenced by setObject().

                                                               : void
    {
        $this->inputfieldname = $a_inputfieldname;
    }

Here is the caller graph for this function:

setObject()

ilTaggingGUI::setObject	(	int	$a_obj_id,
		string	$a_obj_type,
		int	$a_sub_obj_id = 0,
		string	$a_sub_obj_type = ""
	)

Set Object.

Parameters

int	$a_obj_id	Object ID
string	$a_obj_type	Object Type
int	$a_sub_obj_id	Sub-object ID
string	$a_sub_obj_type	Sub-object Type

Definition at line 91 of file class.ilTaggingGUI.php.

References $user, setInputFieldName(), setSaveCmd(), and setUserId().

     : void {
        $ilUser = $this->user;

        $this->obj_id = $a_obj_id;
        $this->obj_type = $a_obj_type;
        $this->sub_obj_id = $a_sub_obj_id;
        $this->sub_obj_type = $a_sub_obj_type;

        $this->setSaveCmd("saveTags");
        $this->setUserId($ilUser->getId());
        $this->setInputFieldName("il_tags");

        $tags_set = new ilSetting("tags");
        $forbidden = $tags_set->get("forbidden_tags");
        if ($forbidden != "") {
            $this->forbidden = unserialize((string) $forbidden, ['allowed_classes' => false]);
        } else {
            $this->forbidden = array();
        }
    }

Here is the call graph for this function:

setSaveCmd()

ilTaggingGUI::setSaveCmd

(

string

$a_savecmd

)

Definition at line 127 of file class.ilTaggingGUI.php.

Referenced by setObject().

                                                 : void
    {
        $this->savecmd = $a_savecmd;
    }

Here is the caller graph for this function:

setUserId()

ilTaggingGUI::setUserId

(

int

$a_userid

)

Definition at line 117 of file class.ilTaggingGUI.php.

Referenced by setObject().

                                            : void
    {
        $this->userid = $a_userid;
    }

Here is the caller graph for this function:

Field Documentation

$ctrl

ilCtrl ilTaggingGUI::$ctrl

protected

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

Referenced by executeCommand(), and getHTML().

$forbidden

array ilTaggingGUI::$forbidden = []

protected

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

$inputfieldname

string ilTaggingGUI::$inputfieldname = ""

protected

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

Referenced by getInputFieldName().

$lng

ilLanguage ilTaggingGUI::$lng

protected

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

Referenced by getHTML(), getTaggingInputHTML(), and saveInput().

$main_tpl

ilGlobalTemplateInterface ilTaggingGUI::$main_tpl

private

Definition at line 45 of file class.ilTaggingGUI.php.

$mess

string ilTaggingGUI::$mess = ""

protected

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

Referenced by getHTML().

$obj_id

int ilTaggingGUI::$obj_id = 0

protected

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

Referenced by getHTML().

$obj_type

string ilTaggingGUI::$obj_type = ""

protected

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

$request

RequestInterface ilTaggingGUI::$request

protected

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

Referenced by saveInput(), and saveJS().

$requested_mess

string ilTaggingGUI::$requested_mess = ""

protected

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

$savecmd

string ilTaggingGUI::$savecmd = ""

protected

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

Referenced by getSaveCmd().

$sub_obj_id

int ilTaggingGUI::$sub_obj_id = 0

protected

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

$sub_obj_type

string ilTaggingGUI::$sub_obj_type

protected

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

$ui

ILIAS DI UIServices ilTaggingGUI::$ui

protected

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

Referenced by getHTML().

$user

ilObjUser ilTaggingGUI::$user

protected

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

Referenced by setObject().

$userid

int ilTaggingGUI::$userid = 0

protected

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

Referenced by getUserId().

---

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

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