ilTaggingGUI Class Reference

Class ilTaggingGUI. More...

Collaboration diagram for ilTaggingGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	executeCommand ()
	Execute command. More...
	setObject ($a_obj_id, $a_obj_type, $a_sub_obj_id=0, $a_sub_obj_type="")
	Set Object. More...
	setUserId ($a_userid)
	Set User ID. More...
	getUserId ()
	Get User ID. More...
	setSaveCmd ($a_savecmd)
	Set Save Command. More...
	getSaveCmd ()
	Get Save Command. More...
	setInputFieldName ($a_inputfieldname)
	Set Input Field Name. More...
	getInputFieldName ()
	Get Input Field Name. More...
	getTaggingInputHTML ()
	Get Input HTML for Tagging of an object (and a user) More...
	saveInput ()
	Save Input. More...
	isForbidden ($a_tag)
	Check whether a tag is forbiddens. More...
	getAllUserTagsForObjectHTML ()
	Get Input HTML for Tagging of an object (and a user) More...
	getHTML ()
	Get HTML. More...
	saveJS ()
	Save JS. More...

Static Public Member Functions
static	initJavascript ($a_ajax_url, ilGlobalTemplateInterface $a_main_tpl=null)
	Init javascript. More...
static	getListTagsJSCall ($a_hash, $a_update_code=null)
	Get tagging js call. More...

Protected Attributes
	$ctrl
	$user
	$lng
	$ui

Detailed Description

Class ilTaggingGUI.

User interface class for tagging engine.

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.ilTaggingGUI.php.

Constructor & Destructor Documentation

__construct()

ilTaggingGUI::__construct

(

)

Constructor.

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

References $DIC, ui(), and user().

    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->user = $DIC->user();
        $this->lng = $DIC->language();
        $this->ui = $DIC->ui();
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilTaggingGUI::executeCommand

(

)

Execute command.

Parameters

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

References $ctrl, and $ilCtrl.

    {
        $ilCtrl = $this->ctrl;
        
        $next_class = $ilCtrl->getNextClass();
        switch ($next_class) {
            default:
                $cmd = $ilCtrl->getCmd();
                $this->$cmd();
                break;
        }
    }

getAllUserTagsForObjectHTML()

ilTaggingGUI::getAllUserTagsForObjectHTML

(

)

Get Input HTML for Tagging of an object (and a user)

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

References $ctrl, $ilCtrl, $lng, ilTagging\getRelevanceClass(), ilTagging\getTagsForObject(), and isForbidden().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        $ttpl = new ilTemplate("tpl.tag_cloud.html", true, true, "Services/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($tag["cnt"], $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.

Parameters

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

References $_GET, $ctrl, $ilCtrl, $lng, $tpl, $ui, ilTagging\_getListTagsForObjects(), ilObject\_lookupTitle(), exit, ilUtil\getSystemMessageHTML(), ilTagging\getTagsForUserAndObject(), getUserId(), and ilUtil\prepareFormOutput().

Referenced by saveJS().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ui = $this->ui;
        
        $lng->loadLanguageModule("tagging");
        $tpl = new ilTemplate("tpl.edit_tags.html", true, true, "Services/Tagging");
        $tpl->setVariable("TXT_TAGS", $lng->txt("tagging_tags"));
    
        switch ($_GET["mess"] != "" ? $_GET["mess"] : $this->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",
            ilUtil::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];
            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

(

)

Get Input Field Name.

Returns

string Input Field Name

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

Referenced by getTaggingInputHTML(), and saveInput().

    {
        return $this->inputfieldname;
    }

Here is the caller graph for this function:

getListTagsJSCall()

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

static

Get tagging js call.

Parameters

string	$a_hash
string	$a_update_code

Returns

string

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

References $DIC, and $tpl.

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

    {
        global $DIC;

        $tpl = $DIC["tpl"];
        
        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:

getSaveCmd()

ilTaggingGUI::getSaveCmd

(

)

Get Save Command.

Returns

string Save Command

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

    {
        return $this->savecmd;
    }

getTaggingInputHTML()

ilTaggingGUI::getTaggingInputHTML

(

)

Get Input HTML for Tagging of an object (and a user)

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

References $ctrl, $ilCtrl, $lng, getInputFieldName(), ilTagging\getTagsForUserAndObject(), getUserId(), and ilUtil\prepareFormOutput().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        $ttpl = new ilTemplate("tpl.tags_input.html", true, true, "Services/Tagging");
        $tags = ilTagging::getTagsForUserAndObject(
            $this->obj_id,
            $this->obj_type,
            $this->sub_obj_id,
            $this->sub_obj_type,
            $this->getUserId()
        );
        $ttpl->setVariable(
            "VAL_TAGS",
            ilUtil::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:

getUserId()

ilTaggingGUI::getUserId

(

)

Get User ID.

Returns

int User ID

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

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

    {
        return $this->userid;
    }

Here is the caller graph for this function:

initJavascript()

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

static

Init javascript.

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

References $DIC, $lng, $tpl, iljQueryUtil\initjQuery(), and ilYuiUtil\initPanel().

Referenced by ilObjectListGUI\prepareJsLinks().

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

        include_once("./Services/YUI/classes/class.ilYuiUtil.php");
        ilYuiUtil::initPanel(false, $tpl);
        include_once("./Services/jQuery/classes/class.iljQueryUtil.php");
        iljQueryUtil::initjQuery($tpl);
        $tpl->addJavascript("./Services/Tagging/js/ilTagging.js");
        
        $tpl->addOnLoadCode("ilTagging.setAjaxUrl('" . $a_ajax_url . "');");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isForbidden()

ilTaggingGUI::isForbidden

(

$a_tag

)

Check whether a tag is forbiddens.

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

References Vendor\Package\$f.

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

    {
        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

(

)

Save Input.

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

References $_POST, $lng, getInputFieldName(), getUserId(), isForbidden(), ilUtil\stripSlashes(), and ilTagging\writeTagsForUserAndObject().

    {
        $lng = $this->lng;
        
        $input = ilUtil::stripSlashes($_POST[$this->getInputFieldName()]);
        $input = str_replace("\r", "\n", $input);
        $input = str_replace("\n\n", "\n", $input);
        $input = str_replace("\n", ",", $input);
        $itags = explode(",", $input);
        $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
        );
        ilUtil::sendSuccess($lng->txt('msg_obj_modified'));
    }

Here is the call graph for this function:

saveJS()

ilTaggingGUI::saveJS

(

)

Save JS.

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

References $_POST, getHTML(), getUserId(), isForbidden(), ilUtil\stripSlashes(), and ilTagging\writeTagsForUserAndObject().

    {
        $input = ilUtil::stripSlashes($_POST["tags"]);
        $input = str_replace("\r", "\n", $input);
        $input = str_replace("\n\n", "\n", $input);
        $input = str_replace("\n", ",", $input);
        $itags = explode(",", $input);
        $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

(

$a_inputfieldname

)

Set Input Field Name.

Parameters

string

$a_inputfieldname

Input Field Name

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

Referenced by setObject().

    {
        $this->inputfieldname = $a_inputfieldname;
    }

Here is the caller graph for this function:

setObject()

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

Set 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 79 of file class.ilTaggingGUI.php.

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

    {
        $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($forbidden);
        } else {
            $this->forbidden = array();
        }
    }

Here is the call graph for this function:

setSaveCmd()

ilTaggingGUI::setSaveCmd

(

$a_savecmd

)

Set Save Command.

Parameters

string

$a_savecmd

Save Command

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

Referenced by setObject().

    {
        $this->savecmd = $a_savecmd;
    }

Here is the caller graph for this function:

setUserId()

ilTaggingGUI::setUserId

(

$a_userid

)

Set User ID.

Parameters

int

$a_userid

User ID

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

Referenced by setObject().

    {
        $this->userid = $a_userid;
    }

Here is the caller graph for this function:

Field Documentation

$ctrl

ilTaggingGUI::$ctrl

protected

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

Referenced by executeCommand(), getAllUserTagsForObjectHTML(), getHTML(), and getTaggingInputHTML().

$lng

ilTaggingGUI::$lng

protected

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

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

$ui

ilTaggingGUI::$ui

protected

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

Referenced by getHTML().

$user

ilTaggingGUI::$user

protected

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

Referenced by setObject().

---

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

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