Taxononmy tree explorer. More...

Inheritance diagram for ilTaxonomyExplorer:

Collaboration diagram for ilTaxonomyExplorer:

Public Member Functions
	__construct ($a_target, $a_tax_tree, $a_gui_class="ilobjtaxonomygui", $a_gui_cmd="listItems")
	Constructor public.
	setRootNodeTitle ($a_val)
	Set root node titl.
	getRootNodeTitle ()
	Get root node titl.
	setForceOpenPath ($a_path)
	set force open path
	formatHeader (&$tpl, $a_obj_id, $a_option)
	overwritten method from base class public
	formatObject (&$tpl, $a_node_id, $a_option, $a_obj_id=0)
	overwritten method from base class private
	isClickable ($a_type, $a_obj_id=0)
	check if links for certain object type are activated
	buildLinkTarget ($a_node_id, $a_type)
	build link target
	buildTitle ($a_title, $a_id, $a_type)
	standard implementation for title, may be overwritten by derived classes
	forceExpanded ($a_obj_id)
	force expansion of node
	buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
	Get frame target.
	getImage ($a_name, $a_type="", $a_obj_id="")
	get image path (may be overwritten by derived classes)
	sortNodes ($a_nodes, $a_parent_obj_id)
	Sort nodes.
Public Member Functions inherited from ilExplorer
	ilExplorer ($a_target)
	Constructor public.
	setId ($a_val)
	Set id.
	getId ()
	Get id.
	setAsynchExpanding ($a_val)
	Set asynch expanding.
	getAsynchExpanding ()
	Get asynch expanding.
	initItemCounter ($a_number)
	Init item counter.
	setTitle ($a_val)
	Set title.
	setTitleLength ($a_length)
	Set max title length.
	getTitleLength ()
	Get max title length.
	getTitle ()
	Get title.
	setRoot ($a_root_id)
	Set root node.
	getRoot ()
	get root id
	setOrderColumn ($a_column)
	set the order column public
	setOrderDirection ($a_direction)
	set the order direction public
	setTargetGet ($a_target_get)
	set the varname in Get-string public
	setParamsGet ($a_params_get)
	set additional params to be passed in Get-string public
	setExpandTarget ($a_exp_target)
	target script for expand icons
	setFrameUpdater ($a_up_frame, $a_up_script, $a_params="")
	Set Explorer Updater.
	highlightNode ($a_id)
	set highlighted node
	checkPermissions ($a_check)
	check permissions via rbac
	setSessionExpandVariable ($a_var_name="expand")
	set name of expand session variable
	outputIcons ($a_icons)
	output icons
	setClickable ($a_type, $a_clickable)
	(de-)activates links for a certain object type
	isVisible ($a_ref_id, $a_type)
	setTreeLead ($a_val)
	Set tree leading content.
	getTreeLead ()
	Get tree leading content.
	setPostSort ($a_sort)
	process post sorting
	setFilterMode ($a_mode=IL_FM_NEGATIVE)
	set filter mode
	getFilterMode ()
	get filter mode
	setUseStandardFrame ($a_val)
	Set use standard frame.
	getUseStandardFrame ()
	Get use standard explorer frame.
	getChildsOfNode ($a_parent_id)
	Get childs of node.
	setOutput ($a_parent_id, $a_depth=1, $a_obj_id=0, $a_highlighted_subtree=false)
	Creates output for explorer view in admin menue recursive method public.
	modifyChilds ($a_parent_id, $a_objects)
	showChilds ($a_parent_id)
	determines wether the childs of an object should be shown or not note: this standard implementation always returns true but it could be overwritten by derived classes (e.g.
	getMaximumTreeDepth ()
	Get maximum tree depth.
	getOutput ()
	Creates output recursive method public.
	handleListEndTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
	handle list end tags ( and )
	handleListStartTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
	handle list start tags (
	getImageAlt ($a_default_text, $a_type="", $a_obj_id="")
	get image alt text
	getNodeStyleClass ($a_id, $a_type)
	get style class for node
	buildOnClick ($a_node_id, $a_type, $a_title)
	get onclick event handling (may be overwritten by derived classes)
	buildDescription ($a_desc, $a_id, $a_type)
	standard implementation for description, may be overwritten by derived classes
	buildSelect ($a_node_id, $a_type)
	standard implementation for adding an option select box between image and title
	createTarget ($a_type, $a_node_id, $a_highlighted_subtree=false, $a_append_anch=true)
	Creates Get Parameter private.
	setFrameTarget ($a_target)
	set target frame or not frame?
	createLines ($a_depth)
	Creates lines for explorer view private.
	is_in_array ($a_start, $a_depth)
	DESCRIPTION MISSING private.
	getIndex ($a_data)
	get index of format_options array from specific ref_id,parent_id private
	addFilter ($a_item)
	adds item to the filter public
	delFilter ($a_item)
	removes item from the filter public
	setExpand ($a_node_id)
	set the expand option this value is stored in a SESSION variable to save it different view (lo view, frm view,...) private
	forceExpandAll ($a_mode, $a_show_minus=true)
	force expandAll.
	setFiltered ($a_bool)
	active/deactivate the filter public
	checkFilter ($a_item)
	check if item is in filter private

Additional Inherited Members
Data Fields inherited from ilExplorer
	$id
	$ilias
	$output
	$format_options
	$tree
	$target
	$target_get
	$params_get
	$expanded
	$order_column
	$order_direction = "asc"
	$expand_target
	$rbac_check
	$output_icons
	$expand_variable
	$is_clickable
	$post_sort
	$filtered = false
	$filter_mode
	$expand_all = false
	$root_id = null
	$use_standard_frame = false

Detailed Description

Taxononmy tree explorer.

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

Version: $Id$

Definition at line 15 of file class.ilTaxonomyExplorer.php.

Constructor & Destructor Documentation

ilTaxonomyExplorer::__construct	(	$a_target,
		$a_tax_tree,
		$a_gui_class = `"ilobjtaxonomygui"`,
		$a_gui_cmd = `"listItems"`
	)

Constructor public.

Parameters

string	scriptname
int	user_id

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

References $lng, ilExplorer\checkPermissions(), ilObjTaxonomy\lookupSortingMode(), ilExplorer\setPostSort(), setRootNodeTitle(), ilExplorer\setSessionExpandVariable(), and ilObjTaxonomy\SORT_MANUAL.

        {
                global $lng;
                
                parent::__construct($a_target);
                
                include_once("./Services/Taxonomy/classes/class.ilObjTaxonomy.php");
                $sort_mode = ilObjTaxonomy::lookupSortingMode($a_tax_tree->getTreeId());
                $this->setPostSort(false);
                if ($sort_mode == ilObjTaxonomy::SORT_MANUAL)
                {
                        $this->setPostSort(true);
                }
                
                //$this->setFilterMode(IL_FM_POSITIVE);
                //$this->addFilter("tax");
                
                $this->gui_class = $a_gui_class;
                $this->gui_cmd = $a_gui_cmd;
                $this->tree = $a_tax_tree;
                $this->root_id = $this->tree->readRootId();
                
                $this->setSessionExpandVariable("txexpand");
                $this->checkPermissions(false);
                
//              $this->setOrderColumn("order_nr");
//              $this->textwidth = 200;
                $this->force_open_path = array();
                
                $this->setRootNodeTitle($lng->txt("tax_taxonomy"));
        }

Here is the call graph for this function:

Member Function Documentation

ilTaxonomyExplorer::buildFrameTarget	(	$a_type,
		$a_child = `0`,
		$a_obj_id = `0`
	)

Get frame target.

Reimplemented from ilExplorer.

Definition at line 197 of file class.ilTaxonomyExplorer.php.

        {
                return "";
        }

ilTaxonomyExplorer::buildLinkTarget	(	$a_node_id,
		$a_type
	)

build link target

Reimplemented from ilExplorer.

Definition at line 158 of file class.ilTaxonomyExplorer.php.

References $_GET, $ilCtrl, and $ret.

        {
                global $ilCtrl;
                
                switch($a_type)
                {
                        // taxonomy node
                        case "taxn":
                                $ilCtrl->setParameterByClass($this->gui_class, "tax_node", $a_node_id);
                                $ret = $ilCtrl->getLinkTargetByClass($this->gui_class, $this->gui_cmd);
                                $ilCtrl->setParameterByClass($this->gui_class, "tax_node", $_GET["tax_node"]);
                                return $ret;
                                break;
                }
        }

ilTaxonomyExplorer::buildTitle	(	$a_title,
		$a_id,
		$a_type
	)

standard implementation for title, may be overwritten by derived classes

Reimplemented from ilExplorer.

Definition at line 177 of file class.ilTaxonomyExplorer.php.

        {
                return $a_title;
        }

ilTaxonomyExplorer::forceExpanded ( $a_obj_id )

force expansion of node

Reimplemented from ilExplorer.

Definition at line 185 of file class.ilTaxonomyExplorer.php.

        {
                if (in_array($a_obj_id, $this->force_open_path))
                {
                        return true;
                }
                return false;
        }

ilTaxonomyExplorer::formatHeader	(	&	$tpl,
			$a_obj_id,
			$a_option
	)

overwritten method from base class public

Parameters

integer	obj_id
integer	array options

Returns: string

Reimplemented from ilExplorer.

Definition at line 92 of file class.ilTaxonomyExplorer.php.

References $_GET, $ilCtrl, ilExplorer\$ilias, $lng, $tpl, ilUtil\getImagePath(), and getRootNodeTitle().

        {
                global $lng, $ilias, $ilCtrl;
                $ilCtrl->setParameterByClass($this->gui_class, "tax_node",
                        $this->tree->readRootId());
                
                $tpl->setCurrentBlock("icon");
                $tpl->setVariable("ICON_IMAGE" , ilUtil::getImagePath("icon_scat_s.png"));
                $tpl->setVariable("TXT_ALT_IMG", $lng->txt("tax_node"));
                $tpl->parseCurrentBlock();
                $tpl->setCurrentBlock("link");
                $tpl->setVariable("TITLE", $this->getRootNodeTitle());
                if ($this->highlighted == $this->tree->readRootId())
                {
                        $tpl->setVariable("A_CLASS", "class='il_HighlightedNode'");
                }
                $tpl->setVariable("LINK_TARGET",
                        $ilCtrl->getLinkTargetByClass($this->gui_class, $this->gui_cmd));
                $tpl->parseCurrentBlock();
                
                $tpl->touchBlock("element");
                $ilCtrl->setParameterByClass($this->gui_class, "tax_node",
                        $_GET["tax_node"]);
        }

Here is the call graph for this function:

ilTaxonomyExplorer::formatObject	(	&	$tpl,
			$a_node_id,
			$a_option,
			$a_obj_id = `0`
	)

overwritten method from base class private

Parameters

integer
array

Returns: string

Reimplemented from ilExplorer.

Definition at line 127 of file class.ilTaxonomyExplorer.php.

References $lng, and $tpl.

        {
                global $lng;
                
/*              $tpl->setCurrentBlock("icon");
                $tpl->setVariable("ICON_IMAGE" , $this->getImage("icon_".$a_option["type"]."_s.png", $a_option["type"], $a_obj_id));
                $tpl->setVariable("TARGET_ID" , "iconid_".$a_node_id);
                $this->iconList[] = "iconid_".$a_node_id;
                $tpl->setVariable("TXT_ALT_IMG", $lng->txt($a_option["desc"]));
                $tpl->parseCurrentBlock();
                
                $this->outputIcons(false);*/
                parent::formatObject($tpl, $a_node_id,$a_option,$a_obj_id);
        }

ilTaxonomyExplorer::getImage	(	$a_name,
		$a_type = `""`,
		$a_obj_id = `""`
	)

get image path (may be overwritten by derived classes)

Reimplemented from ilExplorer.

Definition at line 205 of file class.ilTaxonomyExplorer.php.

References ilUtil\getImagePath().

        {
                return ilUtil::getImagePath($a_name);
        }

Here is the call graph for this function:

ilTaxonomyExplorer::getRootNodeTitle ( )

Get root node titl.

Returns: string root node title

Definition at line 72 of file class.ilTaxonomyExplorer.php.

Referenced by formatHeader().

        {
                return $this->root_node_title;
        }

Here is the caller graph for this function:

ilTaxonomyExplorer::isClickable	(	$a_type,
		$a_obj_id = `0`
	)

check if links for certain object type are activated

Parameters

string $a_type object type

Returns: boolean true if linking is activated

Reimplemented from ilExplorer.

Definition at line 149 of file class.ilTaxonomyExplorer.php.

References $ilUser.

        {
                global $ilUser;
                return true;
        }

ilTaxonomyExplorer::setForceOpenPath ( $a_path )

set force open path

Definition at line 80 of file class.ilTaxonomyExplorer.php.

        {
                $this->force_open_path = $a_path;
        }

ilTaxonomyExplorer::setRootNodeTitle ( $a_val )

Set root node titl.

Parameters

string $a_val root node title

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

Referenced by __construct().

        {
                $this->root_node_title = $a_val;
        }

Here is the caller graph for this function:

ilTaxonomyExplorer::sortNodes	(	$a_nodes,
		$a_parent_obj_id
	)

Sort nodes.

Parameters

array node list as returned by iltree::getChilds();

Returns: array sorted nodes

Reimplemented from ilExplorer.

Definition at line 216 of file class.ilTaxonomyExplorer.php.

References ilUtil\sortArray().

        {
                $a_nodes = ilUtil::sortArray($a_nodes, "order_nr", "asc", true);
                
                
                return $a_nodes;
        }

Here is the call graph for this function:

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

Services/Taxonomy/classes/class.ilTaxonomyExplorer.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation