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

Inheritance diagram for ilMailExplorer:

Collaboration diagram for ilMailExplorer:

Public Member Functions
	__construct ($parentObject, $userId)
	ilMailExplorer constructor. More...

	getTreeLabel ()

	getTreeComponent ()

	build (Factory $factory, $record, $environment=null)

	getNodeContent ($node)

	getNodeIconAlt ($a_node)

	getNodeIcon ($node)

	getNodeHref ($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 ($new=false)
	Get HTML. More...

	getChildren ($node, $environment=null)
	Get a list of records (that list can also be empty).Each record will be relayed to $this->build to retrieve a Node. Also, each record will be asked for Sub-Nodes using this function. Returns array More...

	build (\ILIAS\UI\Component\Tree\Node\Factory $factory, $record, $environment=null)

	getTreeLabel ()

	getTreeComponent ()
	Get Tree UI. More...

	toggleExplorerNodeState ()
	Should be called by an ilCtrl-enabled command class if a tree node toggle action should be processed. More...

Public Member Functions inherited from ilExplorerBaseGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd)
	Constructor. More...

	setChildLimit ($a_val)
	Set child limit. More...

	getChildLimit ()
	Get child limit. More...

	setSearchTerm ($a_val)
	Set search term. More...

	getSearchTerm ()
	Get search term. More...

	setMainTemplate ($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...

Public Member Functions inherited from ILIAS\UI\Component\Tree\TreeRecursion
	build (Node\Factory $factory, $record, $environment=null)
	Build and return a Node. More...

Protected Member Functions
	initFolder ()

	getNodeStateToggleCmdClasses ($record)

Protected Member Functions inherited from ilTreeExplorerGUI
	preloadChilds ()
	Preload childs. More...

	matches ($node)
	Does a node match a search term (or is search term empty) More...

	getRootId ()

	createNode (\ILIAS\UI\Component\Tree\Node\Factory $factory, $record)
	Creates at tree node, can be overwritten in derivatives if another node type should be used. More...

	getNodeStateToggleCmdClasses ($record)
	Should return an array of ilCtrl-enabled command classes which should be used to build the URL for the expand/collapse actions applied on a tree node. More...

	render ()
	Render tree. More...

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

	isNodeOpen ($node_id)
	Get all open nodes. More...

	getJSTreePlugins ()

Protected Attributes
	$currentFolderId = 0

Protected Attributes inherited from ilTreeExplorerGUI
	$lng

	$httpRequest

	$tree = null

	$tree_label = ""

	$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()

	$ui

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

	$search_term = ""

	$open_nodes = []

	$store

	$parent_obj

	$child_limit = 0

	$parent_cmd = ''

Private Attributes
	$parentObject

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	getLocalJsTreeCssPath ()
	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...

Static Protected Attributes inherited from ilExplorerBaseGUI
static	$js_tree_path = "./node_modules/jstree/dist/jstree.js"

static	$js_tree_path_css = "./node_modules/jstree/dist/themes/default/style.min.css"

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; Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

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

Constructor & Destructor Documentation

◆ __construct()

ilMailExplorer::__construct	(	$parentObject,
		$userId
	)

ilMailExplorer constructor.

Parameters

$parentObject
$userId

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

References $parentObject, ILIAS\GlobalScreen\Provider\__construct(), initFolder(), ilExplorerBaseGUI\setAjax(), ilTreeExplorerGUI\setOrderField(), and ilExplorerBaseGUI\setSkipRootNode().

     {
         $this->parentObject = $parentObject;
 
         $this->tree = new ilTree($userId);
         $this->tree->setTableNames('mail_tree', 'mail_obj_data');
 
         parent::__construct('mail_exp', $parentObject, '', $this->tree);
 
         $this->initFolder();
 
         $this->setSkipRootNode(true);
         $this->setAjax(false);
         $this->setOrderField('title,m_type');
     }

Here is the call graph for this function:

Member Function Documentation

◆ build()

ilMailExplorer::build	(	Factory	$factory,
			$record,
			$environment = `null`
	)

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

       : Node {
         $node = parent::build($factory, $record, $environment);
 
         return $node->withHighlighted($this->currentFolderId === (int) $record['child']);
     }

◆ getNodeContent()

ilMailExplorer::getNodeContent ( $node )

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

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

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

Here is the call graph for this function:

◆ getNodeHref()

ilMailExplorer::getNodeHref ( $node )

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

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

     {
         if ($node['child'] == $this->getNodeId($this->getRootNode())) {
             $node['child'] = 0;
         }
 
         $this->ctrl->setParameterByClass('ilMailFolderGUI', 'mobj_id', $node['child']);
         $href = $this->ctrl->getLinkTargetByClass(['ilMailGUI', 'ilMailFolderGUI'], '', '', false, false);
         $this->ctrl->clearParametersByClass('ilMailFolderGUI');
 
         return $href;
     }

Here is the call graph for this function:

◆ getNodeIcon()

ilMailExplorer::getNodeIcon ( $node )

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

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

     {
         if ($node['child'] == $this->getNodeId($this->getRootNode())) {
             $icon = ilUtil::getImagePath('icon_mail.svg');
         } else {
             $iconType = $node['m_type'];
             if ($node['m_type'] === 'user_folder') {
                 $iconType = 'local';
             }
 
             $icon = ilUtil::getImagePath('icon_' . $iconType . '.svg');
         }
 
         return $icon;
     }

Here is the call graph for this function:

◆ getNodeIconAlt()

ilMailExplorer::getNodeIconAlt ( $a_node )

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

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

     {
         $content = ilUtil::prepareFormOutput($a_node['title']);
 
         if ($a_node['child'] == $this->getNodeId($this->getRootNode())) {
             $content = $this->lng->txt('mail_folders');
         } elseif ($a_node['depth'] < 3) {
             $content = $this->lng->txt('mail_' . $a_node['title']);
         }
 
         return $content;
     }

Here is the call graph for this function:

◆ getNodeStateToggleCmdClasses()

ilMailExplorer::getNodeStateToggleCmdClasses ( $record )

protected

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

                                                              : array
     {
         return [
             'ilMailGUI',
         ];
     }

◆ getTreeComponent()

ilMailExplorer::getTreeComponent ( )

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

References Vendor\Package\$f, ilTreeExplorerGUI\$tree, getTreeLabel(), and ui().

                                        : Tree
     {
         $f = $this->ui->factory();
 
         $tree = $f->tree()
             ->expandable($this->getTreeLabel(), $this)
             ->withData($this->tree->getChilds((int) $this->tree->readRootId()))
             ->withHighlightOnNodeClick(false);
 
         return $tree;
     }

Here is the call graph for this function:

◆ getTreeLabel()

ilMailExplorer::getTreeLabel ( )

Returns: string

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

Referenced by getTreeComponent().

     {
         return $this->lng->txt("mail_folders");
     }

Here is the caller graph for this function:

◆ initFolder()

ilMailExplorer::initFolder ( )

protected

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

Referenced by __construct().

                                     : void
     {
         $folderId = (int) ($this->httpRequest->getParsedBody()['mobj_id'] ?? 0);
         if (0 === $folderId) {
             $folderId = (int) ($this->httpRequest->getQueryParams()['mobj_id'] ?? 0);
         }
 
         $this->currentFolderId = (int) $folderId;
     }

Here is the caller graph for this function:

Field Documentation

◆ $currentFolderId

ilMailExplorer::$currentFolderId = 0

protected

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

◆ $parentObject

ilMailExplorer::$parentObject

private

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

Referenced by __construct().

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

Services/Mail/classes/class.ilMailExplorer.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ build()

◆ getNodeContent()

◆ getNodeHref()

◆ getNodeIcon()

◆ getNodeIconAlt()

◆ getNodeStateToggleCmdClasses()

◆ getTreeComponent()

◆ getTreeLabel()

◆ initFolder()

Field Documentation

◆ $currentFolderId

◆ $parentObject