ilPDTaggingBlockGUI Class Reference

ilPDTaggingBlockGUI displays personal tag cloud on personal desktop. More...

Inheritance diagram for ilPDTaggingBlockGUI:

Collaboration diagram for ilPDTaggingBlockGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	executeCommand ()
	execute command More...
	getHTML ()
	fillDataSection ()
	Fill data section. More...
	getTagCloud ()
	get tree bookmark list for personal desktop More...
	showResourcesForTag ()
	List resources for tag. More...
	removeTagsWithoutAccess ()
	Remove tasg without access. More...
	fillFooter ()
	block footer More...
	getOverview ()
	Get overview. More...
Public Member Functions inherited from ilBlockGUI
	__construct ()
	Constructor. More...
	addHeaderLink ($a_href, $a_text, $status=true)
	getHeaderLinks ()
	setData ($a_data)
	Set Data. More...
	getData ()
	Get Data. More...
	setBigMode ($a_bigmode)
	Set Big Mode. More...
	getBigMode ()
	Get Big Mode. More...
	setBlockId ($a_block_id=0)
	Set Block Id. More...
	getBlockId ()
	Get Block Id. More...
	setAvailableDetailLevels ($a_max, $a_min=0)
	Set Available Detail Levels. More...
	setCurrentDetailLevel ($a_currentdetaillevel)
	Set Current Detail Level. More...
	setGuiObject (&$a_gui_object)
	Set GuiObject. More...
	getGuiObject ()
	Get GuiObject. More...
	getCurrentDetailLevel ()
	Get Current Detail Level. More...
	setTitle ($a_title)
	Set Title. More...
	getTitle ()
	Get Title. More...
	setImage ($a_image)
	Set Image. More...
	getImage ()
	Get Image. More...
	setOffset ($a_offset)
	Set Offset. More...
	getOffset ()
	Get Offset. More...
	correctOffset ()
	setLimit ($a_limit)
	Set Limit. More...
	getLimit ()
	Get Limit. More...
	setEnableEdit ($a_enableedit)
	Set EnableEdit. More...
	getEnableEdit ()
	Get EnableEdit. More...
	setRepositoryMode ($a_repositorymode)
	Set RepositoryMode. More...
	getRepositoryMode ()
	Get RepositoryMode. More...
	setFooterInfo ($a_footerinfo, $a_hide_and_icon=false)
	Set Footer Info. More...
	getFooterInfo ($a_hide_and_icon=false)
	Get Footer Info. More...
	setSubtitle ($a_subtitle)
	Set Subtitle. More...
	getSubtitle ()
	Get Subtitle. More...
	setRefId ($a_refid)
	Set Ref Id (only used if isRepositoryObject() is true). More...
	getRefId ()
	Get Ref Id (only used if isRepositoryObject() is true). More...
	setAdminCommands ($a_admincommands)
	Set Administration Commmands. More...
	getAdminCommands ()
	Get Administration Commmands. More...
	setColSpan ($a_colspan)
	Set Columns Span. More...
	getColSpan ()
	Get Columns Span. More...
	setEnableDetailRow ($a_enabledetailrow)
	Set EnableDetailRow. More...
	getEnableDetailRow ()
	Get EnableDetailRow. More...
	setEnableNumInfo ($a_enablenuminfo)
	Set Enable Item Number Info. More...
	getEnableNumInfo ()
	Get Enable Item Number Info. More...
	setProperties ($a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...
	getProperty ($a_property)
	setProperty ($a_property, $a_value)
	setRowTemplate ($a_rowtemplatename, $a_rowtemplatedir="")
	Set Row Template Name. More...
	getNavParameter ()
	getDetailParameter ()
	getConfigParameter ()
	getMoveParameter ()
	getRowTemplateName ()
	Get Row Template Name. More...
	getRowTemplateDir ()
	Get Row Template Directory. More...
	addBlockCommand ( $a_href, $a_text, $a_target="", $a_img="", $a_right_aligned=false, $a_checked=false, $a_html="")
	Add Block Command. More...
	getBlockCommands ()
	Get Block commands. More...
	addHeaderCommand ($a_href, $a_text, $a_as_close=false)
	Add Header Block Command. More...
	getHeaderCommands ()
	Get Header Block commands. More...
	addFooterLink ( $a_text, $a_href="", $a_onclick="", $a_block_id="", $a_top=false, $a_omit_separator=false, $a_checked=false)
	Add a footer text/link. More...
	getFooterLinks ()
	Get footer links. More...
	clearFooterLinks ()
	Clear footer links. More...
	handleDetailLevel ()
	Handle read/write current detail level. More...
	getHTML ()
	Handle config status. More...
	fillHeaderCommands ()
	Fill header commands block. More...
	fillHeaderTitleBlock ()
	Fill header title block (title and. More...
	setDataSection ($a_content)
	Call this from overwritten fillDataSection(), if standard row based data is not used. More...
	fillDataSection ()
	Standard implementation for row based data. More...
	fillRow ($a_set)
	fillFooter ()
	fillPreviousNext ()
	Fill previous/next row. More...
	setPreviousNextLinks ()
	Get previous/next linkbar. More...
	fillFooterLinks ($a_top=false, $a_numinfo="")
	Fill footer links. More...
	fillDetailRow ()
	Fill Detail Setting Row. More...

Static Public Member Functions
static	getBlockType ()
	Get block type. More...
static	isRepositoryObject ()
	Is block used in repository object? More...
static	getScreenMode ()
	Get Screen Mode for current command. More...
Static Public Member Functions inherited from ilBlockGUI
static	getBlockType ()
static	isRepositoryObject ()
static	getScreenMode ()
	Get Screen Mode for current command. More...

Static Public Attributes
static	$block_type = "pdtag"

Protected Attributes
	$obj_definition
Protected Attributes inherited from ilBlockGUI
	$data = array()
	$colspan = 1
	$enablenuminfo = true
	$detail_min = 0
	$detail_max = 0
	$bigmode = false
	$footer_links = array()
	$block_id = 0
	$header_commands = array()
	$allow_moving = true
	$move = array("left" => false, "right" => false, "up" => false, "down" => false)
	$enabledetailrow = true
	$header_links = array()
	$footerinfo = false
	$footerinfo_icon = false
	$block_commands = array()
	$max_count = false
	$close_command = false
	$image = false
	$property = false
	$nav_value = ""
	$css_row = ""
	$dropdown
	$tpl
	$main_tpl
	$user
	$ctrl
	$access
	$lng
	$obj_def

Additional Inherited Members
Protected Member Functions inherited from ilBlockGUI
	fillRowColor ($a_placeholder="CSS_ROW")
	preloadData (array $data)
	Can be overwritten in subclasses. More...

Detailed Description

ilPDTaggingBlockGUI displays personal tag cloud on personal desktop.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

ilPDTaggingBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

__construct()

ilPDTaggingBlockGUI::__construct

(

)

Constructor.

Definition at line 46 of file class.ilPDTaggingBlockGUI.php.

References $DIC, ilBlockGUI\$lng, ilBlockGUI\setAvailableDetailLevels(), ilBlockGUI\setEnableNumInfo(), ilBlockGUI\setLimit(), ilBlockGUI\setTitle(), and user().

    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->obj_definition = $DIC["objDefinition"];
        $this->access = $DIC->access();
        $lng = $DIC->language();

        parent::__construct();
        
        $lng->loadLanguageModule("tagging");

        $this->setTitle($lng->txt("tagging_my_tags"));
        $this->setEnableNumInfo(false);
        $this->setLimit(99999);
        $this->setAvailableDetailLevels(1, 0);
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilPDTaggingBlockGUI::executeCommand

(

)

execute command

Definition at line 107 of file class.ilPDTaggingBlockGUI.php.

References ilBlockGUI\$ctrl, and $ilCtrl.

    {
        $ilCtrl = $this->ctrl;

        $next_class = $ilCtrl->getNextClass();
        $cmd = $ilCtrl->getCmd("getHTML");

        return $this->$cmd();
    }

fillDataSection()

ilPDTaggingBlockGUI::fillDataSection

(

)

Fill data section.

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

References $ilUser, ilBlockGUI\$user, ilBlockGUI\getCurrentDetailLevel(), getOverview(), getTagCloud(), ilTagging\getTagsForUser(), ilBlockGUI\setDataSection(), and ilBlockGUI\setEnableDetailRow().

    {
        $ilUser = $this->user;
        
        include_once("./Services/Tagging/classes/class.ilTagging.php");
        $this->tags = ilTagging::getTagsForUser($ilUser->getId(), 1000000);

        if ($this->getCurrentDetailLevel() > 1 && (count($this->tags) > 0)) {
            $this->setDataSection($this->getTagCloud());
        } else {
            if ($this->num_bookmarks == 0 && $this->num_folders == 0) {
                $this->setEnableDetailRow(false);
            }
            $this->setDataSection($this->getOverview());
        }
    }

Here is the call graph for this function:

fillFooter()

ilPDTaggingBlockGUI::fillFooter

(

)

block footer

Definition at line 332 of file class.ilPDTaggingBlockGUI.php.

References ilBlockGUI\fillFooterLinks(), and ilBlockGUI\getColSpan().

    {
        $this->fillFooterLinks();
        $this->tpl->setVariable("FCOLSPAN", $this->getColSpan());
        if ($this->tpl->blockExists("block_footer")) {
            $this->tpl->setCurrentBlock("block_footer");
            $this->tpl->parseCurrentBlock();
        }
    }

Here is the call graph for this function:

getBlockType()

static ilPDTaggingBlockGUI::getBlockType ( )

static

Get block type.

Returns

string Block type.

Definition at line 72 of file class.ilPDTaggingBlockGUI.php.

    {
        return self::$block_type;
    }

getHTML()

ilPDTaggingBlockGUI::getHTML

(

)

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

References array, ilBlockGUI\getCurrentDetailLevel(), and ilBlockGUI\setData().

    {
        // workaround to show details row
        $this->setData(array("dummy"));

        if ($this->getCurrentDetailLevel() == 0) {
            return "";
        } else {
            return parent::getHTML();
        }
    }

Here is the call graph for this function:

getOverview()

ilPDTaggingBlockGUI::getOverview

(

)

Get overview.

Definition at line 346 of file class.ilPDTaggingBlockGUI.php.

References ilBlockGUI\$lng.

Referenced by fillDataSection().

    {
        $lng = $this->lng;

        return '<div class="small">' . $lng->txt("tagging_tag_info") . "</div>";
    }

Here is the caller graph for this function:

getScreenMode()

static ilPDTaggingBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

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

References $_GET, IL_SCREEN_CENTER, and IL_SCREEN_SIDE.

    {
        switch ($_GET["cmd"]) {
            case "showResourcesForTag":
                return IL_SCREEN_CENTER;
                break;

            default:
                return IL_SCREEN_SIDE;
                break;
        }
    }

getTagCloud()

ilPDTaggingBlockGUI::getTagCloud

(

)

get tree bookmark list for personal desktop

Definition at line 152 of file class.ilPDTaggingBlockGUI.php.

References ilBlockGUI\$ctrl, $ilCtrl, $tag, ilBlockGUI\$tpl, ilBlockGUI\getCurrentDetailLevel(), and ilTagging\getRelevanceClass().

Referenced by fillDataSection().

    {
        $ilCtrl = $this->ctrl;

        $showdetails = ($this->getCurrentDetailLevel() > 2);
        $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);

        foreach ($this->tags as $tag) {
            $tpl->setCurrentBlock("linked_tag");
            $ilCtrl->setParameter($this, "tag", rawurlencode($tag["tag"]));
            $tpl->setVariable(
                "HREF_TAG",
                $ilCtrl->getLinkTarget($this, "showResourcesForTag")
            );
            $tpl->setVariable("TAG_TITLE", $tag["tag"]);
            $tpl->setVariable(
                "REL_CLASS",
                ilTagging::getRelevanceClass($tag["cnt"], $max)
            );
            $tpl->parseCurrentBlock();
        }
        return $tpl->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isRepositoryObject()

static ilPDTaggingBlockGUI::isRepositoryObject ( )

static

Is block used in repository object?

Returns

string Block type.

Definition at line 82 of file class.ilPDTaggingBlockGUI.php.

    {
        return false;
    }

removeTagsWithoutAccess()

ilPDTaggingBlockGUI::removeTagsWithoutAccess

(

)

Remove tasg without access.

Definition at line 287 of file class.ilPDTaggingBlockGUI.php.

References $_GET, ilBlockGUI\$access, ilBlockGUI\$ctrl, $ilCtrl, $ilUser, $key, ilBlockGUI\$lng, $type, ilBlockGUI\$user, ilObject\_getAllReferences(), ilTagging\deleteTagOfObjectForUser(), ilTagging\getObjectsForTagAndUser(), and ilUtil\sendSuccess().

    {
        $ilCtrl = $this->ctrl;
        $ilAccess = $this->access;
        $ilUser = $this->user;
        $lng = $this->lng;

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

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

        $ilCtrl->returnToParent($this);
    }

Here is the call graph for this function:

showResourcesForTag()

ilPDTaggingBlockGUI::showResourcesForTag

(

)

List resources for tag.

Definition at line 189 of file class.ilPDTaggingBlockGUI.php.

References $_GET, ilBlockGUI\$ctrl, $html, $ilCtrl, $ilUser, $key, ilBlockGUI\$lng, $location, $obj_definition, ilBlockGUI\$tpl, $type, ilBlockGUI\$user, ilObject\_getAllReferences(), ilObject\_lookupDescription(), ilObject\_lookupTitle(), ilUtil\getImagePath(), and ilTagging\getObjectsForTagAndUser().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
        $objDefinition = $this->obj_definition;
        
        $_GET["tag"] = str_replace("-->", "", $_GET["tag"]);
        
        $tpl = new ilTemplate("tpl.resources_for_tag.html", true, true, "Services/Tagging");
        include_once("./Services/PersonalDesktop/classes/class.ilPDContentBlockGUI.php");
        $content_block = new ilPDContentBlockGUI();
        $content_block->setColSpan(2);
        $content_block->setTitle(sprintf(
            $lng->txt("tagging_resources_for_tag"),
            "<i>" . $_GET["tag"] . "</i>"
        ));
        $content_block->setImage(ilUtil::getImagePath("icon_tag.svg"));
        $content_block->addHeaderCommand(
            $ilCtrl->getParentReturn($this),
            $lng->txt("selected_items_back")
        );
            
        // get resources
        include_once("./Services/Tagging/classes/class.ilTagging.php");
        $objs = ilTagging::getObjectsForTagAndUser($ilUser->getId(), $_GET["tag"]);

        $unaccessible = false;
        foreach ($objs as $key => $obj) {
            $ref_ids = ilObject::_getAllReferences($obj["obj_id"]);
            foreach ($ref_ids as $ref_id) {
                $type = $obj["obj_type"];
                
                if ($type == "") {
                    $unaccessible = true;
                    continue;
                }
                
                // get list gui class for each object type
                if (empty($this->item_list_gui[$type])) {
                    $class = $objDefinition->getClassName($type);
                    $location = $objDefinition->getLocation($type);
            
                    $full_class = "ilObj" . $class . "ListGUI";
            
                    include_once($location . "/class." . $full_class . ".php");
                    $this->item_list_gui[$type] = new $full_class();
                    $this->item_list_gui[$type]->enableDelete(false);
                    $this->item_list_gui[$type]->enablePath(true);
                    $this->item_list_gui[$type]->enableCut(false);
                    $this->item_list_gui[$type]->enableCopy(false);
                    $this->item_list_gui[$type]->enableSubscribe(false);
                    $this->item_list_gui[$type]->enableLink(false);
                    $this->item_list_gui[$type]->enableIcon(true);
                }
                $html = $this->item_list_gui[$type]->getListItemHTML(
                    $ref_id,
                    $obj["obj_id"],
                    ilObject::_lookupTitle($obj["obj_id"]),
                    ilObject::_lookupDescription($obj["obj_id"])
                );
                    
                if ($html != "") {
                    $css = ($css != "tblrow1") ? "tblrow1" : "tblrow2";
                        
                    $tpl->setCurrentBlock("res_row");
                    $tpl->setVariable("ROWCLASS", $css);
                    $tpl->setVariable("RESOURCE_HTML", $html);
                    $tpl->setVariable("ALT_TYPE", $lng->txt("obj_" . $type));
                    $tpl->setVariable(
                        "IMG_TYPE",
                        ilUtil::getImagePath("icon_" . $type . ".svg")
                    );
                    $tpl->parseCurrentBlock();
                } else {
                    $unaccessible = true;
                }
            }
        }

        if ($unaccessible) {
            $tpl->setCurrentBlock("no_access");
            $tpl->setVariable("SOME_OBJ_WITHOUT_ACCESS", $lng->txt("tag_some_obj_tagged_without_access"));
            $ilCtrl->saveParameter($this, "tag");
            $tpl->setVariable("HREF_REMOVE_TAGS", $ilCtrl->getLinkTarget($this, "removeTagsWithoutAccess"));
            $tpl->setVariable("REMOVE_TAGS", $lng->txt("tag_remove_tags_of_obj_without_access"));
            $tpl->parseCurrentBlock();
        }

        $content_block->setContent($tpl->get());
        //$content_block->setContent("test");

        return $content_block->getHTML();
    }

Here is the call graph for this function:

Field Documentation

$block_type

ilPDTaggingBlockGUI::$block_type = "pdtag"

static

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

$obj_definition

ilPDTaggingBlockGUI::$obj_definition

protected

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

Referenced by showResourcesForTag().

---

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

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