ilAICCExplorer Class Reference

Inheritance diagram for ilAICCExplorer:

Collaboration diagram for ilAICCExplorer:

Public Member Functions
	ilAICCExplorer ($a_target, &$a_slm_obj)
	Constructor public.
	getItem ($a_node_id)
	getIconImagePathPrefix ()
	getNodesToSkip ()
	isClickable ($a_type, $a_id=0)
	check if links for certain object type are activated
	formatItemTable (&$tpl, $a_id, $a_type)
	formatObject ($a_node_id, $a_option)
	Creates output recursive method private.
Public Member Functions inherited from ilSCORMExplorer
	ilSCORMExplorer ($a_target, &$a_slm_obj)
	Constructor public.
	formatHeader ($a_obj_id, $a_option)
	overwritten method from base class public
	createTarget ($a_type, $a_child)
	Creates Get Parameter private.
	setOutput ($a_parent_id, $a_depth=0)
	isVisible ($a_id, $a_type)
	getOutput ()
	Creates output recursive method public.
	isClickable ($a_type, $a_id=0, $a_obj=0)
	getOutputIcons (&$tpl, $a_option, $a_node_id, $scormtype="sco")
Public Member Functions inherited from ilExplorer
	ilExplorer ($a_target)
	Constructor public.
	initItemCounter ($a_number)
	Init item counter.
	setTitle ($a_val)
	Set title.
	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
	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.
	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.
	forceExpanded ($a_obj_id)
	force expansion of node
	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 (
	formatHeader (&$tpl, $a_obj_id, $a_option)
	Creates output for header (is empty here but can be overwritten in derived classes)
	formatObject (&$tpl, $a_node_id, $a_option, $a_obj_id=0)
	Creates output recursive method private.
	getImage ($a_name, $a_type="", $a_obj_id="")
	get image path (may be overwritten by derived classes)
	getImageAlt ($a_default_text, $a_type="", $a_obj_id="")
	get image alt text
	getNodeStyleClass ($a_id, $a_type)
	get style class for node
	buildLinkTarget ($a_node_id, $a_type)
	get link target (may be overwritten by derived classes)
	buildOnClick ($a_node_id, $a_type, $a_title)
	get onclick event handling (may be overwritten by derived classes)
	buildTitle ($a_title, $a_id, $a_type)
	standard implementation for title, 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
	buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
	get frame target (may be overwritten by derived classes)
	createTarget ($a_type, $a_node_id, $a_highlighted_subtree=false)
	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
	sortNodes ($a_nodes, $a_parent_obj_id)
	sort nodes and put adm object to the end of sorted array private

Additional Inherited Members
Data Fields inherited from ilSCORMExplorer
	$slm_obj

Detailed Description

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

Member Function Documentation

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

Reimplemented from ilSCORMExplorer.

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

References $lng.

Referenced by ilHACPExplorer\formatObject(), and formatObject().

        {
                global $lng;
/*
                if ($a_type != "sau")
                {
                        return;
                }
                else
                {
                        $sc_object =& new ilAICCUnit($a_id);
                        //if ($sc_object->getIdentifierRef() != "")
                        //{
                                $trdata = $sc_object->getTrackingDataOfUser();

                                // status
                                $status = ($trdata["lesson_status"] == "")
                                        ? "not attempted"
                                        : $trdata["lesson_status"];
                                $tpl->setCurrentBlock("item_row");
                                $tpl->setVariable("TXT_KEY", $lng->txt("cont_status"));
                                $tpl->setVariable("TXT_VALUE",
                                        $lng->txt("cont_sc_stat_".str_replace(" ", "_", $status)));
                                $tpl->parseCurrentBlock();

                                // credits
                                if ($trdata["mastery_score"] != "")
                                {
                                        $tpl->setCurrentBlock("item_row");
                                        $tpl->setVariable("TXT_KEY", $lng->txt("cont_credits"));
                                        $tpl->setVariable("TXT_VALUE", $trdata["mastery_score"]);
                                        $tpl->parseCurrentBlock();
                                }

                                // total time
                                if ($trdata["total_time"] != "")
                                {
                                        $tpl->setCurrentBlock("item_row");
                                        $tpl->setVariable("TXT_KEY", $lng->txt("cont_total_time"));
                                        $tpl->setVariable("TXT_VALUE", $trdata["total_time"]);
                                        $tpl->parseCurrentBlock();
                                }

                                $tpl->setCurrentBlock("item_table");
                                $tpl->parseCurrentBlock();
                        //}
                }
*/              
        }

Here is the caller graph for this function:

ilAICCExplorer::formatObject	(		$a_node_id,
			$a_option
	)

Creates output recursive method private.

Parameters

integer
array

Returns

string

Reimplemented from ilSCORMExplorer.

Reimplemented in ilHACPExplorer.

Definition at line 150 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.gif"));
                                        $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.gif"));
                                        $tpl->parseCurrentBlock();
                                        $pic = true;
                                }

                                if (!$pic)
                                {
                                        $picture = 'blank';
                                        $tpl->setCurrentBlock("lines");
                                        $tpl->setVariable("IMGPATH_LINES", ilUtil::getImagePath("browser/".$picture.".gif"));
                                        $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");
                        //$target = (strpos($this->target, "?") === false) ?
                        //      $this->target."?" : $this->target."&";
                        //$tpl->setVariable("LINK_TARGET", $target.$this->target_get."=".$a_node_id.$this->params_get);
                        //$tpl->setVariable("TITLE", ilUtil::shortenText($a_option["title"], $this->textwidth, true));
                        $frame_target = $this->buildFrameTarget($a_option["c_type"], $a_node_id, $a_option["obj_id"]);
                        if ($frame_target != "")
                        {
//                              if ($this->api == 1)
//                              {
//                                      $tpl->setVariable("TITLE", ilUtil::shortenText($a_option["title"], $this->textwidth, true));
//                                      $tpl->setVariable("TARGET", " target=\"".$frame_target."\"");
//                                      //$tpl->setVariable("LINK_TARGET", $this->buildLinkTarget($a_node_id, $a_option["c_type"]));
//                                      $tpl->setVariable("LINK_TARGET", $this->buildLinkTarget($a_node_id, $a_option["c_type"]));
//                              }
//                              else
//                              {
                                        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:

ilAICCExplorer::getIconImagePathPrefix

(

)

Reimplemented from ilSCORMExplorer.

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

                                          {
                return "scorm/";
        }

ilAICCExplorer::getItem

(

$a_node_id

)

Reimplemented from ilSCORMExplorer.

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

                                     {
                return new ilAICCUnit($a_node_id);
        }

ilAICCExplorer::getNodesToSkip

(

)

Reimplemented from ilSCORMExplorer.

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

                                  {
                return 1;
        }

ilAICCExplorer::ilAICCExplorer	(		$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\ilExplorer(), ilExplorer\outputIcons(), ilTree\readRootId(), and ilExplorer\setOrderColumn().

        {
                parent::ilExplorer($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:

ilAICCExplorer::isClickable	(		$a_type,
			$a_ref_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 68 of file class.ilAICCExplorer.php.

Referenced by ilHACPExplorer\formatObject(), and 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);
                        //if ($sc_object->getIdentifierRef() != "")
                        //{
                                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