Public Section Explorer. More...

Inheritance diagram for ilShopPublicSectionSelector:

Collaboration diagram for ilShopPublicSectionSelector:

Public Member Functions
	__construct ($a_target, $a_lm_obj, $a_gui_class)
	Constructor public. More...

	buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)

	buildLinkTarget ($a_node_id, $a_type)

	isClickable ($a_type, $a_node_id)

	getOutput ()

Public Member Functions inherited from ilLMTOCExplorer
	ilLMTOCExplorer ($a_target, $a_lm_obj, $a_lang="-")
	Constructor public. More...

	setOfflineMode ($a_offline=true)
	set offline mode More...

	offlineMode ()
	get offline mode More...

	setForceOpenPath ($a_path)
	set force open path More...

	buildTitle ($a_title, $a_id, $a_type)
	standard implementation for title, maybe overwritten by derived classes More...

	getImage ($a_name, $a_type="", $a_id="")
	get image path (may be overwritten by derived classes) More...

	isClickable ($a_type, $a_node_id)

	buildLinkTarget ($a_node_id, $a_type)
	build link target More...

	forceExpanded ($a_obj_id)
	force expansion of node More...

	isVisible ($a_id, $a_type)

Public Member Functions inherited from ilLMExplorer
	ilLMExplorer ($a_target, $a_lm_obj, $a_lang="-")
	Constructor public. More...

	formatHeader (&$tpl, $a_obj_id, $a_option)
	overwritten method from base class public More...

	isClickable ($a_type, $a_obj_id=0)
	check if links for certain object type are activated More...

Public Member Functions inherited from ilExplorer
	ilExplorer ($a_target)
	Constructor public. More...

	setId ($a_val)
	Set id. More...

	getId ()
	Get id. More...

	setAsynchExpanding ($a_val)
	Set asynch expanding. More...

	getAsynchExpanding ()
	Get asynch expanding. More...

	initItemCounter ($a_number)
	Init item counter. More...

	setTitle ($a_val)
	Set title. More...

	setTitleLength ($a_length)
	Set max title length. More...

	getTitleLength ()
	Get max title length. More...

	getTitle ()
	Get title. More...

	setRoot ($a_root_id)
	Set root node. More...

	getRoot ()
	get root id More...

	setOrderColumn ($a_column)
	set the order column public More...

	setOrderDirection ($a_direction)
	set the order direction public More...

	setTargetGet ($a_target_get)
	set the varname in Get-string public More...

	setParamsGet ($a_params_get)
	set additional params to be passed in Get-string public More...

	setExpandTarget ($a_exp_target)
	target script for expand icons More...

	setFrameUpdater ($a_up_frame, $a_up_script, $a_params="")
	Set Explorer Updater. More...

	highlightNode ($a_id)
	set highlighted node More...

	checkPermissions ($a_check)
	check permissions via rbac More...

	setSessionExpandVariable ($a_var_name="expand")
	set name of expand session variable More...

	outputIcons ($a_icons)
	output icons More...

	setClickable ($a_type, $a_clickable)
	(de-)activates links for a certain object type More...

	isVisible ($a_ref_id, $a_type)

	setTreeLead ($a_val)
	Set tree leading content. More...

	getTreeLead ()
	Get tree leading content. More...

	isClickable ($a_type, $a_ref_id=0)
	check if links for certain object type are activated More...

	setPostSort ($a_sort)
	process post sorting More...

	setFilterMode ($a_mode=IL_FM_NEGATIVE)
	set filter mode More...

	getFilterMode ()
	get filter mode More...

	setUseStandardFrame ($a_val)
	Set use standard frame. More...

	getUseStandardFrame ()
	Get use standard explorer frame. More...

	getChildsOfNode ($a_parent_id)
	Get childs of node. More...

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

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

	forceExpanded ($a_obj_id)
	force expansion of node More...

	getMaximumTreeDepth ()
	Get maximum tree depth. More...

	getOutput ()
	Creates output recursive method public. More...

	handleListEndTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
	handle list end tags ( and ) More...

	handleListStartTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
	handle list start tags ( More...

	formatHeader (&$tpl, $a_obj_id, $a_option)
	Creates output for header (is empty here but can be overwritten in derived classes) More...

	formatObject (&$tpl, $a_node_id, $a_option, $a_obj_id=0)
	Creates output recursive method private. More...

	getImage ($a_name, $a_type="", $a_obj_id="")
	get image path (may be overwritten by derived classes) More...

	getImageAlt ($a_default_text, $a_type="", $a_obj_id="")
	get image alt text More...

	getNodeStyleClass ($a_id, $a_type)
	get style class for node More...

	buildLinkTarget ($a_node_id, $a_type)
	get link target (may be overwritten by derived classes) More...

	buildOnClick ($a_node_id, $a_type, $a_title)
	get onclick event handling (may be overwritten by derived classes) More...

	buildTitle ($a_title, $a_id, $a_type)
	standard implementation for title, may be overwritten by derived classes More...

	buildDescription ($a_desc, $a_id, $a_type)
	standard implementation for description, may be overwritten by derived classes More...

	buildSelect ($a_node_id, $a_type)
	standard implementation for adding an option select box between image and title More...

	buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
	get frame target (may be overwritten by derived classes) More...

	createTarget ($a_type, $a_node_id, $a_highlighted_subtree=false, $a_append_anch=true)
	Creates Get Parameter private. More...

	setFrameTarget ($a_target)
	set target frame or not frame? More...

	createLines ($a_depth)
	Creates lines for explorer view private. More...

	is_in_array ($a_start, $a_depth)
	DESCRIPTION MISSING private. More...

	getIndex ($a_data)
	get index of format_options array from specific ref_id,parent_id private More...

	addFilter ($a_item)
	adds item to the filter public More...

	delFilter ($a_item)
	removes item from the filter public More...

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

	forceExpandAll ($a_mode, $a_show_minus=true)
	force expandAll. More...

	setFiltered ($a_bool)
	active/deactivate the filter public More...

	checkFilter ($a_item)
	check if item is in filter private More...

	sortNodes ($a_nodes, $a_parent_obj_id)
	sort nodes and put adm object to the end of sorted array private More...

Data Fields
	$root_id

	$output

	$ctrl

	$selectable_type

	$ref_id

Data Fields inherited from ilLMTOCExplorer
	$offline

Data Fields inherited from ilLMExplorer
	$root_id

	$lm_obj

	$output

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

Additional Inherited Members
Protected Member Functions inherited from ilLMExplorer
	checkLPIcon ($a_id)

Protected Attributes inherited from ilLMExplorer
	$lp_cache

Detailed Description

Public Section Explorer.

Author: Michael Jansen mjase.nosp@m.n@da.nosp@m.tabay.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilShopPublicSectionSelector::__construct	(	$a_target,
		$a_lm_obj,
		$a_gui_class
	)

Constructor public.

Parameters

string	scriptname
object	lm object
string	gui class name

Definition at line 55 of file class.ilShopPublicSectionSelector.php.

References $_GET, $ilCtrl, ilExplorer\setExpand(), ilExplorer\setExpandTarget(), and ilExplorer\setSessionExpandVariable().

         {
                 global $ilCtrl;
 
                 $this->ctrl = $ilCtrl;
                 $this->gui_class = $a_gui_class;
                 parent::ilLMTOCExplorer($a_target, $a_lm_obj);
                 $this->setSessionExpandVariable('lmshoppublicselectorexpand');
                 $this->setExpandTarget($a_target);              
                 $this->setExpand((int)$_GET['lmshoppublicselectorexpand'] ? (int)$_GET['lmshoppublicselectorexpand'] : $this->tree->readRootId());      
         }

Here is the call graph for this function:

Member Function Documentation

◆ buildFrameTarget()

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

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

         {
                 return '_top';
         }

◆ buildLinkTarget()

ilShopPublicSectionSelector::buildLinkTarget	(	$a_node_id,
		$a_type
	)

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

References ilLMTOCExplorer\offlineMode().

         {
                 if(!$this->offlineMode())
                 {
                         return parent::buildLinkTarget($a_node_id, $a_type);
                 }
                 else
                 {
                         if ($a_node_id < 1)
                         {
                                 $a_node_id = $this->tree->getRootId();
                         }
                         if ($a_type != 'pg')
                         {
                                 $a_node = $this->tree->fetchSuccessorNode($a_node_id, 'pg');
                                 $a_node_id = $a_node['child'];
                         }
                         if (!$this->lm_obj->cleanFrames())
                         {
                                 return 'frame_'.$a_node_id.'_maincontent.html';
                         }
                         else
                         {
                                 return 'lm_pg_'.$a_node_id.'.html';
                         }
                 }
         }

Here is the call graph for this function:

◆ getOutput()

ilShopPublicSectionSelector::getOutput ( )

Definition at line 128 of file class.ilShopPublicSectionSelector.php.

References $ilBench, $options, $tpl, ilExplorer\createLines(), ilExplorer\formatObject(), ilExplorer\handleListEndTags(), and ilExplorer\handleListStartTags().

         {
                 global $ilBench, $tpl;
 
                 $ilBench->start('Explorer', 'getOutput');
 
                 $this->format_options[0]['tab'] = array();
 
                 $depth = $this->tree->getMaximumDepth();
 
                 for ($i=0;$i<$depth;++$i)
                 {
                         $this->createLines($i);
                 }
                 
                 // set global body class
                 $tpl->setBodyClass("il_Explorer");
                 
                 $tpl_tree = new ilTemplate('tpl.tree_form.html', true, true, 'Modules/LearningModule');
                 
                 $cur_depth = -1;
                 foreach ($this->format_options as $key => $options)
                 {
 //echo '-'.$options['depth'].'-';
                         if (!$options['visible'])
                         {
                                 continue;
                         }
                         
                         if ($key == 0)
                         {
                                 continue;
                         }
                         
                         // end tags
                         $this->handleListEndTags($tpl_tree, $cur_depth, $options['depth']);
                         
                         // start tags
                         $this->handleListStartTags($tpl_tree, $cur_depth, $options['depth']);
                         
                         $cur_depth = $options['depth'];
                         
                         if ($options['visible'] and $key != 0)
                         {
                                 $this->formatObject($tpl_tree, $options['child'], $options, $options['obj_id']);
                         }                                                                       
                 }
                 
                 $this->handleListEndTags($tpl_tree, $cur_depth, -1);
                 
                 $ilBench->stop('Explorer', 'getOutput');
                 
                 return $tpl_tree->get();
         }

Here is the call graph for this function:

◆ isClickable()

ilShopPublicSectionSelector::isClickable	(	$a_type,
		$a_node_id
	)

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

References $ilUser, and ilLMObject\_isPagePublic().

         {
                 global $ilUser;
                 
                 if($a_type == 'st')
                 {
                         $a_node = $this->tree->fetchSuccessorNode($a_node_id, 'pg');
                         $a_node_id = $a_node['child'];
                         if ($a_node_id == 0)
                         {
                                 return false;
                         }
                 }
                 
                 if($a_type == 'pg')
                 {
                         // check public area mode
                         include_once('./Modules/LearningModule/classes/class.ilLMObject.php');
                         if ($this->lm_obj->getPublicAccessMode() == 'selected'
                                 && !ilLMObject::_isPagePublic($a_node_id))
                         {
                                 return false;
                         }
                 }
 
                 return true;
         }