ilBookmarkBlockGUI Class Reference

BlockGUI class for Bookmarks block. More...

Inheritance diagram for ilBookmarkBlockGUI:

Collaboration diagram for ilBookmarkBlockGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	executeCommand ()
	execute command More...
	getHTML ()
	fillDataSection ()
	Fill data section. More...
	getPDBookmarkListHTMLTree ()
	get tree bookmark list for personal desktop More...
	fillFooter ()
	block footer More...
	setFooterLinks ()
	Set footer links. More...
	getListRowData ()
	Get list data (for flat list). More...
	fillRow ($a_set)
	get flat bookmark list for personal desktop More...
	getOverview ()
	Get overview. More...
	setPdFlatMode ()
	set current desktop view mode to flat More...
	setPdTreeMode ()
	set current desktop view mode to tree More...
	setCurrentBookmarkFolder ()
	set current bookmarkfolder on personal desktop 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 = "pdbookm"

Additional Inherited Members
Protected Member Functions inherited from ilBlockGUI
	fillRowColor ($a_placeholder="CSS_ROW")
	preloadData (array $data)
	Can be overwritten in subclasses. More...
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

Detailed Description

BlockGUI class for Bookmarks block.

Author

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

Version

$Id$

ilBookmarkBlockGUI: ilColumnGUI

Definition at line 16 of file class.ilBookmarkBlockGUI.php.

Constructor & Destructor Documentation

__construct()

ilBookmarkBlockGUI::__construct

(

)

Constructor.

Definition at line 23 of file class.ilBookmarkBlockGUI.php.

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

    {
        global $DIC;

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

        parent::__construct();
        
        $this->setImage(ilUtil::getImagePath("icon_bm.svg"));
        $this->setTitle($lng->txt("my_bms"));
        $this->setEnableNumInfo(false);
        $this->setLimit(99999);
        $this->setAvailableDetailLevels(3);
        
        $this->id = (empty($_GET["bmf_id"]))
            ? $bmf_id = 1
            : $_GET["bmf_id"];
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilBookmarkBlockGUI::executeCommand

(

)

execute command

Definition at line 81 of file class.ilBookmarkBlockGUI.php.

References ilBlockGUI\$ctrl, and $ilCtrl.

    {
        $ilCtrl = $this->ctrl;

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

        return $this->$cmd();
    }

fillDataSection()

ilBookmarkBlockGUI::fillDataSection

(

)

Fill data section.

Definition at line 105 of file class.ilBookmarkBlockGUI.php.

References $ilUser, ilBlockGUI\$user, ilBookmarkFolder\_getNumberOfObjects(), ilBlockGUI\getCurrentDetailLevel(), getListRowData(), getOverview(), getPDBookmarkListHTMLTree(), ilBlockGUI\setColSpan(), ilBlockGUI\setDataSection(), ilBlockGUI\setEnableDetailRow(), and ilBlockGUI\setRowTemplate().

    {
        $ilUser = $this->user;
        
        include_once("./Services/Bookmarks/classes/class.ilBookmarkFolder.php");
        $bm_items = ilBookmarkFolder::_getNumberOfObjects();
        $this->num_bookmarks = $bm_items["bookmarks"];
        $this->num_folders = $bm_items["folders"];

        if ($this->getCurrentDetailLevel() > 1 &&
            ($this->num_bookmarks > 0 || $this->num_folders > 0)) {
            if ($ilUser->getPref("il_pd_bkm_mode") == 'tree') {
                $this->setDataSection($this->getPDBookmarkListHTMLTree());
            } else {
                $this->setRowTemplate("tpl.bookmark_pd_list.html", "Services/Bookmarks");
                $this->getListRowData();
                $this->setColSpan(2);
                parent::fillDataSection();
            }
        } 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()

ilBookmarkBlockGUI::fillFooter

(

)

block footer

Definition at line 150 of file class.ilBookmarkBlockGUI.php.

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

    {
        $this->setFooterLinks();
        $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:

fillRow()

ilBookmarkBlockGUI::fillRow

(

$a_set

)

get flat bookmark list for personal desktop

Definition at line 277 of file class.ilBookmarkBlockGUI.php.

References $ilUser, ilBlockGUI\$user, ilBlockGUI\getCurrentDetailLevel(), and ilUtil\prepareFormOutput().

    {
        $ilUser = $this->user;
        
        $this->tpl->setVariable("IMG_BM", $a_set["img"]);
        $this->tpl->setVariable("IMG_ALT", $a_set["alt"]);
        $this->tpl->setVariable("BM_TITLE", $a_set["title"]);
        $this->tpl->setVariable("BM_LINK", $a_set["link"]);
        $this->tpl->setVariable("BM_TARGET", ilUtil::prepareFormOutput($a_set["target"]));
        if (isset($a_set['rel'])) {
            $this->tpl->setVariable("BM_REL", $a_set['rel']);
        }

        if ($this->getCurrentDetailLevel() > 2) {
            $this->tpl->setVariable("BM_DESCRIPTION", ilUtil::prepareFormOutput($a_set["desc"]));
        } else {
            $this->tpl->setVariable("BM_TOOLTIP", ilUtil::prepareFormOutput($a_set["desc"]));
        }
    }

Here is the call graph for this function:

getBlockType()

static ilBookmarkBlockGUI::getBlockType ( )

static

Get block type.

Returns

string Block type.

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

Referenced by setFooterLinks().

    {
        return self::$block_type;
    }

Here is the caller graph for this function:

getHTML()

ilBookmarkBlockGUI::getHTML

(

)

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

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

Referenced by setPdFlatMode(), and setPdTreeMode().

    {
        // 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:

Here is the caller graph for this function:

getListRowData()

ilBookmarkBlockGUI::getListRowData

(

)

Get list data (for flat list).

Definition at line 208 of file class.ilBookmarkBlockGUI.php.

References $_SESSION, ilBlockGUI\$ctrl, ilBlockGUI\$data, $ilCtrl, $ilUser, ilBlockGUI\$lng, ilBlockGUI\$user, ilBookmarkFolder\_getParentId(), ilBookmarkFolder\_lookupTitle(), array, ilUtil\getImagePath(), ilBookmarkFolder\getObjects(), ilBlockGUI\getTitle(), ilBookmarkFolder\isRootFolder(), ilUtil\prepareFormOutput(), ilBlockGUI\setData(), and ilBlockGUI\setTitle().

Referenced by fillDataSection().

    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        include_once("./Services/Bookmarks/classes/class.ilBookmarkFolder.php");

        $data = array();
        
        $sess_cur_bm_folder = "";
        if (isset($_SESSION["ilCurBMFolder"])) {
            $sess_cur_bm_folder = $_SESSION["ilCurBMFolder"];
        }
        
        $bm_items = ilBookmarkFolder::getObjects($sess_cur_bm_folder);

        if (!ilBookmarkFolder::isRootFolder($sess_cur_bm_folder)
            && !empty($_SESSION["ilCurBMFolder"])) {
            $ilCtrl->setParameter(
                $this,
                "curBMFolder",
                ilBookmarkFolder::_getParentId($sess_cur_bm_folder)
            );

            $data[] = array(
                "img" => ilUtil::getImagePath("icon_bmf.svg"),
                "alt" => $lng->txt("bmf"),
                "title" => "..",
                "link" => $ilCtrl->getLinkTarget($this, "setCurrentBookmarkFolder"));

            $this->setTitle($this->getTitle() . ": " . ilBookmarkFolder::_lookupTitle($sess_cur_bm_folder));
        }

        foreach ($bm_items as $bm_item) {
            switch ($bm_item["type"]) {
                case "bmf":
                    $ilCtrl->setParameter($this, "curBMFolder", $bm_item["obj_id"]);
                    $data[] = array(
                        "img" => ilUtil::getImagePath("icon_bmf.svg"),
                        "alt" => $lng->txt("bmf"),
                        "title" => ilUtil::prepareFormOutput($bm_item["title"]),
                        "desc" => ilUtil::prepareFormOutput($bm_item["desc"]),
                        "link" => $ilCtrl->getLinkTarget(
                            $this,
                            "setCurrentBookmarkFolder"
                        ),
                        "target" => "");
                    break;

                case "bm":
                    $data[] = array(
                        "img" => ilUtil::getImagePath("spacer.png"),
                        "alt" => $lng->txt("bm"),
                        "title" => ilUtil::prepareFormOutput($bm_item["title"]),
                        "desc" => ilUtil::prepareFormOutput($bm_item["desc"]),
                        "link" => ilUtil::prepareFormOutput($bm_item["target"]),
                        "rel" => "noopener",
                        "target" => "_blank");
                    break;
            }
        }
        
        $this->setData($data);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOverview()

ilBookmarkBlockGUI::getOverview

(

)

Get overview.

Definition at line 300 of file class.ilBookmarkBlockGUI.php.

References ilBlockGUI\$ctrl, $ilCtrl, $ilUser, ilBlockGUI\$lng, and ilBlockGUI\$user.

Referenced by fillDataSection().

    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
                
        return '<div class="small">' . $this->num_bookmarks . " " . $lng->txt("bm_num_bookmarks") . ", " .
            $this->num_folders . " " . $lng->txt("bm_num_bookmark_folders") . "</div>";
    }

Here is the caller graph for this function:

getPDBookmarkListHTMLTree()

ilBookmarkBlockGUI::getPDBookmarkListHTMLTree

(

)

get tree bookmark list for personal desktop

Definition at line 135 of file class.ilBookmarkBlockGUI.php.

References ilBlockGUI\$ctrl, $ilCtrl, $ilUser, and ilBlockGUI\$user.

Referenced by fillDataSection().

    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
        
        include_once("./Services/Bookmarks/classes/class.ilBookmarkBlockExplorerGUI.php");
        $exp = new ilBookmarkBlockExplorerGUI($this, "getPDBookmarkListHTMLTree");
        if (!$exp->handleCommand()) {
            return "<div id='tree_div'>" . $exp->getHTML() . "</div>";
        }
    }

Here is the caller graph for this function:

getScreenMode()

static ilBookmarkBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

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

References $_GET, and IL_SCREEN_SIDE.

    {
        switch ($_GET["cmd"]) {
            default:
                return IL_SCREEN_SIDE;
                break;
        }
    }

isRepositoryObject()

static ilBookmarkBlockGUI::isRepositoryObject ( )

static

Is block used in repository object?

Returns

string Block type.

Definition at line 60 of file class.ilBookmarkBlockGUI.php.

    {
        return false;
    }

setCurrentBookmarkFolder()

ilBookmarkBlockGUI::setCurrentBookmarkFolder

(

)

set current bookmarkfolder on personal desktop

Definition at line 347 of file class.ilBookmarkBlockGUI.php.

References $_GET, $_SESSION, ilBlockGUI\$ctrl, and $ilCtrl.

    {
        $ilCtrl = $this->ctrl;
        
        $_SESSION["ilCurBMFolder"] = $_GET["curBMFolder"];
        $ilCtrl->redirectByClass("ilpersonaldesktopgui", "show");
    }

setFooterLinks()

ilBookmarkBlockGUI::setFooterLinks

(

)

Set footer links.

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

References ilBlockGUI\$block_id, ilBlockGUI\$ctrl, $ilCtrl, $ilUser, ilBlockGUI\$lng, ilBlockGUI\$user, ilBlockGUI\addFooterLink(), and getBlockType().

Referenced by fillFooter().

    {
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        if ($this->num_bookmarks == 0 && $this->num_folders == 0) {
            return;
        }
        
        // flat
        $this->addFooterLink(
            $lng->txt("list"),
            $ilCtrl->getLinkTarget($this, "setPdFlatMode"),
            $ilCtrl->getLinkTarget(
                $this,
                "setPdFlatMode",
                "",
                true
            ),
            "block_" . $this->getBlockType() . "_" . $this->block_id,
            false,
            false,
            ($ilUser->getPref("il_pd_bkm_mode") != 'tree')
        );

        // as tree
        $this->addFooterLink(
            $lng->txt("tree"),
            $ilCtrl->getLinkTarget(
                $this,
                "setPdTreeMode"
            ),
            "",
            "block_" . $this->getBlockType() . "_" . $this->block_id,
            false,
            false,
            ($ilUser->getPref("il_pd_bkm_mode") == 'tree')
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setPdFlatMode()

ilBookmarkBlockGUI::setPdFlatMode

(

)

set current desktop view mode to flat

Definition at line 313 of file class.ilBookmarkBlockGUI.php.

References ilBlockGUI\$ctrl, $ilCtrl, $ilUser, ilBlockGUI\$user, exit, and getHTML().

    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;

        $ilUser->writePref("il_pd_bkm_mode", 'flat');
        if ($ilCtrl->isAsynch()) {
            echo $this->getHTML();
            exit;
        } else {
            $ilCtrl->redirectByClass("ilpersonaldesktopgui", "show");
        }
    }

Here is the call graph for this function:

setPdTreeMode()

ilBookmarkBlockGUI::setPdTreeMode

(

)

set current desktop view mode to tree

Definition at line 330 of file class.ilBookmarkBlockGUI.php.

References ilBlockGUI\$ctrl, $ilCtrl, $ilUser, ilBlockGUI\$user, exit, and getHTML().

    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
        
        $ilUser->writePref("il_pd_bkm_mode", 'tree');
        if ($ilCtrl->isAsynch()) {
            echo $this->getHTML();
            exit;
        } else {
            $ilCtrl->redirectByClass("ilpersonaldesktopgui", "show");
        }
    }

Here is the call graph for this function:

Field Documentation

$block_type

ilBookmarkBlockGUI::$block_type = "pdbookm"

static

Definition at line 18 of file class.ilBookmarkBlockGUI.php.

---

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

• Services/Bookmarks/classes/class.ilBookmarkBlockGUI.php