ilSCORMExplorer Class Reference

Explorer View for SCORM Learning Modules. More...

Inheritance diagram for ilSCORMExplorer:

Collaboration diagram for ilSCORMExplorer:

Public Member Functions
	__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...

Data Fields
	$slm_obj
Data Fields inherited from ilExplorer
	$id
	$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

Protected Member Functions
	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
Protected Attributes inherited from ilExplorer
	$obj_definition
	$error
	$rbacsystem
	$tpl
	$lng

Detailed Description

Explorer View for SCORM Learning Modules.

Author

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

Stefan Hecken stefa.nosp@m.n.he.nosp@m.cken@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Version

$Id$

Definition at line 37 of file class.ilSCORMExplorer.php.

Constructor & Destructor Documentation

__construct()

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

Constructor public.

Parameters

string	scriptname
int	user_id

Definition at line 53 of file class.ilSCORMExplorer.php.

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

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

Here is the call graph for this function:

Member Function Documentation

createOutput()

ilSCORMExplorer::createOutput	(		$option,
			$jsApi
	)

recursive creation of output templates

Parameters

array	$option
bool	$jsApi

Returns

ilTemplate $tpl

Definition at line 208 of file class.ilSCORMExplorer.php.

References $ilBench, $key, ilExplorer\$tpl, and insertObject().

Referenced by getOutput().

    {
        global $ilBench;

        if ($option["visible"]) {
            $tpl = new ilTemplate("tpl.sahs_tree_ul.html", true, true, "Modules/ScormAicc");
            $tpl = $this->insertObject($option, $tpl, $jsApi);
        } else {
            $tpl = new ilTemplate("tpl.sahs_tree_free.html", true, true, "Modules/ScormAicc");
        }

        if (count($option["childs"])) {
            foreach ($option["childs"] as $key => $ch_option) {
                $tpl->setCurrentBlock("childs");
                $tpl->setVariable("CHILDS", $this->createOutput($ch_option, $jsApi)->get());
                $tpl->parseCurrentBlock();
            }
        }

        return $tpl;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createOutputArray()

ilSCORMExplorer::createOutputArray (   $a_parent_id,   $options = array()  )

protected

recursivi creating of outputs

Parameters

int	$a_parent_id
array	$options	existing output options

Returns

array $options

Definition at line 136 of file class.ilSCORMExplorer.php.

References $key, $options, array, and ilExplorer\showChilds().

Referenced by setOutput().

    {
        $types_do_not_display = array("sos", "sma");
        $types_do_not_load = array("srs");

        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)) {
            return array();
        }

        foreach ($this->tree->getChilds($a_parent_id, $this->order_column) as $key => $child) {
            if (in_array($child["c_type"], $types_do_not_load)) {
                continue;
            }

            $option = array();
            $option["parent"]           = $child["parent"];
            $option["id"]                       = $child["child"];
            $option["title"]            = $child["title"];
            $option["c_type"]           = $child["c_type"];
            $option["obj_id"]           = $child["obj_id"];
            $option["desc"]             = "obj_" . $child["c_type"];
            $option["container"]        = false;
            $option["visible"]          = !in_array($child["c_type"], $types_do_not_display);

            if ($this->showChilds($option["id"])) {
                $option = $this->createOutputArray($option["id"], $option, ++$depth);
            }

            $options["childs"][] = $option;
        }

        return $options;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createTarget()

ilSCORMExplorer::createTarget	(		$a_type,
			$a_child,
			$a_highlighted_subtree = false,
			$a_append_anch = true
	)

Creates Get Parameter private.

Parameters

string
integer

Returns

string

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

References $_SERVER, and $a_type.

    {
        // SET expand parameter:
        //     positive if object is expanded
        //     negative if object is compressed
        $a_child = ($a_type == '+')
            ? $a_child
            : -(int) $a_child;

        return $_SERVER["PATH_INFO"] . "?cmd=explorer&ref_id=" . $this->slm_obj->getRefId() . "&scexpand=" . $a_child;
    }

formatHeader()

ilSCORMExplorer::formatHeader	(		$tpl,
			$a_obj_id,
			$a_option
	)

overwritten method from base class public

Parameters

integer	obj_id
integer	array options

Definition at line 86 of file class.ilSCORMExplorer.php.

References ilExplorer\$lng, and ilExplorer\$tpl.

    {
        global $lng, $ilias;

        $tpl = new ilTemplate("tpl.tree.html", true, true, "Services/UIComponent/Explorer");

        $tpl->setCurrentBlock("row");
        $tpl->setVariable("TITLE", $lng->txt("cont_manifest"));
        $tpl->setVariable("LINK_TARGET", $this->target . "&" . $this->target_get . "=" . $a_obj_id);
        $tpl->setVariable("TARGET", " target=\"" . $this->frame_target . "\"");
        $tpl->parseCurrentBlock();

        $this->output[] = $tpl->get();
    }

getIconImagePathPrefix()

ilSCORMExplorer::getIconImagePathPrefix

(

)

Definition at line 69 of file class.ilSCORMExplorer.php.

Referenced by getOutputIcons().

    {
        return "scorm/";
    }

Here is the caller graph for this function:

getItem()

ilSCORMExplorer::getItem

(

$a_node_id

)

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

    {
        return new ilSCORMItem($a_node_id);
    }

getNodesToSkip()

ilSCORMExplorer::getNodesToSkip

(

)

Definition at line 74 of file class.ilSCORMExplorer.php.

    {
        return 2;
    }

getOutput()

ilSCORMExplorer::getOutput

(

$jsApi = false

)

Creates output template.

public

Returns

string

Definition at line 193 of file class.ilSCORMExplorer.php.

References ilExplorer\$output, and createOutput().

    {
        $output = $this->createOutput($this->format_options, $jsApi);

        return $output->get();
    }

Here is the call graph for this function:

getOutputIcons()

ilSCORMExplorer::getOutputIcons	(	&	$tpl,
			$a_option,
			$a_node_id,
			$scormtype = "sco"
	)

tpl is filled with option state

Parameters

ilTemplate	$tpl
array	$a_option
int	$a_node_id
string	$scormtype

Definition at line 323 of file class.ilSCORMExplorer.php.

References ilExplorer\$lng, ilExplorer\$tpl, ilSCORMItem\_lookupTrackingDataOfUser(), getIconImagePathPrefix(), and ilUtil\getImagePath().

Referenced by insertObject().

    {
        global $lng;

        $tpl->setCurrentBlock("icon");

        if ($scormtype == 'asset') {
            $tpl->setVariable('ICON_IMAGE', ilUtil::getImagePath($this->getIconImagePathPrefix() . "asset.svg"));
            $tpl->setVariable('TXT_ALT_IMG', '');
            $tpl->parseCurrentBlock();
            return;
        }

        $trdata = ilSCORMItem::_lookupTrackingDataOfUser(
                $a_node_id,
                0,
                $this->slm_obj->getId()
            );

        // status
        $status = ($trdata["cmi.core.lesson_status"] == "")
                ? "not attempted"
                : $trdata["cmi.core.lesson_status"];

        $statusChar=strtolower(substr($status, 0, 1));
        if ($statusChar=="f") {
            $status="failed";
        } elseif ($statusChar=="b") {
            $status="browsed";
        } elseif ($statusChar=="c") {
            $status="completed";
        } elseif ($statusChar=="n") {
            $status="not_attempted";
        } elseif ($statusChar=="p") {
            $status="passed";
        } elseif ($statusChar=="r") {
            $status="running";
        }
            
        $alt = $lng->txt("cont_status") . ": " .
                $lng->txt("cont_sc_stat_" . str_replace(" ", "_", $status));

        // score
        if ($trdata["cmi.core.score.raw"] != "") {
            $alt.= ", " . $lng->txt("cont_credits") .
                ": " . $trdata["cmi.core.score.raw"];
        }

        // total time
        if ($trdata["cmi.core.total_time"] != "" &&
                $trdata["cmi.core.total_time"] != "0000:00:00.00") {
            $alt.= ", " . $lng->txt("cont_total_time") .
                ": " . $trdata["cmi.core.total_time"];
        }

        $tpl->setVariable("ICON_NAME", 'scoIcon' . $a_node_id);
        $tpl->setVariable("ICON_IMAGE", ilUtil::getImagePath($this->getIconImagePathPrefix() . str_replace(" ", "_", $status) . ".svg"));
        $tpl->setVariable("TXT_ALT_IMG", $alt);
        $tpl->parseCurrentBlock();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insertObject()

ilSCORMExplorer::insertObject (   $option, ilTemplate  $tpl,   $jsApi  )

protected

insert the option data in $tpl

Parameters

array	$option
ilTemplate	$tpl
bool	$jsApi

Returns

ilTemplate $tpl

Definition at line 264 of file class.ilSCORMExplorer.php.

References ilExplorer\$tpl, ilSCORMResource\_lookupIdByIdRef(), ilSCORMResource\_lookupScormType(), ilExplorer\buildFrameTarget(), getOutputIcons(), isClickable(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilUtil\shortenText().

Referenced by createOutput().

    {
        if (!is_array($option) || !isset($option["id"])) {
            $this->ilias->raiseError(get_class($this) . "::insertObject(): Missing parameter or wrong datatype! " .
                                    "node_id: " . $a_node_id . " options:" . var_dump($a_option), $this->ilias->error_obj->WARNING);
        }

        //get scorm item
        $sc_object = new ilSCORMItem($option["id"]);
        $id_ref = $sc_object->getIdentifierRef();

        //get scorm resource ref id
        $sc_res_id = ilSCORMResource::_lookupIdByIdRef($id_ref, $sc_object->getSLMId());

        //get scorm type
        $scormtype = strtolower(ilSCORMResource::_lookupScormType($sc_res_id));

        //is scorm clickabke
        $clickable = $this->isClickable($option["c_type"], $option["id"], $sc_object);

        if ($this->output_icons && $clickable) {
            $this->getOutputIcons($tpl, $option, $option["id"], $scormtype);
        }

        if ($clickable) {       // output link
            $tpl->setCurrentBlock("link");
            $frame_target = $this->buildFrameTarget($option["c_type"], $option["id"], $option["obj_id"]);
            if ($frame_target != "") {
                $tpl->setVariable("TITLE", ilUtil::shortenText($option["title"], $this->textwidth, true));
                $tpl->setVariable("LINK_TARGET", "javascript:void(0);");
                if ($jsApi == true) {
                    $tpl->setVariable("ONCLICK", " onclick=\"parent.API.IliasLaunch('" . $option["id"] . "');return false;\"");
                } else {
                    $tpl->setVariable("ONCLICK", " onclick=\"parent.APIFRAME.setupApi();parent.APIFRAME.API."
                        . ($scormtype == 'asset' ? 'IliasLaunchAsset' : 'IliasLaunchSahs')
                        . "('" . $option["id"] . "');return false;\"");
                }
            }
            $tpl->parseCurrentBlock();
        } else {                        // output text only
            $tpl->setCurrentBlock("text");
            $tpl->setVariable("OBJ_TITLE", ilUtil::shortenText($option["title"], $this->textwidth, true));
            $tpl->parseCurrentBlock();
        }

        $tpl->setCurrentBlock("li");
        $tpl->parseCurrentBlock();

        return $tpl;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isClickable()

ilSCORMExplorer::isClickable	(		$a_type,
			$a_id = 0,
			$a_obj = 0
	)

can i click on the module name

Parameters

string	$a_type
int	$a_id
int	$a_obj

Returns

bool

Definition at line 238 of file class.ilSCORMExplorer.php.

References $a_type.

Referenced by insertObject().

    {
        if ($a_type != "sit") {
            return false;
        } else {
            if (is_object($a_obj)) {
                $sc_object = $a_obj;
            } else {
                $sc_object = new ilSCORMItem($a_id);
            }
            if ($sc_object->getIdentifierRef() != "") {
                return true;
            }
        }
        return false;
    }

Here is the caller graph for this function:

isVisible()

ilSCORMExplorer::isVisible	(		$a_id,
			$a_type
	)

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

References $a_type.

    {
        if ($a_type == "sre") {
            return false;
        } else {
            return true;
        }
    }

setOutput()

ilSCORMExplorer::setOutput	(		$parent_id,
			$a_depth = 1,
			$a_obj_id = 0,
			$a_highlighted_subtree = false
	)

possible output array is set

Parameters

int

$parent_id

Definition at line 124 of file class.ilSCORMExplorer.php.

References createOutputArray().

    {
        $this->format_options = $this->createOutputArray($parent_id);
    }

Here is the call graph for this function:

Field Documentation

$slm_obj

ilSCORMExplorer::$slm_obj

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

---

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

• Modules/ScormAicc/classes/SCORM/class.ilSCORMExplorer.php