ilBookmarkAdministrationGUI Class Reference

GUI class for personal bookmark administration. More...

Collaboration diagram for ilBookmarkAdministrationGUI:

Public Member Functions
	ilBookmarkAdministrationGUI ()
	Constructor public.
&	executeCommand ()
	execute command
	executeAction ()
	getMode ()
	return display mode flat or tree
	explorer ()
	output explorer tree with bookmark folders
	displayHeader ()
	display header and locator
	view ()
	add_cell ($val, $link="")
	output a cell in object list
	displayLocator ()
	display locator
	newForm ()
	new form
	newFormBookmarkFolder ()
	display new bookmark folder form
	editFormBookmarkFolder ()
	display edit bookmark folder form
	newFormBookmark ()
	display new bookmark form
	get_last ($a_var, $a_value)
	get stored post var in case of an error/warning otherwise return passed value
	editFormBookmark ()
	display edit bookmark form
	createBookmarkFolder ()
	create new bookmark folder in db
	updateBookmarkFolder ()
	update bookmark folder
	createBookmark ()
	create new bookmark in db
	updateBookmark ()
	update bookmark in db
	export ($deliver=true)
	export bookmarks
	sendmail ()
	send bookmarks as attachment
	delete ()
	display deletion conformation screen
	cancel ()
	cancel deletion,insert, update
	confirm ()
	deletion confirmed -> delete folders / bookmarks
	showPossibleSubObjects ()
	display subobject addition selection
&	getHTML ()
	Get Bookmark list for personal desktop.
	importFile ()
	imports a bookmark file into database display status information or report errors messages in case of error
	__importBookmarks (&$objects, &$num_create, $folder_id, $start_key=0)
	creates the bookmarks and folders

Data Fields
	$user_id
	$ilias
	$tpl
	$lng
	$tree
	$id
	$data
	$textwidth = 100

Detailed Description

GUI class for personal bookmark administration.

It manages folders and bookmarks with the help of the two corresponding core classes ilBookmarkFolder and ilBookmark. Their methods are called in this User Interface class.

Author

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

Manfred Thaler manfr.nosp@m.ed.t.nosp@m.haler.nosp@m.@end.nosp@m.o7.co.nosp@m.m

Version

Id:

class.ilBookmarkAdministrationGUI.php 23012 2010-02-21 04:36:32Z akill

ilBookmarkAdministrationGUI:

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

Member Function Documentation

ilBookmarkAdministrationGUI::__importBookmarks	(	&	$objects,
		&	$num_create,
			$folder_id,
			$start_key = 0
	)

creates the bookmarks and folders

Parameters

array	array of objects
array	stores the number of created objects
folder_id	id where to store the bookmarks
start_key	key of the objects array where to start private

Definition at line 1068 of file class.ilBookmarkAdministrationGUI.php.

Referenced by importFile().

        {
                if (is_array($objects[$start_key]))
                {
                        foreach ($objects[$start_key] as $obj_key=>$object)
                        {
                                switch ($object['type'])
                                {
                                        case 'bm':
                                                if (!$object["title"]) continue;
                                                if (!$object["target"]) continue;
                                                $bm = new ilBookmark();
                                                $bm->setTitle($object["title"]);
                                                $bm->setDescription($object["description"]);
                                                $bm->setTarget($object["target"]);
                                                $bm->setParent($folder_id);
                                                $bm->create();
                                                $num_create['bm']++;
                                        break;
                                        case 'bmf':
                                                if (!$object["title"]) continue;
                                                $bmf = new ilBookmarkFolder();
                                                $bmf->setTitle($object["title"]);
                                                $bmf->setParent($folder_id);
                                                $bmf->create();
                                                $num_create['bmf']++;
                                                if (is_array($objects[$obj_key]))
                                                {
                                                        $this->__importBookmarks($objects,$num_create,
                                                                $bmf->getId(),$obj_key);
                                                }
                                        break;
                                }
                        }
                }
        }

Here is the caller graph for this function:

ilBookmarkAdministrationGUI::add_cell	(		$val,
			$link = ""
	)

output a cell in object list

Definition at line 399 of file class.ilBookmarkAdministrationGUI.php.

        {
                if (!empty($link))
                {
                        $this->tpl->setCurrentBlock("begin_link");
                        $this->tpl->setVariable("LINK_TARGET", $link);
                        $this->tpl->parseCurrentBlock();
                        $this->tpl->touchBlock("end_link");
                }

                $this->tpl->setCurrentBlock("text");
                $this->tpl->setVariable("TEXT_CONTENT", $val);
                $this->tpl->parseCurrentBlock();
                $this->tpl->setCurrentBlock("table_cell");
                $this->tpl->parseCurrentBlock();
        }

ilBookmarkAdministrationGUI::cancel

(

)

cancel deletion,insert, update

Definition at line 902 of file class.ilBookmarkAdministrationGUI.php.

References view().

        {
                session_unregister("saved_post");
                $this->view();
        }

Here is the call graph for this function:

ilBookmarkAdministrationGUI::confirm

(

)

deletion confirmed -> delete folders / bookmarks

Definition at line 911 of file class.ilBookmarkAdministrationGUI.php.

References $_SESSION, $id, $tree, ilUtil\sendInfo(), and view().

        {
                global $tree, $rbacsystem, $rbacadmin;

                // AT LEAST ONE OBJECT HAS TO BE CHOSEN.
                if (!isset($_SESSION["saved_post"]))
                {
                        $this->ilias->raiseError($this->lng->txt("no_checkbox"),$this->ilias->error_obj->MESSAGE);
                }

                // FOR ALL SELECTED OBJECTS
                foreach ($_SESSION["saved_post"] as $id)
                {
                        list($type, $id) = explode(":", $id);

                        // get node data and subtree nodes
                        if ($this->tree->isInTree($id))
                        {
                                $node_data = $this->tree->getNodeData($id);
                                $subtree_nodes = $this->tree->getSubTree($node_data);
                        }
                        else
                        {
                                continue;
                        }

                        // delete tree
                        $this->tree->deleteTree($node_data);

                        // delete objects of subtree nodes
                        foreach ($subtree_nodes as $node)
                        {
                                switch ($node["type"])
                                {
                                        case "bmf":
                                                $BookmarkFolder = new ilBookmarkFolder($node["obj_id"]);
                                                $BookmarkFolder->delete();
                                                break;

                                        case "bm":
                                                $Bookmark = new ilBookmark($node["obj_id"]);
                                                $Bookmark->delete();
                                                break;
                                }
                        }
                }

                // Feedback
                ilUtil::sendInfo($this->lng->txt("info_deleted"),true);

                $this->view();
        }

Here is the call graph for this function:

ilBookmarkAdministrationGUI::createBookmark

(

)

create new bookmark in db

Definition at line 688 of file class.ilBookmarkAdministrationGUI.php.

References newFormBookmark(), ilUtil\sendInfo(), ilUtil\stripSlashes(), and view().

        {
                if (!$this->tree->isInTree($this->id))
                {
                        return;
                }

                // check title and target
                if (empty($_POST["title"]))
                {
                        ilUtil::sendInfo($this->lng->txt("please_enter_title"));
                        $this->newFormBookmark();
                }
                else if (empty($_POST["target"]))
                {
                        ilUtil::sendInfo($this->lng->txt("please_enter_target"));
                        $this->newFormBookmark();
                }
                else
                {
                        // create bookmark
                        $bm = new ilBookmark();
                        $bm->setTitle(ilUtil::stripSlashes($_POST["title"]));
                        $bm->setDescription(ilUtil::stripSlashes($_POST["description"]));
                        $bm->setTarget(ilUtil::stripSlashes($_POST["target"]));
                        $bm->setParent($this->id);
                        $bm->create();

                        $this->view();
                }
        }

Here is the call graph for this function:

ilBookmarkAdministrationGUI::createBookmarkFolder

(

)

create new bookmark folder in db

Definition at line 631 of file class.ilBookmarkAdministrationGUI.php.

References newFormBookmarkFolder(), ilUtil\sendInfo(), ilUtil\stripSlashes(), and view().

        {
                if (!$this->tree->isInTree($this->id))
                {
                        return;
                }

                // check title
                if (empty($_POST["title"]))
                {
                        ilUtil::sendInfo($this->lng->txt("please_enter_title"));
                        $this->newFormBookmarkFolder();
                }
                else
                {
                        // create bookmark folder
                        $bmf = new ilBookmarkFolder();
                        $bmf->setTitle(ilUtil::stripSlashes($_POST["title"]));
                        $bmf->setParent($this->id);
                        $bmf->create();

                        $this->view();
                }
        }

Here is the call graph for this function:

ilBookmarkAdministrationGUI::delete

(

)

display deletion conformation screen

Definition at line 812 of file class.ilBookmarkAdministrationGUI.php.

References $_SESSION, $id, $title, ilUtil\getImagePath(), ilUtil\getImageTagByType(), ilUtil\prepareFormOutput(), ilUtil\sendInfo(), ilUtil\shortenText(), and ilUtil\switchColor().

        {
                if (!isset($_POST["id"]))
                {
                        $this->ilias->raiseError($this->lng->txt("no_checkbox"),$this->ilias->error_obj->MESSAGE);
                }

                $this->tpl->addBlockFile("ADM_CONTENT", "objects", "tpl.obj_confirm.html");

                ilUtil::sendInfo($this->lng->txt("info_delete_sure"));
                $this->ctrl->setParameter($this, "bmf_id", $this->id);
                $this->tpl->setVariable("FORMACTION",
                        $this->ctrl->getFormAction($this));

                // output table header
                $cols = array("type", "title");
                foreach ($cols as $key)
                {
                        $this->tpl->setCurrentBlock("table_header");
                        $this->tpl->setVariable("TEXT",$this->lng->txt($key));
                        $this->tpl->parseCurrentBlock();
                }

                $_SESSION["saved_post"] = $_POST["id"];

                foreach($_POST["id"] as $id)
                {

                        list($type, $obj_id) = explode(":", $id);
                        if (!$this->tree->isInTree($obj_id))
                        {
                                continue;
                        }
                        switch($type)
                        {
                                case "bmf":
                                        $BookmarkFolder = new ilBookmarkFolder($obj_id);
                                        $title = $BookmarkFolder->getTitle();
                                        $target = "";
                                        unset($BookmarkFolder);
                                        break;

                                case "bm":
                                        $Bookmark = new ilBookmark($obj_id);
                                        $title = $Bookmark->getTitle();
                                        $target = $Bookmark->getTarget();
                                        unset($Bookmark);
                                        break;
                        }

                        // output type icon
                        $this->tpl->setCurrentBlock("table_cell");
                        $this->tpl->setVariable("TEXT_CONTENT",ilUtil::getImageTagByType($type, $this->tpl->tplPath));
                        $this->tpl->parseCurrentBlock();

                        // output title
                        $this->tpl->setCurrentBlock("table_cell");
                        $this->tpl->setVariable("TEXT_CONTENT",ilUtil::prepareFormOutput($title));

                        // output target
                        if ($target)
                        {
                                $this->tpl->setVariable("DESC",ilUtil::prepareFormOutput(ilUtil::shortenText(
                                        $target,$this->textwidth, true)));
                        }
                        $this->tpl->parseCurrentBlock();

                        // output table row
                        $this->tpl->setCurrentBlock("table_row");
                        $this->tpl->setVariable("CSS_ROW",ilUtil::switchColor(++$counter,"tblrow1","tblrow2"));
                        $this->tpl->parseCurrentBlock();
                }

                // cancel and confirm button
                $buttons = array( "cancel"  => $this->lng->txt("cancel"),
                        "confirm"  => $this->lng->txt("confirm"));

                $this->tpl->setVariable("IMG_ARROW", ilUtil::getImagePath("arrow_downright.gif"));
                foreach($buttons as $name => $value)
                {
                        $this->tpl->setCurrentBlock("operation_btn");
                        $this->tpl->setVariable("BTN_NAME",$name);
                        $this->tpl->setVariable("BTN_VALUE",$value);
                        $this->tpl->parseCurrentBlock();
                }
        }

Here is the call graph for this function:

ilBookmarkAdministrationGUI::displayHeader

(

)

display header and locator

Definition at line 191 of file class.ilBookmarkAdministrationGUI.php.

References displayLocator(), ilUtil\getImagePath(), ilUtil\infoPanel(), and ilUtil\sendInfo().

Referenced by executeCommand().

        {
                // output locator
                $this->displayLocator();

                // output message
                if($this->message)
                {
                        ilUtil::sendInfo($this->message);
                }
                ilUtil::infoPanel();

                $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_pd_b.gif"),
                        $this->lng->txt("personal_desktop"));
                $this->tpl->setTitle($this->lng->txt("personal_desktop"));
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBookmarkAdministrationGUI::displayLocator

(

)

display locator

Definition at line 419 of file class.ilBookmarkAdministrationGUI.php.

References $lng, and $title.

Referenced by displayHeader().

        {
                global $lng;

                if (empty($this->id))
                {
                        return;
                }
                
                if (!$this->tree->isInTree($this->id))
                {
                        return;
                }

                $this->tpl->addBlockFile("LOCATOR", "locator", "tpl.locator.html");

                $path = $this->tree->getPathFull($this->id);
//print_r($path);
                $modifier = 1;

return;
                $this->tpl->setVariable("TXT_LOCATOR",$this->lng->txt("locator"));
                $this->tpl->touchBlock("locator_separator");
                $this->tpl->touchBlock("locator_item");
                //$this->tpl->setCurrentBlock("locator_item");
                //$this->tpl->setVariable("ITEM", $this->lng->txt("personal_desktop"));
                //$this->tpl->setVariable("LINK_ITEM", $this->ctrl->getLinkTargetByClass("ilpersonaldesktopgui"));
                //$this->tpl->setVariable("LINK_TARGET","target=\"".
                //      ilFrameTargetInfo::_getFrame("MainContent")."\"");
                //$this->tpl->parseCurrentBlock();

                foreach ($path as $key => $row)
                {
                        if ($key < count($path)-$modifier)
                        {
                                $this->tpl->touchBlock("locator_separator");
                        }

                        $this->tpl->setCurrentBlock("locator_item");
                        $title = ($row["child"] == 1) ?
                                $lng->txt("bookmarks") :
                                $row["title"];
                        $this->tpl->setVariable("ITEM", $title);
                        $this->ctrl->setParameter($this, "bmf_id", $row["child"]);
                        $this->tpl->setVariable("LINK_ITEM",
                                $this->ctrl->getLinkTarget($this));
                        $this->tpl->parseCurrentBlock();
                }

                $this->tpl->setCurrentBlock("locator");

                $this->tpl->parseCurrentBlock();
        }

Here is the caller graph for this function:

ilBookmarkAdministrationGUI::editFormBookmark

(

)

display edit bookmark form

Definition at line 597 of file class.ilBookmarkAdministrationGUI.php.

References $_GET, $lng, and get_last().

Referenced by updateBookmark().

        {
                global $lng;

                if (!$this->tree->isInTree($_GET["obj_id"]))
                {
                        return;
                }
                $this->tpl->addBlockFile("ADM_CONTENT", "objects", "tpl.bookmark_new.html");

                $this->tpl->setVariable("TXT_BOOKMARK_NEW", $lng->txt("bookmark_edit"));
                $this->tpl->setVariable("TXT_TARGET", $lng->txt("bookmark_target"));
                $this->tpl->setVariable("TXT_TITLE", $lng->txt("title"));
                $this->tpl->setVariable("TXT_DESCRIPTION", $lng->txt("description"));

                $Bookmark = new ilBookmark($_GET["obj_id"]);
                $this->tpl->setVariable("TITLE", $this->get_last("title", $Bookmark->getTitle()));
                $this->tpl->setVariable("TARGET", $this->get_last("target", $Bookmark->getTarget()));
                $this->tpl->setVariable("DESCRIPTION", $this->get_last("description", $Bookmark->getDescription()));

                $this->tpl->setVariable("TXT_SAVE", $lng->txt("save"));
                $this->tpl->setVariable("VAL_CMD", "updateBookmark");
                $this->tpl->setVariable("TXT_CANCEL", $lng->txt("cancel"));
                $this->ctrl->setParameter($this, "obj_id", $_GET["obj_id"]);
                $this->ctrl->setParameter($this, "bmf_id", $this->id);
                $this->tpl->setVariable("FORMACTION", $this->ctrl->getFormAction($this));

                $this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBookmarkAdministrationGUI::editFormBookmarkFolder

(

)

display edit bookmark folder form

Definition at line 518 of file class.ilBookmarkAdministrationGUI.php.

References $_GET, $lng, and get_last().

Referenced by updateBookmarkFolder().

        {
                global $lng;
                
                if (!$this->tree->isInTree($_GET["obj_id"]))
                {
                        return;
                }

                $this->tpl->addBlockFile("ADM_CONTENT", "objects", "tpl.bookmark_newfolder.html");

                $bmf = new ilBookmarkFolder($_GET["obj_id"]);

                $this->tpl->setVariable("TXT_TITLE", $lng->txt("title"));
                $this->tpl->setVariable("TITLE", $this->get_last("title", $bmf->getTitle()));
                $this->tpl->setVariable("TXT_SAVE", $lng->txt("save"));
                $this->tpl->setVariable("TXT_CANCEL", $lng->txt("cancel"));
                $this->tpl->setVariable("TXT_FOLDER_NEW", $lng->txt("bookmark_folder_edit"));
                $this->tpl->setVariable("VAL_CMD", "updateBookmarkFolder");
                $this->ctrl->setParameter($this, "obj_id", $_GET["obj_id"]);
                $this->ctrl->setParameter($this, "bmf_id", $this->id);
                $this->tpl->setVariable("FORMACTION", $this->ctrl->getFormAction($this));

        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBookmarkAdministrationGUI::executeAction

(

)

Definition at line 120 of file class.ilBookmarkAdministrationGUI.php.

References export(), sendmail(), and view().

        {
                switch($_POST["action"])
                {
                        case "delete":
                                $this->delete();
                                break;
                        case "export":
                                $this->export();
                                break;
                        case "sendmail":
                                $this->sendmail();
                                break;
                        default:
                                $this->view();
                                break;
                }
                return true;
        }

Here is the call graph for this function:

& ilBookmarkAdministrationGUI::executeCommand

(

)

execute command

Definition at line 101 of file class.ilBookmarkAdministrationGUI.php.

References $cmd, displayHeader(), explorer(), and getMode().

        {
                $next_class = $this->ctrl->getNextClass();

                switch($next_class)
                {
                        default:
                                $cmd = $this->ctrl->getCmd("view");
                                $this->displayHeader();
                                $this->$cmd();
                                if ($this->getMode() == 'tree')
                                {
                                        $this->explorer();
                                }
                                break;
                }
                $this->tpl->show(true);
                return true;
        }

Here is the call graph for this function:

ilBookmarkAdministrationGUI::explorer

(

)

output explorer tree with bookmark folders

Definition at line 151 of file class.ilBookmarkAdministrationGUI.php.

References $_GET, $_SESSION, and ilBookmarkExplorer\setAllowedTypes().

Referenced by executeCommand().

        {
                $this->tpl->setCurrentBlock("left_column");
                $this->tpl->addBlockFile("LEFT_CONTENT", "adm_tree_content", "tpl.bookmark_explorer.html");
                $exp = new ilBookmarkExplorer($this->ctrl->getLinkTarget($this),$_SESSION["AccountId"]);
                $exp->setAllowedTypes(array('dum','bmf'));
                $exp->setTargetGet("bmf_id");
                $exp->setSessionExpandVariable('mexpand');
                $this->ctrl->setParameter($this, "bmf_id", $this->id);
                $exp->setExpandTarget($this->ctrl->getLinkTarget($this));
                if ($_GET["mexpand"] == "")
                {
                        $mtree = new ilTree($_SESSION["AccountId"]);
                        $mtree->setTableNames('bookmark_tree','bookmark_data');
                        $expanded = $mtree->readRootId();
                }
                else
                {
                        $expanded = $_GET["mexpand"];
                }

                $exp->setExpand($expanded);

                // build html-output
                $exp->setOutput(0);
                $output = $exp->getOutput();

                $this->tpl->setCurrentBlock("adm_tree_content");
                $this->tpl->setVariable("TXT_EXPLORER_HEADER", $this->lng->txt("bookmarks"));
                $this->ctrl->setParameter($this, "bmf_id", 1);
                $this->tpl->setVariable("LINK_EXPLORER_HEADER",$this->ctrl->getLinkTarget($this));

                $this->tpl->setVariable("EXPLORER",$output);
                $this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBookmarkAdministrationGUI::export

(

$deliver = true

)

export bookmarks

Definition at line 757 of file class.ilBookmarkAdministrationGUI.php.

References $id, ilBookmarkImportExport\_exportBookmark(), and ilUtil\deliverData().

Referenced by executeAction(), and sendmail().

        {
                if (!isset($_POST["id"]))
                {
                        $this->ilias->raiseError($this->lng->txt("no_checkbox"),$this->ilias->error_obj->MESSAGE);
                }
                $export_ids=array();
                foreach($_POST["id"] as $id)
                {
                        if ($this->tree->isInTree($id))
                        {
                                list($type, $obj_id) = explode(":", $id);
                                $export_ids[]=$obj_id;
                        }
                }
                require_once ("./Services/PersonalDesktop/classes/class.ilBookmarkImportExport.php");
                $html_content=ilBookmarkImportExport::_exportBookmark ($export_ids,true,
                        $this->lng->txt("bookmarks_of")." ".$this->ilias->account->getFullname());
                if ($deliver)
                {
                        ilUtil::deliverData($html_content, 'bookmarks.html', "application/save", $charset = "");
                }
                else
                {
                        return $html_content;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBookmarkAdministrationGUI::get_last	(		$a_var,
			$a_value
	)

get stored post var in case of an error/warning otherwise return passed value

Definition at line 587 of file class.ilBookmarkAdministrationGUI.php.

References ilUtil\prepareFormOutput().

Referenced by editFormBookmark(), editFormBookmarkFolder(), newFormBookmark(), and newFormBookmarkFolder().

        {
                        return  (!empty($_POST[$a_var])) ?
                                ilUtil::prepareFormOutput(($_POST[$a_var]),true) :
                                ilUtil::prepareFormOutput($a_value);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

& ilBookmarkAdministrationGUI::getHTML

(

)

Get Bookmark list for personal desktop.

Definition at line 1014 of file class.ilBookmarkAdministrationGUI.php.

        {
                include_once("./Services/PersonalDesktop/classes/class.ilBookmarkBlockGUI.php");
                $bookmark_block_gui = new ilBookmarkBlockGUI("ilpersonaldesktopgui", "show");
                
                return $bookmark_block_gui->getHTML();
        }

ilBookmarkAdministrationGUI::getMode

(

)

return display mode flat or tree

Definition at line 144 of file class.ilBookmarkAdministrationGUI.php.

Referenced by executeCommand().

                           {
                return $this->mode;
        }

Here is the caller graph for this function:

ilBookmarkAdministrationGUI::ilBookmarkAdministrationGUI

(

)

Constructor public.

Parameters

integer

user_id (optional)

Definition at line 70 of file class.ilBookmarkAdministrationGUI.php.

References $_GET, $_SESSION, $ilCtrl, $ilias, $lng, and $tpl.

        {
                global $ilias, $tpl, $lng, $ilCtrl;
                //print_r($_SESSION["error_post_vars"]);
                // if no bookmark folder id is given, take dummy root node id (that is 1)
                $this->id = (empty($_GET["bmf_id"]))
                        ? $bmf_id = 1
                        : $_GET["bmf_id"];

                // initiate variables
                $this->ilias =& $ilias;
                $this->tpl =& $tpl;
                $this->lng =& $lng;
                $this->ctrl =& $ilCtrl;
                $this->ctrl->setParameter($this, "bmf_id", $this->id);
                $this->user_id = $_SESSION["AccountId"];

                $this->tree = new ilTree($_SESSION["AccountId"]);
                $this->tree->setTableNames('bookmark_tree','bookmark_data');
                $this->root_id = $this->tree->readRootId();
                // set current bookmark view mode
                if (!empty($_GET["set_mode"]))
                {
                        $this->ilias->account->writePref("il_bkm_mode", $_GET["set_mode"]);
                }
                $this->mode = $this->ilias->account->getPref("il_bkm_mode");
        }

ilBookmarkAdministrationGUI::importFile

(

)

imports a bookmark file into database display status information or report errors messages in case of error

public

Definition at line 1029 of file class.ilBookmarkAdministrationGUI.php.

References __importBookmarks(), ilBookmarkImportExport\_parseFile(), newFormBookmark(), ilUtil\sendInfo(), and view().

        {
                if (!$this->tree->isInTree($this->id))
                {
                        return;
                }

                if ($_FILES["bkmfile"]["error"] > UPLOAD_ERR_OK)
                {
                        ilUtil::sendInfo($this->lng->txt("import_file_not_valid"));
                        $this->newFormBookmark();
                        return;
                }
                require_once ("./Services/PersonalDesktop/classes/class.ilBookmarkImportExport.php");
                $objects=ilBookmarkImportExport::_parseFile ($_FILES["bkmfile"]['tmp_name']);
                if ($objects===false)
                {
                        ilUtil::sendInfo($this->lng->txt("import_file_not_valid"));
                        $this->newFormBookmark();
                        return;
                }
                // holds the number of created objects
                $num_create=array('bm'=>0,'bmf'=>0);
                $this->__importBookmarks($objects,$num_create,$this->id,0);

                ilUtil::sendInfo(sprintf($this->lng->txt("bkm_import_ok"),$num_create['bm'],
                        $num_create[ 'bmf']));
                $this->view();


        }

Here is the call graph for this function:

ilBookmarkAdministrationGUI::newForm

(

)

new form

Definition at line 476 of file class.ilBookmarkAdministrationGUI.php.

References newFormBookmark(), and newFormBookmarkFolder().

        {
                switch($_POST["type"])
                {
                        case "bmf":
                                $this->newFormBookmarkFolder();
                                break;

                        case "bm":
                                $this->newFormBookmark();
                                break;
                }
        }

Here is the call graph for this function:

ilBookmarkAdministrationGUI::newFormBookmark

(

)

display new bookmark form

Definition at line 547 of file class.ilBookmarkAdministrationGUI.php.

References $lng, and get_last().

Referenced by createBookmark(), importFile(), and newForm().

        {
                global $lng;
                
                if (!$this->tree->isInTree($this->id))
                {
                        return;
                }


                $this->tpl->addBlockFile("ADM_CONTENT", "objects", "tpl.bookmark_new.html");
                $this->tpl->setVariable("TXT_BOOKMARK_NEW", $lng->txt("bookmark_new"));
                $this->tpl->setVariable("TXT_TARGET", $lng->txt("bookmark_target"));
                $this->tpl->setVariable("TXT_TITLE", $lng->txt("title"));
                $this->tpl->setVariable("TXT_DESCRIPTION", $lng->txt("description"));

                $this->tpl->setVariable("TITLE", $this->get_last("title", ""));
                $this->tpl->setVariable("TARGET", $this->get_last("target", "http://"));
                $this->tpl->setVariable("DESCRIPTION",$this->get_last("description", ""));
                $this->tpl->setVariable("TXT_SAVE", $lng->txt("save"));
                $this->tpl->setVariable("VAL_CMD", "createBookmark");
                $this->tpl->setVariable("TXT_CANCEL", $lng->txt("cancel"));

                $this->ctrl->setParameter($this, "bmf_id", $this->id);
                $this->tpl->setVariable("FORMACTION", $this->ctrl->getFormAction($this));
                $this->tpl->parseCurrentBlock();


                $this->tpl->setCurrentBlock('bkm_import');
                $this->tpl->setVariable("TXT_IMPORT_BKM", $this->lng->txt("bkm_import"));
                $this->tpl->setVariable("TXT_FILE", $this->lng->txt("file_add"));
                $this->tpl->setVariable("TXT_IMPORT", $this->lng->txt("import"));
                $this->tpl->parseCurrentBlock();
                //vd($_POST);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBookmarkAdministrationGUI::newFormBookmarkFolder

(

)

display new bookmark folder form

Definition at line 493 of file class.ilBookmarkAdministrationGUI.php.

References $lng, and get_last().

Referenced by createBookmarkFolder(), and newForm().

        {
                global $lng;

                if (!$this->tree->isInTree($this->id))
                {
                        return;
                }

                $this->tpl->addBlockFile("ADM_CONTENT", "objects", "tpl.bookmark_newfolder.html");
                $this->tpl->setVariable("TITLE", $this->get_last("title", ""));
                $this->tpl->setVariable("TXT_TITLE", $lng->txt("title"));
                $this->tpl->setVariable("TXT_SAVE", $lng->txt("save"));
                $this->tpl->setVariable("TXT_CANCEL", $lng->txt("cancel"));
                $this->tpl->setVariable("TXT_FOLDER_NEW", $lng->txt("bookmark_folder_new"));
                $this->ctrl->setParameter($this, "bmf_id", $this->id);
                $this->tpl->setVariable("FORMACTION", $this->ctrl->getFormAction($this));
                $this->tpl->setVariable("VAL_CMD", "createBookmarkFolder");
                $this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBookmarkAdministrationGUI::sendmail

(

)

send bookmarks as attachment

Definition at line 787 of file class.ilBookmarkAdministrationGUI.php.

References $filename, export(), ilUtil\ilTempnam(), and ilUtil\redirect().

Referenced by executeAction().

        {
                global $ilUser;
                include_once 'classes/class.ilFileDataMail.php';
                require_once "Services/Mail/classes/class.ilFormatMail.php";
                $mfile = new ilFileDataMail($ilUser->getId());
                $umail = new ilFormatMail($ilUser->getId());


                $html_content=$this->export(false);
                $tempfile=ilUtil::ilTempnam();
                $fp=fopen($tempfile,'w');
                fwrite($fp, $html_content);
                fclose($fp);
                $filename='bookmarks.html';
                $mfile->copyAttachmentFile($tempfile,$filename);
                $umail->savePostData($ilUser->getId(),array($filename),
                                                 '','','','','',
                                                 '',
                                                 '', 0);
                ilUtil::redirect('ilias.php?baseClass=ilMailGUI&type=attach');
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBookmarkAdministrationGUI::showPossibleSubObjects

(

)

display subobject addition selection

Definition at line 968 of file class.ilBookmarkAdministrationGUI.php.

References $_SESSION, formSelect(), and ilUtil\formSelect().

Referenced by view().

        {
                $actions = array(
                                "delete"=>$this->lng->txt("delete"),
                                "export"=>$this->lng->txt("export"),
                                "sendmail"=>$this->lng->txt("bkm_sendmail"),
                );

                $subobj = array("bm", "bmf");
                
                if (is_array($subobj))
                {
                        //build form
                        $opts = ilUtil::formSelect("","type",$subobj);

                        $this->tpl->setCurrentBlock("add_object");
                        $this->tpl->setVariable("COLUMN_COUNTS", 7);
                        $this->tpl->setVariable("SELECT_OBJTYPE", $opts);
                        $this->tpl->setVariable("BTN_NAME", "newForm");
                        $this->tpl->setVariable("TXT_ADD", $this->lng->txt("add"));
                        $this->tpl->parseCurrentBlock();
                }

                $this->tpl->setVariable("TPLPATH",$this->tpl->tplPath);

                $this->tpl->setCurrentBlock("tbl_action_select");
                $this->tpl->setVariable("SELECT_ACTION",ilUtil::formSelect($_SESSION["error_post_vars"]['action'],"action",$actions,false,true));
                $this->tpl->setVariable("BTN_NAME","executeAction");
                $this->tpl->setVariable("BTN_VALUE",$this->lng->txt("execute"));

                /*
                $this->tpl->setVariable("BTN_NAME","delete");
                $this->tpl->setVariable("BTN_VALUE",$this->lng->txt("delete"));
                $this->tpl->parseCurrentBlock();

                $this->tpl->setVariable("BTN_NAME","export");
                $this->tpl->setVariable("BTN_VALUE",$this->lng->txt("export"));
                $this->tpl->parseCurrentBlock();
                */
                $this->tpl->parseCurrentBlock();

        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBookmarkAdministrationGUI::updateBookmark

(

)

update bookmark in db

Definition at line 723 of file class.ilBookmarkAdministrationGUI.php.

References $_GET, editFormBookmark(), ilUtil\sendInfo(), ilUtil\stripSlashes(), and view().

        {
                if (!$this->tree->isInTree($_GET["obj_id"]))
                {
                        return;
                }

                // check title and target
                if (empty($_POST["title"]))
                {
                        ilUtil::sendInfo($this->lng->txt("please_enter_title"));
                        $this->editFormBookmark();
                }
                else if (empty($_POST["target"]))
                {
                        ilUtil::sendInfo($this->lng->txt("please_enter_target"));
                        $this->editFormBookmark();
                }
                else
                {
                        // update bookmark
                        $bm = new ilBookmark($_GET["obj_id"]);
                        $bm->setTitle(ilUtil::stripSlashes($_POST["title"]));
                        $bm->setTarget(ilUtil::stripSlashes($_POST["target"]));
                        $bm->setDescription(ilUtil::stripSlashes($_POST["description"]));
                        $bm->update();

                        $this->view();
                }
        }

Here is the call graph for this function:

ilBookmarkAdministrationGUI::updateBookmarkFolder

(

)

update bookmark folder

Definition at line 660 of file class.ilBookmarkAdministrationGUI.php.

References $_GET, editFormBookmarkFolder(), ilUtil\sendInfo(), ilUtil\stripSlashes(), and view().

        {
                if (!$this->tree->isInTree($_GET["obj_id"]))
                {
                        return;
                }

                // check title
                if (empty($_POST["title"]))
                {
                        ilUtil::sendInfo($this->lng->txt("please_enter_title"));
                        $this->editFormBookmarkFolder();
                }
                else
                {
                        // update bookmark folder
                        $bmf = new ilBookmarkFolder($_GET["obj_id"]);
                        $bmf->setTitle(ilUtil::stripSlashes($_POST["title"]));
                        $bmf->update();

                        $this->view();
                }
        }

Here is the call graph for this function:

ilBookmarkAdministrationGUI::view

(

)

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

References $_SESSION, $tree, ilFrameTargetInfo\_getFrame(), ilUtil\getImagePath(), ilBookmarkFolder\getObjects(), ilUtil\prepareFormOutput(), ilUtil\shortenText(), showPossibleSubObjects(), and ilUtil\switchColor().

Referenced by cancel(), confirm(), createBookmark(), createBookmarkFolder(), executeAction(), importFile(), updateBookmark(), and updateBookmarkFolder().

        {
                global $tree;

                include_once("classes/class.ilFrameTargetInfo.php");
                
                if ($this->id > 0 && !$this->tree->isInTree($this->id))
                {
                        return;
                }
                
                $mtree = new ilTree($_SESSION["AccountId"]);
                $mtree->setTableNames('bookmark_tree','bookmark_data');

                $this->tpl->addBlockFile("ADM_CONTENT", "objects", "tpl.table.html");

                $this->ctrl->setParameter($this, "bmf_id", $this->id);
                $this->tpl->setVariable("FORMACTION", $this->ctrl->getFormAction($this));

                $objects = ilBookmarkFolder::getObjects($this->id);

                $s_mode = ($this->mode == "tree")
                                ? "flat"
                                : "tree";
                $this->tpl->setCurrentBlock("tree_mode");
                $this->ctrl->setParameter($this, "bmf_id", $this->id);
                $this->tpl->setTreeFlatIcon($this->ctrl->getLinkTarget($this)."&set_mode=".$s_mode,
                        $s_mode);
                $this->tpl->parseCurrentBlock();


                $this->tpl->setCurrentBlock("objects");
                $this->tpl->addBlockfile("TBL_CONTENT", "tbl_content", "tpl.bookmark_row.html");
                $cnt = 0;

                // return to parent folder
                if ($this->id != $mtree->readRootId() || $this->id =="")
                {
                        $this->tpl->setCurrentBlock("tbl_content");

                        // color changing
                        $css_row = ilUtil::switchColor($cnt++,"tblrow1","tblrow2");

                        $this->tpl->setVariable("CHECKBOX", " ");
                        $this->tpl->setVariable("ROWCOL", $css_row);

                        $val = ilUtil::getImagePath("icon_cat.gif");
                        $this->tpl->setVariable("IMG", $val);
                        $this->tpl->setVariable("ALT_IMG", $this->lng->txt("bmf"));

                        // title
                        $this->ctrl->setParameter($this, "bmf_id", $mtree->getParentId($this->id));
                        $link = $this->ctrl->getLinkTarget($this);
                        $this->tpl->setVariable("TXT_TITLE", "..");
                        $this->tpl->setVariable("LINK_TARGET", $link);
                        $this->tpl->setVariable("FRAME_TARGET", ilFrameTargetInfo::_getFrame("MainContent"));

                        $this->tpl->parseCurrentBlock();
                }
                // all checkbox ids
                $a_ids=array();
                foreach ($objects as $key => $object)
                {
                        $a_ids[]=$object["type"].":".$object["obj_id"];
                        // type icon
                        $this->ctrl->setParameter($this, "bmf_id", $this->id);
                        $this->ctrl->setParameter($this, "obj_id", $object["obj_id"]);
                        $link = ($object["type"] == "bmf")
                                ? $this->ctrl->getLinkTarget($this, "editFormBookmarkFolder")
                                : $this->ctrl->getLinkTarget($this, "editFormBookmark");



                        // edit link
                        $this->tpl->setCurrentBlock("edit");
                        $this->tpl->setVariable("TXT_EDIT", $this->lng->txt("edit"));
                        $this->tpl->setVariable("LINK_EDIT", $link);
                        $this->tpl->parseCurrentBlock();
                        // target
                        if (!empty($object["target"]))
                        {
                                $this->tpl->setCurrentBlock("target");
                                $this->tpl->setVariable("TXT_TARGET",
                                        ilUtil::prepareFormOutput(ilUtil::shortenText(
                                                $object["target"],$this->textwidth, true)));
                                $this->tpl->setVariable("LINK_TARGET", htmlentities($object["target"]));
                                $this->tpl->parseCurrentBlock();
                        }
                        // description
                        if (!empty($object["description"]))
                        {
                                $this->tpl->setCurrentBlock("description");
                                $this->tpl->setVariable("TXT_DESCRIPTION",
                                        ilUtil::prepareFormOutput($object["description"]));
                                $this->tpl->parseCurrentBlock();
                        }

                        $this->tpl->setCurrentBlock("tbl_content");
                        // color changing
                        $css_row = ilUtil::switchColor($cnt++,"tblrow1","tblrow2");

                        // surpress checkbox for particular object types
                        //$this->tpl->setVariable("CHECKBOX_ID", $object["type"].":".$object["obj_id"]);
                        $this->tpl->setVariable("CHECKBOX",
                                ilUtil::formCheckBox("", "id[]", $object["type"].":".$object["obj_id"]));
                        $this->tpl->setVariable("ROWCOL", $css_row);

                        $img_type = ($object["type"] == "bmf") ? "cat" : $object["type"];
                        $val = ilUtil::getImagePath("icon_".$img_type.".gif");
                        $this->tpl->setVariable("IMG", $val);
                        $this->tpl->setVariable("ALT_IMG", $this->lng->txt($object["type"]));

                        // title
                        $this->ctrl->setParameter($this, "bmf_id", $object["obj_id"]);
                        $link = ($object["type"] == "bmf") ?
                                $this->ctrl->getLinkTarget($this) :
                                $object["target"];
                        $this->tpl->setVariable("TXT_TITLE", ilUtil::prepareFormOutput($object["title"]));
                        $this->tpl->setVariable("LINK_TARGET", htmlentities($link));

                        if ($object["type"] == "bmf")
                        {
                                $this->tpl->setVariable("FRAME_TARGET", ilFrameTargetInfo::_getFrame("MainContent"));
                        }
                        else
                        {
                                $this->tpl->setVariable("FRAME_TARGET", ilFrameTargetInfo::_getFrame("ExternalContent"));
                        }


                        $this->tpl->parseCurrentBlock();
                }

                $tbl = new ilTableGUI();

                if (!empty($this->id) && $this->id != 1)
                {
                        $BookmarkFolder = new ilBookmarkFolder($this->id);
                        $addstr = " ".$this->lng->txt("in")." ".$BookmarkFolder->getTitle();
                }
                else
                {
                        $addstr = "";
                }

                // title & header columns
                $tbl->setTitle($this->lng->txt("bookmarks").$addstr,
                        "icon_bm.gif", $this->lng->txt("bookmarks"));
                //$tbl->setHelp("tbl_help.php","icon_help.gif",$this->lng->txt("help"));
                $tbl->setHeaderNames(array("", $this->lng->txt("type"), $this->lng->txt("title"),""));
                $tbl->setHeaderVars(array("", "type", "title","commands"),
                        array("bmf_id" => $this->id));
                $tbl->setColumnWidth(array("1%", "1%", "100%", ""));

                //$tbl->setOrderColumn($_GET["sort_by"]);
                //$tbl->setOrderDirection($_GET["sort_order"]);
                $tbl->setLimit($limit);
                $tbl->setOffset($offset);
                $tbl->setMaxCount($maxcount);

                $tbl->enable("select_all");
                $tbl->setFormName("cmd");
                $tbl->setSelectAllCheckbox("id");
                
                // footer
                $tbl->setFooter("tblfooter", $this->lng->txt("previous"),$this->lng->txt("next"));
                //$tbl->disable("content");
                $tbl->disable("footer");
                $tbl->disable("header");

                // render table
                $tbl->render();

                // SHOW POSSIBLE SUB OBJECTS
                $this->tpl->setVariable("IMG_ARROW", ilUtil::getImagePath("arrow_downright.gif"));
                $this->tpl->setVariable("ALT_ARROW", $this->lng->txt("actions"));
                $this->tpl->setVariable("NUM_COLS", 5);
                $this->showPossibleSubObjects();

                $this->tpl->setCurrentBlock("tbl_action_row");
                $this->tpl->setVariable("COLUMN_COUNTS",4);
                $this->tpl->parseCurrentBlock();

        }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

ilBookmarkAdministrationGUI::$data

Definition at line 62 of file class.ilBookmarkAdministrationGUI.php.

ilBookmarkAdministrationGUI::$id

Definition at line 61 of file class.ilBookmarkAdministrationGUI.php.

Referenced by confirm(), delete(), and export().

ilBookmarkAdministrationGUI::$ilias

Definition at line 56 of file class.ilBookmarkAdministrationGUI.php.

Referenced by ilBookmarkAdministrationGUI().

ilBookmarkAdministrationGUI::$lng

Definition at line 58 of file class.ilBookmarkAdministrationGUI.php.

Referenced by displayLocator(), editFormBookmark(), editFormBookmarkFolder(), ilBookmarkAdministrationGUI(), newFormBookmark(), and newFormBookmarkFolder().

ilBookmarkAdministrationGUI::$textwidth = 100

Definition at line 63 of file class.ilBookmarkAdministrationGUI.php.

ilBookmarkAdministrationGUI::$tpl

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

Referenced by ilBookmarkAdministrationGUI().

ilBookmarkAdministrationGUI::$tree

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

Referenced by confirm(), and view().

ilBookmarkAdministrationGUI::$user_id

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

---

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

• Services/PersonalDesktop/classes/class.ilBookmarkAdministrationGUI.php