Explorer View for AICC Learning Modules. More...

Inheritance diagram for ilAICCExplorer:

Collaboration diagram for ilAICCExplorer:

Public Member Functions
	__construct ($a_target, &$a_slm_obj)
	Constructor public. More...

	getItem ($a_node_id)

	getIconImagePathPrefix ()

	getNodesToSkip ()

	isClickable ($a_type, $a_id=0)

	formatItemTable (&$tpl, $a_id, $a_type)

	formatObject ($a_node_id, $a_option)
	Creates output recursive method private. More...

	setOutput ($a_parent_id, $a_depth=0)

Public Member Functions inherited from ilSCORMExplorer
	__construct ($a_target, &$a_slm_obj)
	Constructor public. More...

	getItem ($a_node_id)

	getIconImagePathPrefix ()

	getNodesToSkip ()

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

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

	setOutput ($parent_id, $a_depth=1, $a_obj_id=0, $a_highlighted_subtree=false)
	possible output array is set More...

	isVisible ($a_id, $a_type)

	getOutput ($jsApi=false)
	Creates output template. More...

	createOutput ($option, $jsApi)
	recursive creation of output templates More...

	isClickable ($a_type, $a_id=0, $a_obj=0)
	can i click on the module name More...

	getOutputIcons (&$tpl, $a_option, $a_node_id, $scormtype="sco")
	tpl is filled with option state More...

Public Member Functions inherited from ilExplorer
	__construct ($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...

Protected Member Functions
	createPrefixArray ($counter, $tab)

	addObjectToOutputArray ($counter, $tab, $object)

	makeObjectNodeExpandable ($c_type, $obj_id)

	getParentIndex ($child)

	setParentExpanded ($parent)

	shouldHideCurrentNode ($child, $parent_index, $parent)

Protected Member Functions inherited from ilSCORMExplorer
	createOutputArray ($a_parent_id, $options=array())
	recursivi creating of outputs More...

	insertObject ($option, ilTemplate $tpl, $jsApi)
	insert the option data in $tpl More...

Additional Inherited Members
Data Fields inherited from ilSCORMExplorer
	$slm_obj

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

Explorer View for AICC Learning Modules.

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilAICCExplorer::__construct	(		$a_target,
		&	$a_slm_obj
	)

Constructor public.

Parameters

string	scriptname
int	user_id

Definition at line 45 of file class.ilAICCExplorer.php.

References ilExplorer\checkPermissions(), ilExplorer\outputIcons(), ilTree\readRootId(), and ilExplorer\setOrderColumn().

         {
                 parent::__construct($a_target);
                 $this->slm_obj = $a_slm_obj;
                 $this->tree = new ilAICCTree($a_slm_obj->getId());
                 $this->root_id = $this->tree->readRootId();
                 $this->checkPermissions(false);
                 $this->outputIcons(false);
                 $this->setOrderColumn("");
         }

Here is the call graph for this function:

Member Function Documentation

◆ addObjectToOutputArray()

ilAICCExplorer::addObjectToOutputArray	(	$counter,
		$tab,
		$object
	)

protected

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

References $tab.

Referenced by setOutput().

                                                                            {
                 $this->format_options["$counter"]["parent"]             = $object["parent"];
                 $this->format_options["$counter"]["child"]              = $object["child"];
                 $this->format_options["$counter"]["title"]              = $object["title"];
                 $this->format_options["$counter"]["c_type"]             = $object["c_type"];
                 $this->format_options["$counter"]["obj_id"]             = $object["obj_id"];
                 $this->format_options["$counter"]["desc"]               = "obj_".$object["c_type"];
                 $this->format_options["$counter"]["depth"]              = $tab;
                 $this->format_options["$counter"]["container"]  = false;
                 $this->format_options["$counter"]["visible"]    = true;
         }

Here is the caller graph for this function:

◆ createPrefixArray()

ilAICCExplorer::createPrefixArray	(	$counter,
		$tab
	)

protected

Definition at line 257 of file class.ilAICCExplorer.php.

References $tab.

Referenced by setOutput().

                                                              {
                 for ($i = 0; $i < $tab; ++$i) {
                          $this->format_options["$counter"]["tab"][] = 'blank';
                 }
         }

Here is the caller graph for this function:

◆ formatItemTable()

ilAICCExplorer::formatItemTable	(	&	$tpl,
			$a_id,
			$a_type
	)

Definition at line 87 of file class.ilAICCExplorer.php.

References $lng.

Referenced by formatObject().

         {
                 global $lng;
         }

Here is the caller graph for this function:

◆ formatObject()

ilAICCExplorer::formatObject	(	$a_node_id,
		$a_option
	)

Creates output recursive method private.

Parameters

integer
array

Returns: string

Definition at line 102 of file class.ilAICCExplorer.php.

References $lng, ilExplorer\$target, $tpl, ilExplorer\buildFrameTarget(), ilExplorer\buildLinkTarget(), ilSCORMExplorer\createTarget(), formatItemTable(), ilUtil\getImagePath(), ilSCORMExplorer\getOutputIcons(), isClickable(), and ilUtil\shortenText().

         {
                 global $lng;
 
                 if (!isset($a_node_id) or !is_array($a_option))
                 {
                         $this->ilias->raiseError(get_class($this)."::formatObject(): Missing parameter or wrong datatype! ".
                                                                         "node_id: ".$a_node_id." options:".var_dump($a_option),$this->ilias->error_obj->WARNING);
                 }
 
                 $tpl = new ilTemplate("tpl.sahs_tree.html", true, true, "Modules/ScormAicc");
 
                 if ($a_option["c_type"]=="sos")
                         return;
 
                 if ($a_option["c_type"]=="srs")
                         return;
 
                 if (is_array($a_option["tab"])) { //test if there are any tabs
                         foreach ($a_option["tab"] as $picture)
                         {
                                 $pic = false;
                                 if ($picture == 'plus')
                                 {
                                         $target = $this->createTarget('+',$a_node_id);
                                         $tpl->setCurrentBlock("expander");
                                         $tpl->setVariable("LINK_TARGET_EXPANDER", $target);
                                         $tpl->setVariable("IMGPATH", ilUtil::getImagePath("browser/plus.png"));
                                         $tpl->parseCurrentBlock();
                                         $pic = true;
                                 }
 
                                 if ($picture == 'minus' && $this->show_minus)
                                 {
                                         $target = $this->createTarget('-',$a_node_id);
                                         $tpl->setCurrentBlock("expander");
                                         $tpl->setVariable("LINK_TARGET_EXPANDER", $target);
                                         $tpl->setVariable("IMGPATH", ilUtil::getImagePath("browser/minus.png"));
                                         $tpl->parseCurrentBlock();
                                         $pic = true;
                                 }
 
                                 if (!$pic)
                                 {
                                         $picture = 'blank';
                                         $tpl->setCurrentBlock("lines");
                                         $tpl->setVariable("IMGPATH_LINES", ilUtil::getImagePath("browser/".$picture.".png"));
                                         $tpl->parseCurrentBlock();
                                 }
                         }
                 }
 
                 if ($this->output_icons) {
                         if ($this->isClickable($a_option["c_type"], $a_node_id) && !$a_option["c_type"]=="sbl")
                                 $this->getOutputIcons($tpl, $a_option, $a_node_id);
                 }
 
                 if ($this->isClickable($a_option["c_type"], $a_node_id))        // output link
                 {
                         $tpl->setCurrentBlock("link");
 
                         $frame_target = $this->buildFrameTarget($a_option["c_type"], $a_node_id, $a_option["obj_id"]);
                         if ($frame_target != "")
                         {
                                 if ($a_option["c_type"]=="sbl") {
                                         $tpl->setVariable("TITLE", ilUtil::shortenText($a_option["title"]." ($a_node_id)", $this->textwidth, true));
                                         $tpl->setVariable("TARGET", " target=\"".$frame_target."\"");
                                         $tpl->setVariable("LINK_TARGET", $this->buildLinkTarget($a_node_id, $a_option["c_type"]));
                                 } else {
                                         $tpl->setVariable("TITLE", ilUtil::shortenText($a_option["title"]." ($a_node_id)", $this->textwidth, true));
                                         $tpl->setVariable("LINK_TARGET", "javascript:void(0);");
                                         $tpl->setVariable("ONCLICK", " onclick=\"parent.APIFRAME.setupApi();parent.APIFRAME.API.IliasLaunchSahs('".$a_node_id."');return false;\"");
                                 }
                         }
                         $tpl->parseCurrentBlock();
                 }
                 else // output text only
                 {
                         $tpl->setCurrentBlock("text");
                         $tpl->setVariable("OBJ_TITLE", ilUtil::shortenText($a_option["title"], $this->textwidth, true));
                         $tpl->parseCurrentBlock();
                 }
                 $this->formatItemTable($tpl, $a_node_id, $a_option["c_type"]);
 
                 $tpl->setCurrentBlock("row");
                 $tpl->parseCurrentBlock();
 
                 $this->output[] = $tpl->get();
         }

Here is the call graph for this function:

◆ getIconImagePathPrefix()

ilAICCExplorer::getIconImagePathPrefix ( )

Definition at line 60 of file class.ilAICCExplorer.php.

                                           {
                 return "scorm/";
         }

◆ getItem()

ilAICCExplorer::getItem ( $a_node_id )

Definition at line 56 of file class.ilAICCExplorer.php.

                                      {
                 return new ilAICCUnit($a_node_id);
         }

◆ getNodesToSkip()

ilAICCExplorer::getNodesToSkip ( )

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

Referenced by setOutput().

                                   {
                 return 1;
         }

Here is the caller graph for this function:

◆ getParentIndex()

ilAICCExplorer::getParentIndex ( $child )

protected

Definition at line 281 of file class.ilAICCExplorer.php.

References ilExplorer\getIndex().

Referenced by setOutput().

                                                   {
                 if ($child != $this->tree->getRootId()) {
                         return $this->getIndex($object);
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isClickable()

ilAICCExplorer::isClickable	(	$a_type,
		$a_id = `0`
	)

Definition at line 68 of file class.ilAICCExplorer.php.

References $a_type.

Referenced by formatObject().

         {
                 if ($a_type=="sbl") {
                         $block_object = new ilAICCBlock($a_id);
                         return (strlen($block_object->getDescription())>0);
                 }
                 
                 if ($a_type != "sau")
                 {
                         return false;
                 }
                 else
                 {
                         $sc_object = new ilAICCUnit($a_id);
                         return true;
                 }
                 return false;
         }

Here is the caller graph for this function:

◆ makeObjectNodeExpandable()

ilAICCExplorer::makeObjectNodeExpandable	(	$c_type,
		$obj_id
	)

protected

Definition at line 275 of file class.ilAICCExplorer.php.

References ilExplorer\setExpand().

Referenced by setOutput().

                                                                       {
                 if ($c_type =="sos") {
                         $this->setExpand($obj_id);
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOutput()

ilAICCExplorer::setOutput	(	$a_parent_id,
		$a_depth = `0`
	)

Definition at line 192 of file class.ilAICCExplorer.php.

References $counter, $tab, addObjectToOutputArray(), array, ilExplorer\checkFilter(), createPrefixArray(), getNodesToSkip(), getParentIndex(), ilSCORMExplorer\isVisible(), makeObjectNodeExpandable(), setParentExpanded(), shouldHideCurrentNode(), and ilExplorer\showChilds().

         {
                 global $rbacadmin, $rbacsystem;
                 static $counter = 0;
 
                 if (!isset($a_parent_id))
                 {
                         $this->ilias->raiseError(get_class($this)."::setOutput(): No node_id given!",$this->ilias->error_obj->WARNING);
                 }
                 if ($this->showChilds($a_parent_id))
                 {
                         $objects = $this->tree->getChilds($a_parent_id, $this->order_column);
                 }
                 else
                 {
                         $objects = array();
                 }
                 if (count($objects) > 0)
                 {
 
                         //moved the scorm-only constant parameter to a function
                         //to be able to reuse the code
                         //$tab = ++$a_depth - 2;
                         $tab = ++$a_depth - $this->getNodesToSkip();
 
                         foreach ($objects as $key => $object) {
                                 //ask for FILTER
                                 if ($this->filtered == false or $this->checkFilter($object["c_type"]) == false) {
                                         if ($this->isVisible($object["obj_id"], $object["c_type"])) {
                                                 $this->addObjectToOutputArray($counter, $tab, $object);
 
                                                 $this->createPrefixArray($counter, $tab);
 
                                                 $this->makeObjectNodeExpandable($object["c_type"], $object["obj_id"]);
 
                                                 $parent_index = $this->getParentIndex($object["child"]);
 
                                                 if ($parent_index == 0) {
                                                         $this->setParentExpanded($object["parent"]);
                                                 }
 
                                                 $this->format_options["$counter"]["visible"] = !$this->shouldHideCurrentNode($object["child"], $parent_index, $object["parent"]);
 
                                                 // if object exists parent is container
                                                 if ($object["child"] != $this->tree->getRootId()) {
                                                         $this->format_options["$parent_index"]["container"] = true;
 
                                                         if ($this->expand_all or in_array($object["parent"],$this->expanded)) {
                                                                 $this->format_options["$parent_index"]["tab"][($tab-2)] = 'minus';
                                                         } else {
                                                                 $this->format_options["$parent_index"]["tab"][($tab-2)] = 'plus';
                                                         }
                                                 }
                                                 ++$counter;
                                                 // stop recursion if 2. level beyond expanded nodes is reached
                                                 if ($this->expand_all or in_array($object["parent"],$this->expanded) or ($object["parent"] == 0)) {
                                                         // recursive
                                                         $this->setOutput($object["child"],$a_depth);
                                                 }
                                         } //if
                                 } //if FILTER
                         } //foreach
                 } //if
         } //function

Here is the call graph for this function:

◆ setParentExpanded()

ilAICCExplorer::setParentExpanded ( $parent )

protected

Definition at line 287 of file class.ilAICCExplorer.php.

Referenced by setOutput().

                                                       {
                 if (!$this->expand_all && !in_array($parent, $this->expanded)) {
                         $this->expanded[] = $parent;
                 }
         }

Here is the caller graph for this function:

◆ shouldHideCurrentNode()

ilAICCExplorer::shouldHideCurrentNode	(	$child,
		$parent_index,
		$parent
	)

protected

Definition at line 293 of file class.ilAICCExplorer.php.

Referenced by setOutput().

                                                                                  {
                 if ($child != $this->tree->getRootId() 
                                 && (!$this->expand_all and !in_array($parent, $this->expanded)
                                         or !$this->format_options["$parent_index"]["visible"])) 
                 {
                         return true;
                 }
 
                 return false;
         }

Here is the caller graph for this function:

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

Modules/ScormAicc/classes/AICC/class.ilAICCExplorer.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addObjectToOutputArray()

◆ createPrefixArray()

◆ formatItemTable()

◆ formatObject()

◆ getIconImagePathPrefix()

◆ getItem()

◆ getNodesToSkip()

◆ getParentIndex()

◆ isClickable()

◆ makeObjectNodeExpandable()

◆ setOutput()

◆ setParentExpanded()

◆ shouldHideCurrentNode()