ilSCORMExplorer Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilSCORMExplorer:

Collaboration diagram for ilSCORMExplorer:

Public Member Functions
	__construct (string $a_target, ilObjSCORMLearningModule &$a_slm_obj)
	getItem (int $a_node_id)
	getIconImagePathPrefix ()
	getNodesToSkip ()
	formatHeader (ilTemplate $tpl, $a_obj_id, array $a_option)
	overwritten method from base class More...
	createTarget (string $a_type, $a_node_id, bool $a_highlighted_subtree=false, bool $a_append_anch=true)
	Creates Get Parameter. More...
	setOutput ($a_parent_id, int $a_depth=1, int $a_obj_id=0, $a_highlighted_subtree=false)
	isVisible ($a_ref_id, string $a_type)
	getOutput (bool $jsApi=false)
	Creates output template. More...
	createOutput (array $option, bool $jsApi)
	recursive creation of output templates More...
	isClickable (string $type, int $ref_id=0)
	can i click on the module name More...
	getOutputIcons (\ilTemplate $tpl, array $a_option, int $a_node_id, string $scormtype="sco")
	tpl is filled with option state More...
Public Member Functions inherited from ilExplorer
	setId (string $a_val)
	getId ()
	setAsynchExpanding (bool $a_val)
	getAsynchExpanding ()
	initItemCounter (int $a_number)
	setTitle (string $a_val)
	setTitleLength (int $a_length)
	getTitleLength ()
	getTitle ()
	setRoot ($a_root_id)
	getRoot ()
	setOrderColumn (string $a_column)
	setOrderDirection (string $a_direction)
	setTargetGet (string $a_target_get)
	setParamsGet (array $a_params_get)
	setExpandTarget (string $a_exp_target)
	target script for expand icons More...
	setFrameUpdater (string $a_up_frame, string $a_up_script, string $a_params="")
	highlightNode (string $a_id)
	checkPermissions (bool $a_check)
	setSessionExpandVariable (string $a_var_name="expand")
	outputIcons (bool $a_icons)
	setClickable (string $a_type, bool $a_clickable)
	isVisible ( $a_ref_id, string $a_type)
	setTreeLead (string $a_val)
	getTreeLead ()
	isClickable (string $type, int $ref_id=0)
	setPostSort (bool $a_sort)
	setFilterMode (int $a_mode=IL_FM_NEGATIVE)
	getFilterMode ()
	setUseStandardFrame (bool $a_val)
	Set use standard frame. More...
	getUseStandardFrame ()
	getChildsOfNode ($a_parent_id)
	setOutput ( $a_parent_id, int $a_depth=1, int $a_obj_id=0, bool $a_highlighted_subtree=false)
	Creates output for explorer view in admin menue recursive method. More...
	modifyChilds ( $a_parent_id, array $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 ()
	getOutput ()
	handleListEndTags (ilTemplate $a_tpl_tree, int $a_cur_depth, int $a_item_depth)
	handle list end tags ( and ) More...
	handleListStartTags (ilTemplate $a_tpl_tree, int $a_cur_depth, int $a_item_depth)
	handle list start tags ( More...
	formatHeader (ilTemplate $tpl, $a_obj_id, array $a_option)
	formatObject (ilTemplate $tpl, $a_node_id, array $a_option, $a_obj_id=0)
	getImage (string $a_name, string $a_type="", $a_obj_id="")
	getImageAlt (string $a_default_text, string $a_type="", $a_obj_id="")
	getNodeStyleClass ( $a_id, string $a_type)
	buildLinkTarget ( $a_node_id, string $a_type)
	buildOnClick ( $a_node_id, string $a_type, string $a_title)
	buildTitle (string $a_title, $a_id, string $a_type)
	buildDescription (string $a_desc, $a_id, string $a_type)
	buildSelect ($a_node_id, string $a_type)
	standard implementation for adding an option select box between image and title More...
	buildFrameTarget (string $a_type, $a_child=0, $a_obj_id=0)
	createTarget (string $a_type, $a_node_id, bool $a_highlighted_subtree=false, bool $a_append_anch=true)
	setFrameTarget (string $a_target)
	createLines (int $a_depth)
	is_in_array (int $a_start, int $a_depth)
	getIndex (array $a_data)
	addFilter (string $a_item)
	delFilter (string $a_item)
	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,...) More...
	forceExpandAll (bool $a_mode, bool $a_show_minus=true)
	force expandAll. More...
	setFiltered (bool $a_bool)
	checkFilter (string $a_item)
	sortNodes (array $a_nodes, $a_parent_obj_id)
	sort nodes and put adm object to the end of sorted array More...

Data Fields
ilObjSCORMLearningModule	$slm_obj
	id of root folder More...
Data Fields inherited from ilExplorer
string	$id = ""
string	$output = ""
array	$format_options = []
ilTree	$tree
string	$target = ""
string	$target_get = ""
string	$params_get = ""
array	$expanded = []
string	$order_column = ""
string	$order_direction = "asc"
string	$expand_target = null
bool	$rbac_check = false
bool	$output_icons = false
string	$expand_variable = ""
array	$is_clickable = []
bool	$post_sort = false
bool	$filtered = false
bool	$filter_mode
bool	$expand_all = false
	$root_id = null
bool	$use_standard_frame = false

Protected Member Functions
	createOutputArray (int $a_parent_id, array $options=array())
	recursive creating of outputs More...
	insertObject (array $option, ilTemplate $tpl, bool $jsApi)
	insert the option data in $tpl More...
Protected Member Functions inherited from ilExplorer
	requestStr (string $key)

Additional Inherited Members
Protected Attributes inherited from ilExplorer
ilObjectDefinition	$obj_definition
ilErrorHandling	$error
ilRbacSystem	$rbacsystem
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
	$filter = []
string	$highlighted = ""
bool	$show_minus = true
int	$counter = 0
bool	$asnch_expanding = false
int	$textwidth = 0
string	$title = ""
string	$up_frame = ""
string	$a_up_script = ""
string	$up_params = ""
string	$frame_target = ""
string	$up_script = ""
string	$tree_lead = ""
array	$iconList = []
ILIAS Refinery Factory	$refinery
ILIAS HTTP Wrapper WrapperFactory	$wrapper

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

Constructor & Destructor Documentation

__construct()

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

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

References ILIAS\MetaData\Repository\Validation\Data\__construct(), ilExplorer\checkPermissions(), ilObject\getId(), 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	(	array	$option,
		bool	$jsApi
	)

recursive creation of output templates

Exceptions

ilTemplateException

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

References $DIC, ILIAS\LTI\ToolProvider\$key, ilExplorer\$tpl, insertObject(), ilGlobalTemplateInterface\parseCurrentBlock(), ilGlobalTemplateInterface\setCurrentBlock(), and ilGlobalTemplateInterface\setVariable().

Referenced by getOutput().

                                                            : \ilTemplate
    {
        global $DIC;
        $ilBench = $DIC['ilBench'];

        if (isset($option["visible"]) && $option["visible"] == true) {
            $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 (isset($option["childs"]) && is_array($option["childs"]) && count($option["childs"]) > 0) {
            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 ( int  $a_parent_id, array  $options = array()  )

protected

recursive creating of outputs

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

References $ilErr, ILIAS\LTI\ToolProvider\$key, and ilExplorer\showChilds().

Referenced by setOutput().

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

        if (!isset($a_parent_id)) {
            $ilErr->raiseError(get_class($this) . "::setOutput(): No node_id given!", $ilErr->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((int) $option["id"], $option);
            }

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

        return $options;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createTarget()

ilSCORMExplorer::createTarget	(	string	$a_type,
			$a_node_id,
		bool	$a_highlighted_subtree = false,
		bool	$a_append_anch = true
	)

Creates Get Parameter.

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

References $_SERVER.

                                                                                                                             : string //Missing typehint because ilExplorer
    {
        // SET expand parameter:
        //     positive if object is expanded
        //     negative if object is compressed
        $a_node_id = ($a_type == '+')
            ? $a_node_id
            : -(int) $a_node_id;

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

formatHeader()

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

overwritten method from base class

Exceptions

ilTemplateException

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

References $DIC, ilExplorer\$lng, ilTemplate\get(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilLanguage\txt().

                                                                             : void //Missing typehint because ilExplorer
    {
        global $DIC;
        $lng = $DIC->language();

        $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();
    }

Here is the call graph for this function:

getIconImagePathPrefix()

ilSCORMExplorer::getIconImagePathPrefix

(

)

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

Referenced by getOutputIcons().

                                            : string
    {
        return "scorm/";
    }

Here is the caller graph for this function:

getItem()

ilSCORMExplorer::getItem

(

int

$a_node_id

)

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

                                           : \ilSCORMItem
    {
        return new ilSCORMItem($a_node_id);
    }

getNodesToSkip()

ilSCORMExplorer::getNodesToSkip

(

)

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

                                    : int
    {
        return 2;
    }

getOutput()

ilSCORMExplorer::getOutput

(

bool

$jsApi = false

)

Creates output template.

Exceptions

ilTemplateException

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

References createOutput().

                                                  : string
    {
        return $this->createOutput($this->format_options, $jsApi)->get();
    }

Here is the call graph for this function:

getOutputIcons()

ilSCORMExplorer::getOutputIcons	(	\ilTemplate	$tpl,
		array	$a_option,
		int	$a_node_id,
		string	$scormtype = "sco"
	)

tpl is filled with option state

Exceptions

ilTemplateException

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

References $DIC, ilExplorer\$lng, ilSCORMItem\_lookupTrackingDataOfUser(), getIconImagePathPrefix(), ilUtil\getImagePath(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilLanguage\txt().

Referenced by insertObject().

                                                                                                                : void
    {
        global $DIC;
        $lng = $DIC->language();

        $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 = !isset($trdata["cmi.core.lesson_status"])
                ? "not attempted"
                : $trdata["cmi.core.lesson_status"];

        $statusChar = strtolower($status[0]);
        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 (isset($trdata["cmi.core.score.raw"])) {
            $alt .= ", " . $lng->txt("cont_credits") .
                ": " . $trdata["cmi.core.score.raw"];
        }

        // total time
        if (isset($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 ( array  $option, ilTemplate  $tpl, bool  $jsApi  )

protected

insert the option data in $tpl

Exceptions

ilTemplateException

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

References ilExplorer\$frame_target, $ilErr, ilExplorer\$tpl, ilSCORMResource\_lookupIdByIdRef(), ilSCORMResource\_lookupScormType(), ilExplorer\buildFrameTarget(), getOutputIcons(), isClickable(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilStr\shortenTextExtended().

Referenced by createOutput().

                                                                                : \ilTemplate
    {
        global $ilErr;
        if (!is_array($option) || !isset($option["id"])) {
            $ilErr->raiseError(get_class($this) . "::insertObject(): Missing parameter or wrong datatype! " .
                                    "options:" . var_dump($option), $ilErr->error_obj->WARNING);
        }
        $clickable = false;
        if ($option["c_type"] == "sit") {
            //get scorm item
            $sc_object = new ilSCORMItem((int) $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"], (int) $option["id"]);

            if ($this->output_icons && $clickable) {
                $this->getOutputIcons($tpl, $option, (int) $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", ilStr::shortenTextExtended($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", ilStr::shortenTextExtended($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	(	string	$type,
		int	$ref_id = 0
	)

can i click on the module name

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

References $ref_id.

Referenced by insertObject().

                                                              : bool
    {
        if ($type !== "sit") {
            return false;
        }

        $sc_object = new ilSCORMItem($ref_id);
        return $sc_object->getIdentifierRef() != "";
    }

Here is the caller graph for this function:

isVisible()

ilSCORMExplorer::isVisible	(		$a_ref_id,
		string	$a_type
	)

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

                                                        : bool //Typehint not possible now - see ilExplorer
    {
        return $a_type !== "sre";
    }

setOutput()

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

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

References createOutputArray().

                                                                                                                : void
    //    public function setOutput(int $a_parent_id, int $a_depth = 1, int $a_obj_id = 0, bool $a_highlighted_subtree = false) : void
    {
        $this->format_options = $this->createOutputArray($a_parent_id);
    }

Here is the call graph for this function:

Field Documentation

$slm_obj

ilObjSCORMLearningModule ilSCORMExplorer::$slm_obj

id of root folder

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

---

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

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