Inheritance diagram for ilForumExplorerGUI:

Collaboration diagram for ilForumExplorerGUI:

Public Member Functions
	__construct (string $a_expl_id, object $a_parent_obj, string $a_parent_cmd, private readonly ilForumTopic $thread, private readonly ilForumPost $root_node)

	getChildsOfNode ($a_parent_node_id)

	getChildren ($record, $environment=null)
	Get a list of records (that list can also be empty). More...

	getTreeLabel ()

	getTreeComponent ()

	getNodeId ($a_node)

	getNodeIcon ($a_node)

	getNodeHref ($a_node)

	getNodeContent ($a_node)

Public Member Functions inherited from ilTreeExplorerGUI
	__construct (string $a_expl_id, $a_parent_obj, string $a_parent_cmd, ilTree $a_tree, string $a_node_parameter_name="node_id")

	getTree ()

	setOrderField (string $a_val, bool $a_numeric=false)

	getOrderField ()

	setTypeWhiteList (array $a_val)
	Set type white list. More...

	getTypeWhiteList ()
	Get type white list. More...

	setTypeBlackList (array $a_val)
	Set type black list. More...

	getTypeBlackList ()
	Get type black list. More...

	setPreloadChilds (bool $a_val)

	getPreloadChilds ()

	getSuccessorNode ( $a_node_id, string $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 ($record, $environment=null)
	Get a list of records (that list can also be empty). More...

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

	getTreeLabel ()

	getTreeComponent ()

	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
	setChildLimit (int $a_val)

	getChildLimit ()

	setSearchTerm (string $a_val)

	getSearchTerm ()

	setMainTemplate (?ilGlobalTemplateInterface $a_main_tpl=null)

	getRootNode ()
	Get root node. More...

	getChildsOfNode ($a_parent_node_id)
	Get children 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 children Please note that this standard method may not be optimal depending on what a derived class does in isNodeVisible. More...

	sortChilds (array $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 (bool $a_val)

	getSkipRootNode ()

	setAjax (bool $a_val)

	getAjax ()

	setSecondaryHighlightedNodes (array $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 (string $a_postvar, bool $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 (bool $a_val)

	getOfflineMode ()

	handleCommand ()
	Handle explorer internal command. More...

	getContainerId ()

	openNode ()
	Open node. More...

	closeNode ()
	Close node. More...

	getNodeAsync ()
	Get node asynchronously. More...

	beforeRendering ()
	Before rendering. More...

	getOnLoadCode ()
	Get on load code. More...

	getHTML ()

	renderNode ($a_node, ilTemplate $tpl)
	Render node. More...

	renderChilds ($a_node_id, ilTemplate $tpl)
	Render childs. More...

	getDomNodeIdForNodeId ($a_node_id)
	Get DOM node id for node id. More...

	getNodeIdForDomNodeId (string $a_dom_node_id)
	Get node id for dom node id. More...

	listItemStart (ilTemplate $tpl, $a_node)
	List item start. More...

	listItemEnd (ilTemplate $tpl)

	listStart (ilTemplate $tpl)

	listEnd (ilTemplate $tpl)

	isNodeOnclickEnabled ()

	setNodeOnclickEnabled (bool $nodeOnclickEnabled)

	isEnableDnd ()

	setEnableDnd (bool $enable_dnd)

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

	createNode (\ILIAS\UI\Component\Tree\Node\Factory $factory, $record)

	getNodeStateToggleCmdClasses ($record)

Protected Member Functions inherited from ilTreeExplorerGUI
	preloadChilds ()

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

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

	isNodeRequested (string $a_node_id)

Private Member Functions
	getRootNodeId ()

	getAuthorInformationByNode (array $node)

Private Attributes
readonly int	$max_entries

array	$preloaded_children = []

array	$authorInformation = []

Additional Inherited Members
Static Public Member Functions inherited from ilExplorerBaseGUI
static	getLocalExplorerJsPath ()

static	getLocalJsTreeJsPath ()

static	getLocalJsTreeCssPath ()

static	createHTMLExportDirs (string $a_target_dir)

static	init (?ilGlobalTemplateInterface $a_main_tpl=null)

Protected Attributes inherited from ilTreeExplorerGUI
ilLanguage	$lng

Psr Http Message ServerRequestInterface	$httpRequest

ilTree	$tree = null

string	$tree_label = ""

string	$order_field = ""

bool	$order_field_numeric = false

array	$type_white_list = array()

array	$type_black_list = array()

array	$childs = array()

bool	$preloaded = false

bool	$preload_childs = false

array	$root_node_data = null

array	$all_childs = array()

	$root_id = 0

ILIAS DI UIServices	$ui

Protected Attributes inherited from ilExplorerBaseGUI
string	$node_parameter_name

ilLogger	$log

ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

bool	$skip_root_node = false

bool	$ajax = false

array	$custom_open_nodes = array()

array	$selected_nodes = array()

string	$select_postvar = ""

bool	$offline_mode = false

array	$sec_highl_nodes = array()

bool	$enable_dnd = false

string	$search_term = ""

array	$open_nodes = []

ilSessionIStorage	$store

bool	$select_multi = false

	$parent_obj

int	$child_limit = 0

string	$parent_cmd = ''

string	$requested_exp_cmd = ""

string	$requested_exp_cont = ""

string	$requested_searchterm = ""

string	$requested_node_id = ""

string	$id

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

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

static string	$js_expl_path = "assets/js/Explorer2.js"

Detailed Description

Class ilForumExplorerGUI.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

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

Constructor & Destructor Documentation

◆ __construct()

ilForumExplorerGUI::__construct	(	string	$a_expl_id,
		object	$a_parent_obj,
		string	$a_parent_cmd,
		private readonly ilForumTopic	$thread,
		private readonly ilForumPost	$root_node
	)

Definition at line 36 of file class.ilForumExplorerGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ilExplorerBaseGUI\setAjax(), ilExplorerBaseGUI\setNodeOpen(), ilTreeExplorerGUI\setPreloadChilds(), and ilExplorerBaseGUI\setSkipRootNode().

       {
         global $DIC;
 
         parent::__construct($a_expl_id, $a_parent_obj, $a_parent_cmd, $DIC->repositoryTree());
 
         $this->setSkipRootNode(false);
         $this->setAjax(false);
         $this->setPreloadChilds(true);
 
         $this->ctrl->setParameter($this->parent_obj, 'thr_pk', $this->thread->getId());
 
         $frm = new ilForum();
         $this->max_entries = $frm->getPageHits();
 
         $this->setNodeOpen($this->root_node->getId());
     }

Here is the call graph for this function:

Member Function Documentation

◆ createNode()

ilForumExplorerGUI::createNode	(	\ILIAS\UI\Component\Tree\Node\Factory	$factory,
			$record
	)

protected

Definition at line 131 of file class.ilForumExplorerGUI.php.

References ilDatePresentation\formatDate(), getAuthorInformationByNode(), getNodeContent(), getNodeIcon(), ilTreeExplorerGUI\getNodeIconAlt(), IL_CAL_DATETIME, null, and ILIAS\Repository\ui().

      : \ILIAS\UI\Component\Tree\Node\Node {
         $nodeIconPath = $this->getNodeIcon($record);
 
         $icon = null;
         if ($nodeIconPath !== '') {
             $icon = $this->ui
                 ->factory()
                 ->symbol()
                 ->icon()
                 ->custom($nodeIconPath, $this->getNodeIconAlt($record));
         }
 
         if ((int) $record['pos_pk'] === $this->root_node->getId()) {
             $node = $factory->simple($this->getNodeContent($record), $icon);
         } else {
             $authorInfo = $this->getAuthorInformationByNode($record);
             $creationDate = ilDatePresentation::formatDate(new ilDateTime($record['pos_date'], IL_CAL_DATETIME));
             $bylineString = $authorInfo->getAuthorShortName() . ', ' . $creationDate;
 
             $node = $factory->bylined($this->getNodeContent($record), $bylineString, $icon);
         }
 
         return $node;
     }

Here is the call graph for this function:

◆ getAuthorInformationByNode()

ilForumExplorerGUI::getAuthorInformationByNode ( array $node )

private

Definition at line 64 of file class.ilForumExplorerGUI.php.

References ILIAS\Repository\int().

Referenced by createNode(), and getNodeIcon().

                                                             : ilForumAuthorInformation
     {
         return $this->authorInformation[(int) $node['pos_pk']] ?? ($this->authorInformation[(int) $node['pos_pk']] = new ilForumAuthorInformation(
             (int) ($node['pos_author_id'] ?? 0),
             (int) $node['pos_display_user_id'],
             (string) $node['pos_usr_alias'],
             (string) $node['import_name']
         ));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildren()

ilForumExplorerGUI::getChildren	(	$record,
		$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.

Implements ILIAS\UI\Component\Tree\TreeRecursion.

Definition at line 100 of file class.ilForumExplorerGUI.php.

References getChildsOfNode().

                                                              : array
     {
         return $this->getChildsOfNode((int) $record['pos_pk']);
     }

Here is the call graph for this function:

◆ getChildsOfNode()

ilForumExplorerGUI::getChildsOfNode ( $a_parent_node_id )

Definition at line 74 of file class.ilForumExplorerGUI.php.

Referenced by getChildren().

                                                       : array
     {
         if ($this->preloaded) {
             return $this->preloaded_children[$a_parent_node_id] ?? [];
         }
 
         return $this->thread->getNestedSetPostChildren($a_parent_node_id, 1);
     }

Here is the caller graph for this function:

◆ getNodeContent()

ilForumExplorerGUI::getNodeContent ( $a_node )

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

Referenced by createNode().

                                            : string
     {
         return $a_node['pos_subject'];
     }

Here is the caller graph for this function:

◆ getNodeHref()

ilForumExplorerGUI::getNodeHref ( $a_node )

Definition at line 181 of file class.ilForumExplorerGUI.php.

References $max_entries, $url, ILIAS\Repository\ctrl(), getRootNodeId(), ILIAS\Repository\int(), and null.

                                         : string
     {
         if ($this->getRootNodeId() === (int) $a_node['pos_pk']) {
             return '';
         }
 
         $this->ctrl->setParameter($this->parent_obj, 'backurl', null);
 
         if (isset($a_node['counter']) && $a_node['counter'] > 0) {
             $page = (int) floor(($a_node['counter'] - 1) / $this->max_entries);
             $this->ctrl->setParameter($this->parent_obj, 'page', $page);
         }
 
         if (isset($a_node['post_read']) && $a_node['post_read']) {
             $this->ctrl->setParameter($this->parent_obj, 'pos_pk', null);
             $url = $this->ctrl->getLinkTarget($this->parent_obj, $this->parent_cmd, (string) $a_node['pos_pk']);
         } else {
             $this->ctrl->setParameter($this->parent_obj, 'pos_pk', $a_node['pos_pk']);
             $url = $this->ctrl->getLinkTarget($this->parent_obj, 'markPostRead', (string) $a_node['pos_pk']);
             $this->ctrl->setParameter($this->parent_obj, 'pos_pk', null);
         }
 
         $this->ctrl->setParameter($this->parent_obj, 'page', null);
 
         return $url;
     }

Here is the call graph for this function:

◆ getNodeIcon()

ilForumExplorerGUI::getNodeIcon ( $a_node )

Definition at line 172 of file class.ilForumExplorerGUI.php.

References ilObject\_getIcon(), getAuthorInformationByNode(), and getRootNodeId().

Referenced by createNode().

                                         : string
     {
         if ($this->getRootNodeId() === (int) $a_node['pos_pk']) {
             return ilObject::_getIcon(0, 'tiny', 'frm');
         }
 
         return $this->getAuthorInformationByNode($a_node)->getProfilePicture();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNodeId()

ilForumExplorerGUI::getNodeId ( $a_node )

Definition at line 167 of file class.ilForumExplorerGUI.php.

                                       : int
     {
         return (isset($a_node['pos_pk']) ? (int) $a_node['pos_pk'] : 0);
     }

◆ getNodeStateToggleCmdClasses()

ilForumExplorerGUI::getNodeStateToggleCmdClasses ( $record )

protected

Definition at line 159 of file class.ilForumExplorerGUI.php.

                                                             : array
     {
         return [
             ilRepositoryGUI::class,
             ilObjForumGUI::class,
         ];
     }

◆ getRootNodeId()

ilForumExplorerGUI::getRootNodeId ( )

private

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

Referenced by getNodeHref(), and getNodeIcon().

                                     : int
     {
         return $this->root_node->getId();
     }

Here is the caller graph for this function:

◆ getTreeComponent()

ilForumExplorerGUI::getTreeComponent ( )

Definition at line 110 of file class.ilForumExplorerGUI.php.

References getTreeLabel(), and ILIAS\Repository\ui().

                                       : Tree
     {
         $rootNode = [
             [
                 'pos_pk' => $this->root_node->getId(),
                 'pos_subject' => $this->root_node->getSubject(),
                 'pos_author_id' => $this->root_node->getPosAuthorId(),
                 'pos_display_user_id' => $this->root_node->getDisplayUserId(),
                 'pos_usr_alias' => $this->root_node->getUserAlias(),
                 'pos_date' => $this->root_node->getCreateDate(),
                 'import_name' => $this->root_node->getImportName(),
                 'post_read' => $this->root_node->isPostRead()
             ]
         ];
 
         return $this->ui->factory()->tree()
                         ->expandable($this->getTreeLabel(), $this)
                         ->withData($rootNode)
                         ->withHighlightOnNodeClick(false);
     }

Here is the call graph for this function:

◆ getTreeLabel()

ilForumExplorerGUI::getTreeLabel ( )

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

References ILIAS\Repository\lng().

Referenced by getTreeComponent().

                                   : string
     {
         return $this->lng->txt("frm_posts");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ preloadChilds()

ilForumExplorerGUI::preloadChilds ( )

protected

Definition at line 83 of file class.ilForumExplorerGUI.php.

References ILIAS\Repository\int().

                                       : void
     {
         $this->preloaded_children = [];
 
         $children = $this->thread->getNestedSetPostChildren($this->root_node->getId());
 
         array_walk($children, function ($node, $key): void {
             if (!array_key_exists((int) $node['pos_pk'], $this->preloaded_children)) {
                 $this->preloaded_children[(int) $node['pos_pk']] = [];
             }
 
             $this->preloaded_children[(int) $node['parent_pos']][$node['pos_pk']] = $node;
         });
 
         $this->preloaded = true;
     }

Here is the call graph for this function:

Field Documentation

◆ $authorInformation

array ilForumExplorerGUI::$authorInformation = []

private

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

◆ $max_entries

readonly int ilForumExplorerGUI::$max_entries

private

Definition at line 29 of file class.ilForumExplorerGUI.php.

Referenced by getNodeHref().

◆ $preloaded_children

array ilForumExplorerGUI::$preloaded_children = []

private

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

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

components/ILIAS/Forum/classes/class.ilForumExplorerGUI.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createNode()

◆ getAuthorInformationByNode()

◆ getChildren()

◆ getChildsOfNode()

◆ getNodeContent()

◆ getNodeHref()

◆ getNodeIcon()

◆ getNodeId()

◆ getNodeStateToggleCmdClasses()

◆ getRootNodeId()

◆ getTreeComponent()

◆ getTreeLabel()

◆ preloadChilds()

Field Documentation

◆ $authorInformation

◆ $max_entries

◆ $preloaded_children