Class ilForumExplorerGUI. More...

Inheritance diagram for ilForumExplorerGUI:

Collaboration diagram for ilForumExplorerGUI:

Public Member Functions

__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd)

{Constructor.} More...

setThread (ilForumTopic $thread, ilForumPost $firstNode)

isNodeClickable ($a_node)

Is node clickable?

Parameters

mixed $a_node node object/array

Returns: boolean node clickable true/false

More...

getRootNode ()

{Get root node.Please note that the class does not make any requirements how nodes are represented (array or object)

Returns: mixed root node object/array

} More...

getChildsOfNode ($a_parent_node_id)

{Get childs of node.

Parameters

string $a_parent_id parent node id

Returns: array childs

} More...

preloadChildren ()

getNodeContent ($a_node)

{Get content of a node.

Parameters

mixed $a_node node array or object

Returns: string content of the node

} More...

getNodeHref ($a_node)

{Get href for node.

Parameters

mixed $a_node node object/array

Returns: string href attribute

} More...

getNodeId ($a_node)

{Get id of a node.

Parameters

mixed $a_node node array or object

Returns: string id of node

} More...

getNodeIcon ($a_node)

{Get node icon path.

Parameters

mixed $a_node node object/array

Returns: string image file path

} More...

beforeRendering ()

Before rendering. More...

getHTML ()

{Get HTML.} 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 (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 Member Functions
	getNodeTemplateInstance ()
	Factory method for a new instance of a node template. More...

	getNodeTitleClasses (array $node_config)

	getUnlinkedNodeContentClass ()

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
	$js_explorer_frm_path = './Modules/Forum/js/ilForumExplorer.js'

	$thread

	$max_entries = PHP_INT_MAX

	$tpl

	$ctrl

	$preloaded = false

	$preloaded_children = array()

	$node_id_to_parent_node_id_map = array()

	$root_node = null

	$authorInformation = []

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 = ""

	$child_limit = 0

Private Member Functions
	getAuthorInformationByNode (array $node)

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 = "./libs/bower/bower_components/jstree/dist/jstree.js"

static	$js_tree_path_css = "./libs/bower/bower_components/jstree/dist/themes/default/style.min.css"

static	$js_expl_path = "./Services/UIComponent/Explorer2/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 8 of file class.ilForumExplorerGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilForumExplorerGUI::__construct	(	$a_expl_id,
		$a_parent_obj,
		$a_parent_cmd
	)

{Constructor.}

Reimplemented from ilExplorerBaseGUI.

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

    {
        global $DIC;
 
        parent::__construct($a_expl_id, $a_parent_obj, $a_parent_cmd);
 
        $this->setSkipRootNode(false);
        $this->setAjax(true);
 
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC->ctrl();
 
        $frm = new ilForum();
        $this->max_entries = (int) $frm->getPageHits();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ beforeRendering()

ilForumExplorerGUI::beforeRendering ( )

Before rendering.

Reimplemented from ilExplorerBaseGUI.

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

    {
        if (isset($_GET['post_created_below']) && (int) $_GET['post_created_below'] > 0) {
            $parent = (int) $_GET['post_created_below'];
            do {
                $this->setNodeOpen((int) $parent);
            } while ($parent = $this->node_id_to_parent_node_id_map[$parent]);
 
            $this->store->set("on_" . $this->id, serialize(array_unique(array_merge($this->open_nodes, $this->custom_open_nodes))));
        }
    }

References $_GET, and ilExplorerBaseGUI\setNodeOpen().

Here is the call graph for this function:

◆ getAuthorInformationByNode()

ilForumExplorerGUI::getAuthorInformationByNode ( array $node )

private

Parameters

array $node

Returns: \ilForumAuthorInformation

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

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

Referenced by getNodeContent(), and getNodeIcon().

Here is the caller graph for this function:

◆ getChildsOfNode()

ilForumExplorerGUI::getChildsOfNode ( $a_parent_node_id )

{Get childs of node.

Parameters

string $a_parent_id parent node id

Returns: array childs

}

Reimplemented from ilExplorerBaseGUI.

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

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

◆ getHTML()

ilForumExplorerGUI::getHTML ( )

{Get HTML.}

Reimplemented from ilExplorerBaseGUI.

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

    {
        $this->preloadChildren();
 
        $html = parent::getHTML();
 
        $this->tpl->addOnLoadCode('il.ForumExplorer.init(' . json_encode(array(
            'selectors' => array(
                'container' => '#' . $this->getContainerId(),
                'unlinked_content' => '.' . $this->getUnlinkedNodeContentClass()
            )
        )) . ');');
 
        $this->tpl->addJavascript($this->js_explorer_frm_path);
 
        return $html;
    }

References $html, ilExplorerBaseGUI\getContainerId(), getUnlinkedNodeContentClass(), and preloadChildren().

Here is the call graph for this function:

◆ getNodeContent()

ilForumExplorerGUI::getNodeContent ( $a_node )

{Get content of a node.

Parameters

mixed $a_node node array or object

Returns: string content of the node

}

Reimplemented from ilExplorerBaseGUI.

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

    {
        $tpl = $this->getNodeTemplateInstance();
 
        $tpl->setCurrentBlock('node-content-block');
        $tpl->setVariable('TITLE', $a_node['pos_subject']);
        $tpl->setVariable('TITLE_CLASSES', implode(' ', $this->getNodeTitleClasses($a_node)));
        $tpl->parseCurrentBlock();
 
        if ($this->root_node->getId() == $a_node['pos_pk']) {
            return $tpl->get();
        }
 
        $authorinfo = $this->getAuthorInformationByNode($a_node);
 
        $tpl->setCurrentBlock('unlinked-node-content-block');
        $tpl->setVariable('UNLINKED_CONTENT_CLASS', $this->getUnlinkedNodeContentClass());
        $tpl->setVariable('AUTHOR', $authorinfo->getAuthorShortName());
        $tpl->setVariable('DATE', ilDatePresentation::formatDate(new ilDateTime($a_node['pos_date'], IL_CAL_DATETIME)));
        $tpl->parseCurrentBlock();
 
        return $tpl->get();
    }

References $tpl, ilDatePresentation\formatDate(), getAuthorInformationByNode(), getNodeTemplateInstance(), getNodeTitleClasses(), getUnlinkedNodeContentClass(), and IL_CAL_DATETIME.

Here is the call graph for this function:

◆ getNodeHref()

ilForumExplorerGUI::getNodeHref ( $a_node )

{Get href for node.

Parameters

mixed $a_node node object/array

Returns: string href attribute

}

Reimplemented from ilExplorerBaseGUI.

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

    {
        $this->ctrl->setParameter($this->parent_obj, 'backurl', null);
        $this->ctrl->setParameter($this->parent_obj, 'pos_pk', $a_node['pos_pk']);
 
        if (isset($a_node['counter'])) {
            $this->ctrl->setParameter($this->parent_obj, 'offset', floor($a_node['counter'] / $this->max_entries) * $this->max_entries);
        }
 
        if (isset($a_node['post_read']) && $a_node['post_read']) {
            return $this->ctrl->getLinkTarget($this->parent_obj, $this->parent_cmd, $a_node['pos_pk']);
        } else {
            return $this->ctrl->getLinkTarget($this->parent_obj, 'markPostRead', $a_node['pos_pk']);
        }
    }

◆ getNodeIcon()

ilForumExplorerGUI::getNodeIcon ( $a_node )

{Get node icon path.

Parameters

mixed $a_node node object/array

Returns: string image file path

}

Reimplemented from ilExplorerBaseGUI.

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

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

References getAuthorInformationByNode().

Here is the call graph for this function:

◆ getNodeId()

ilForumExplorerGUI::getNodeId ( $a_node )

{Get id of a node.

Parameters

mixed $a_node node array or object

Returns: string id of node

}

Reimplemented from ilExplorerBaseGUI.

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

    {
        return $a_node['pos_pk'];
    }

◆ getNodeTemplateInstance()

ilForumExplorerGUI::getNodeTemplateInstance ( )

protected

Factory method for a new instance of a node template.

Returns: ilTemplate

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

    {
        return new ilTemplate('tpl.tree_node_content.html', true, true, 'Modules/Forum');
    }

Referenced by getNodeContent().

Here is the caller graph for this function:

◆ getNodeTitleClasses()

ilForumExplorerGUI::getNodeTitleClasses ( array $node_config )

protected

Parameters

array $node_config

Returns: array

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

    {
        $node_title_classes = array('ilForumTreeTitle');
 
        if ($this->root_node->getId() == $node_config['pos_pk']) {
            return $node_title_classes;
        }
 
        if (isset($node_config['post_read']) && !$node_config['post_read']) {
            $node_title_classes[] = 'ilForumTreeTitleUnread';
        }
 
        return $node_title_classes;
    }

Referenced by getNodeContent().

Here is the caller graph for this function:

◆ getRootNode()

ilForumExplorerGUI::getRootNode ( )

{Get root node.Please note that the class does not make any requirements how nodes are represented (array or object)

Returns: mixed root node object/array

}

Reimplemented from ilExplorerBaseGUI.

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

    {
        if (null === $this->root_node) {
            $this->root_node = $this->thread->getFirstPostNode();
        }
 
        return array(
            '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()
        );
    }

◆ getUnlinkedNodeContentClass()

ilForumExplorerGUI::getUnlinkedNodeContentClass ( )

protected

Returns: string

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

    {
        return 'ilForumTreeUnlinkedContent';
    }

Referenced by getHTML(), and getNodeContent().

Here is the caller graph for this function:

◆ isNodeClickable()

ilForumExplorerGUI::isNodeClickable ( $a_node )

Is node clickable?

Parameters

mixed $a_node node object/array

Returns: boolean node clickable true/false

Reimplemented from ilExplorerBaseGUI.

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

    {
        $result = parent::isNodeClickable($a_node);
        if (!$result) {
            return false;
        }
 
        return $this->root_node->getId() != $a_node['pos_pk'];
    }

References $result.

◆ preloadChildren()

ilForumExplorerGUI::preloadChildren ( )

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

    {
        $this->preloaded_children = array();
        $this->node_id_to_parent_node_id_map = array();
 
        $children = $this->thread->getNestedSetPostChildren($this->root_node->getId());
 
        array_walk($children, function (&$a_node, $key) {
            $this->node_id_to_parent_node_id_map[(int) $a_node['pos_pk']] = (int) $a_node['parent_pos'];
            $this->preloaded_children[(int) $a_node['parent_pos']][$a_node['pos_pk']] = $a_node;
        });
 
        $this->preloaded = true;
    }

References $key.

Referenced by getHTML().

Here is the caller graph for this function:

◆ setThread()

ilForumExplorerGUI::setThread	(	ilForumTopic	$thread,
		ilForumPost	$firstNode
	)

Parameters

ilForumTopic	$thread
ilForumPost	$firstNode

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

    {
        $this->thread = $thread;
        $this->root_node = $firstNode;
        $this->root_node->setIsRead($this->root_node->isRead($this->root_node->getPosAuthorId()));
        $this->setNodeOpen($this->root_node->getId());
 
        $this->ctrl->setParameter($this->parent_obj, 'thr_pk', $this->thread->getId());
    }