ilMailExplorer Class Reference

Class Mail Explorer class for explorer view for mailboxes. More...

Inheritance diagram for ilMailExplorer:

Collaboration diagram for ilMailExplorer:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd, $a_user_id)
	ilMailExplorer constructor. More...
	getNodeContent ($a_node)
	getNodeIcon ($a_node)
	getNodeIconAlt ($a_node)
	getNodeHref ($a_node)
	isNodeHighlighted ($a_node)
Public Member Functions inherited from ilTreeExplorerGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd, $a_tree)
	Constructor. More...
	getTree ()
	Get tree. More...
	setOrderField ($a_val, $a_numeric=false)
	Set order field. More...
	getOrderField ()
	Get order field. More...
	setTypeWhiteList ($a_val)
	Set type white list. More...
	getTypeWhiteList ()
	Get type white list. More...
	setTypeBlackList ($a_val)
	Set type black list. More...
	getTypeBlackList ()
	Get type black list. More...
	setPreloadChilds ($a_val)
	Set preload childs. More...
	getPreloadChilds ()
	Get preload childs. More...
	getSuccessorNode ($a_node_id, $a_type="")
	Get successor node (currently only(!) based on lft/rgt tree values) More...
	getChildsOfNode ($a_parent_node_id)
	Get childs of node. More...
	getNodeId ($a_node)
	Get id for node. More...
	getNodeIconAlt ($a_node)
	Get node icon alt attribute. More...
	getRootNode ()
	Get root node. More...
	setRootId ($a_root)
	setPathOpen ($a_id)
	Set node path to be opened. More...
	getHTML ()
	Get HTML. More...
Public Member Functions inherited from ilExplorerBaseGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd)
	Constructor. More...
	setMainTemplate (ilTemplate $a_main_tpl=null)
	Set main template (that is responsible for adding js/css) More...
	getRootNode ()
	Get root node. More...
	getChildsOfNode ($a_parent_node_id)
	Get childs of node. More...
	getNodeContent ($a_node)
	Get content of a node. More...
	getNodeId ($a_node)
	Get id of a node. More...
	getNodeHref ($a_node)
	Get href for node. More...
	nodeHasVisibleChilds ($a_node)
	Node has childs? More...
	sortChilds ($a_childs, $a_parent_node_id)
	Sort childs. More...
	getNodeIcon ($a_node)
	Get node icon path. More...
	getNodeIconAlt ($a_node)
	Get node icon alt attribute. More...
	getNodeTarget ($a_node)
	Get node target (frame) attribute. More...
	getNodeOnClick ($a_node)
	Get node onclick attribute. More...
	isNodeVisible ($a_node)
	Is node visible? More...
	isNodeHighlighted ($a_node)
	Is node highlighted? More...
	isNodeClickable ($a_node)
	Is node clickable? More...
	getId ()
	Get id of explorer element. More...
	setSkipRootNode ($a_val)
	Set skip root node. More...
	getSkipRootNode ()
	Get skip root node. More...
	setAjax ($a_val)
	Set ajax. More...
	getAjax ()
	Get ajax. More...
	setSecondaryHighlightedNodes ($a_val)
	Set secondary (background) highlighted nodes. More...
	getSecondaryHighlightedNodes ()
	Get secondary (background) highlighted nodes. More...
	setNodeOpen ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour) More...
	setSelectMode ($a_postvar, $a_multi=false)
	Set select mode (to deactivate, pass an empty string as postvar) More...
	setNodeSelected ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour) More...
	setOfflineMode ($a_val)
	Set offline mode. More...
	getOfflineMode ()
	Get offline mode. More...
	handleCommand ()
	Handle explorer internal command. More...
	getContainerId ()
	Get container id. More...
	openNode ()
	Open node. More...
	closeNode ()
	Close node. More...
	getNodeAsync ()
	Get node asynchronously. More...
	beforeRendering ()
	Before rendering. More...
	getOnLoadCode ()
	Get on load code. More...
	getHTML ()
	Get HTML. More...
	renderNode ($a_node, $tpl)
	Render node. More...
	renderChilds ($a_node_id, $tpl)
	Render childs. More...
	getDomNodeIdForNodeId ($a_node_id)
	Get DOM node id for node id. More...
	getNodeIdForDomNodeId ($a_dom_node_id)
	Get node id for dom node id. More...
	listItemStart ($tpl, $a_node)
	List item start. More...
	listItemEnd ($tpl)
	List item end. More...
	listStart ($tpl)
	List start. More...
	listEnd ($tpl)
	List end. More...
	isNodeOnclickEnabled ()
	setNodeOnclickEnabled ($nodeOnclickEnabled)
	isEnableDnd ()
	setEnableDnd ($enable_dnd)
	Enable Drag & Drop functionality. More...

Protected Attributes
	$lng
	$ctrl
Protected Attributes inherited from ilTreeExplorerGUI
	$lng
	$tree = null
	$order_field = ""
	$order_field_numeric = false
	$type_white_list = array()
	$type_black_list = array()
	$childs = array()
	$preloaded = false
	$preload_childs = false
	$root_node_data = null
	$all_childs = array()
Protected Attributes inherited from ilExplorerBaseGUI
	$log
	$ctrl
	$tpl
	$skip_root_node = false
	$ajax = false
	$custom_open_nodes = array()
	$selected_nodes = array()
	$select_postvar = ""
	$offline_mode = false
	$sec_highl_nodes = array()
	$enable_dnd = false

Additional Inherited Members
Static Public Member Functions inherited from ilExplorerBaseGUI
static	getLocalExplorerJsPath ()
	Get local path of explorer js. More...
static	getLocalJsTreeJsPath ()
	Get local path of jsTree js. More...
static	createHTMLExportDirs ($a_target_dir)
	Create html export directories. More...
static	init ($a_main_tpl=null)
	Init JS. More...
Protected Member Functions inherited from ilTreeExplorerGUI
	preloadChilds ()
	Preload childs. More...
	getRootId ()
Protected Member Functions inherited from ilExplorerBaseGUI
	isNodeSelectable ($a_node)
	Is node selectable? More...
	getNodeToggleOnClick ($a_node)
	Get onclick attribute for node toggling. More...
	getSelectOnClick ($a_node)
	Get onclick attribute for selecting radio/checkbox. More...
	getJSTreePlugins ()
Static Protected Attributes inherited from ilExplorerBaseGUI
static	$js_tree_path = "./libs/bower/bower_components/jstree/jquery.jstree.js"
static	$js_expl_path = "./Services/UIComponent/Explorer2/js/Explorer2.js"

Detailed Description

Class Mail Explorer class for explorer view for mailboxes.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

Definition at line 13 of file class.ilMailExplorer.php.

Constructor & Destructor Documentation

__construct()

ilMailExplorer::__construct	(		$a_parent_obj,
			$a_parent_cmd,
			$a_user_id
	)

ilMailExplorer constructor.

Parameters

$a_parent_obj
$a_parent_cmd
$a_user_id

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

References $DIC, ilExplorerBaseGUI\setAjax(), ilTreeExplorerGUI\setOrderField(), and ilExplorerBaseGUI\setSkipRootNode().

    {
        global $DIC;

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

        $this->tree = new ilTree($a_user_id);
        $this->tree->setTableNames('mail_tree', 'mail_obj_data');

        parent::__construct("mail_exp", $a_parent_obj, $a_parent_cmd, $this->tree);
        
        $this->setSkipRootNode(false);
        $this->setAjax(false);
        $this->setOrderField("title,m_type");
    }

Here is the call graph for this function:

Member Function Documentation

getNodeContent()

ilMailExplorer::getNodeContent

(

$a_node

)

Definition at line 48 of file class.ilMailExplorer.php.

References ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().

    {
        if ($a_node["child"] == $this->getNodeId($this->getRootNode())) {
            return $this->lng->txt("mail_folders");
        }
        
        if ($a_node["depth"] < 3) {
            return $this->lng->txt("mail_" . $a_node["title"]);
        }
        
        return $a_node["title"];
    }

Here is the call graph for this function:

getNodeHref()

ilMailExplorer::getNodeHref

(

$a_node

)

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

References $_GET, ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().

    {
        if ($a_node["child"] == $this->getNodeId($this->getRootNode())) {
            $a_node["child"] = 0;
        }

        $this->ctrl->setParameter($this->parent_obj, "mobj_id", $a_node["child"]);
        $href = $this->ctrl->getLinkTargetByClass("ilMailFolderGUI");
        $this->ctrl->setParameter($this->parent_obj, "mobj_id", $_GET["mobj_id"]);

        return $href;
    }

Here is the call graph for this function:

getNodeIcon()

ilMailExplorer::getNodeIcon

(

$a_node

)

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

References ilUtil\getImagePath(), ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().

    {
        if ($a_node["child"] == $this->getNodeId($this->getRootNode())) {
            return ilUtil::getImagePath("icon_mail.svg");
        } else {
            $icon_type = ($a_node["m_type"] == "user_folder")
                ? "local"
                : $a_node["m_type"];
            return ilUtil::getImagePath("icon_" . $icon_type . ".svg");
        }
    }

Here is the call graph for this function:

getNodeIconAlt()

ilMailExplorer::getNodeIconAlt

(

$a_node

)

Definition at line 73 of file class.ilMailExplorer.php.

References ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().

    {
        if ($a_node["child"] == $this->getNodeId($this->getRootNode())) {
            return $this->lng->txt("icon") . " " . $this->lng->txt("mail_folders");
        } else {
            return $this->lng->txt("icon") . " " . $this->lng->txt($a_node["m_type"]);
        }
    }

Here is the call graph for this function:

isNodeHighlighted()

ilMailExplorer::isNodeHighlighted

(

$a_node

)

Definition at line 95 of file class.ilMailExplorer.php.

References $_GET, ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().

    {
        if ($a_node["child"] == $_GET["mobj_id"] ||
            ($_GET["mobj_id"] == "" && $a_node["child"] == $this->getNodeId($this->getRootNode()))) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Field Documentation

$ctrl

ilMailExplorer::$ctrl

protected

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

$lng

ilMailExplorer::$lng

protected

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

---

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

• Services/Mail/classes/class.ilMailExplorer.php