ilSCORMPresentationGUI Class Reference

Class ilSCORMPresentationGUI. More...

Collaboration diagram for ilSCORMPresentationGUI:

Public Member Functions
	__construct ()
	executeCommand ()
	execute command More...
	attrib2arr (&$a_attributes)
	frameset ()
	Output main frameset. More...
	get_max_attempts ()
	Get max. More...
	get_actual_attempts ()
	Get number of actual attempts for the user. More...
	increase_attemptAndsave_module_version ()
	Increases attempts by one for this package. More...
	explorer ($a_target="sahs_content")
	save the active module version to scorm_tracking More...
	view ()
	SCORM content screen. More...
	contentSelect ()
	apiInitData ()
	SCORM Data for Javascript-API. More...
	api ()
	launchSahs ()
	This function is called by the API applet in the content frame when a SCO is started. More...
	finishSahs ()
	unloadSahs ()
	launchAsset ()
	pingSession ()
	logMessage ()
	logWarning ()
	setSingleVariable ($a_var, $a_value)
	set single value More...
	setArray ($a_left, $a_value, $a_name, &$v_array)
	set single value More...
	downloadCertificate ()
	Download the certificate for the active user. More...

Data Fields
	$ilias
	$slm
	$tpl
	$lng

Detailed Description

Class ilSCORMPresentationGUI.

GUI class for scorm learning module presentation

Author

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

Version

$Id$

Definition at line 18 of file class.ilSCORMPresentationGUI.php.

Constructor & Destructor Documentation

__construct()

ilSCORMPresentationGUI::__construct

(

)

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

References $_GET, $DIC, $ilias, $lng, and $tpl.

    {
        global $DIC;
        $ilias = $DIC['ilias'];
        $tpl = $DIC['tpl'];
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];

        $this->ilias = $ilias;
        $this->tpl = $tpl;
        $this->lng = $lng;
        $this->ctrl = $ilCtrl;

        $this->lng->loadLanguageModule('cert');

        // Todo: check lm id
        $this->slm = new ilObjSCORMLearningModule($_GET["ref_id"], true);
    }

Member Function Documentation

api()

ilSCORMPresentationGUI::api

(

)

Definition at line 476 of file class.ilSCORMPresentationGUI.php.

References $_GET, $_SERVER, $DIC, $ilias, ilSCORMResource\_lookupIdByIdRef(), ilSCORMResource\_lookupScormType(), and exit.

    {
        global $DIC;
        $ilias = $DIC['ilias'];

        $slm_obj = new ilObjSCORMLearningModule($_GET["ref_id"]);

        $this->tpl = new ilGlobalTemplate("tpl.sahs_api.html", true, true, "Modules/ScormAicc");
        
        // for scorm modules with only one presentable item: launch item
        if ($_GET["autolaunch"] != "") {
            $this->tpl->setCurrentBlock("auto_launch");
            include_once("./Modules/ScormAicc/classes/SCORM/class.ilSCORMItem.php");
            include_once("./Modules/ScormAicc/classes/SCORM/class.ilSCORMResource.php");
            $sc_object = new ilSCORMItem($_GET["autolaunch"]);
            $id_ref = $sc_object->getIdentifierRef();
            $sc_res_id = ilSCORMResource::_lookupIdByIdRef($id_ref, $sc_object->getSLMId());
            $scormtype = strtolower(ilSCORMResource::_lookupScormType($sc_res_id));
            
            if ($scormtype == "asset") {
                $item_command = "IliasLaunchAsset";
            } else {
                $item_command = "IliasLaunchSahs";
            }
            $this->tpl->setVariable("AUTO_LAUNCH_ID", $_GET["autolaunch"]);
            $this->tpl->setVariable("AUTO_LAUNCH_CMD", "this.autoLaunch();");
            $this->tpl->setVariable("AUTO_LAUNCH_ITEM_CMD", $item_command);
            $this->tpl->parseCurrentBlock();
        }

        //unlimited sessions
        if ($slm_obj->getSession()) {
            $session_timeout = (int) ($ilias->ini->readVariable("session", "expire")) / 2;
        } else {
            $session_timeout = 0;
        }
        $this->tpl->setVariable("PING_SESSION", $session_timeout);
        
        $this->tpl->setVariable("USER_ID", $ilias->account->getId());
        $this->tpl->setVariable("USER_FIRSTNAME", $ilias->account->getFirstname());
        $this->tpl->setVariable("USER_LASTNAME", $ilias->account->getLastname());
        $this->tpl->setVariable("USER_LOGIN", $ilias->account->getLogin());
        $this->tpl->setVariable("USER_OU", $ilias->account->getDepartment());
        $this->tpl->setVariable("REF_ID", $_GET["ref_id"]);
        $this->tpl->setVariable("SESSION_ID", session_id());
        $this->tpl->setVariable("CODE_BASE", "http://" . $_SERVER['SERVER_NAME'] . substr($_SERVER['PHP_SELF'], 0, strpos($_SERVER['PHP_SELF'], "/ilias.php")));
        
        $this->tpl->parseCurrentBlock();
        $this->tpl->printToStdout(false);
        exit;
    }

Here is the call graph for this function:

apiInitData()

ilSCORMPresentationGUI::apiInitData

(

)

SCORM Data for Javascript-API.

Definition at line 432 of file class.ilSCORMPresentationGUI.php.

References $_GET, ilObjSCORMInitData\getIliasScormData(), ilObjSCORMInitData\getIliasScormResources(), ilObjSCORMInitData\getIliasScormTree(), and ilObjSCORMInitData\getIliasScormVars().

    {
        //              global $DIC;
        //              $ilias = $DIC['ilias'];
        //              $ilLog = $DIC['ilLog'];
        //              $ilUser = $DIC['ilUser'];
        //              $lng = $DIC['lng'];
        //              $ilDB = $DIC['ilDB'];

        if ($_GET["ref_id"] == "") {
            print('alert("no start without ref_id");');
            die;
        }

        header('Content-Type: text/javascript; charset=UTF-8');
        print("function iliasApi() {\r\n");
        $js_data = file_get_contents("./Modules/ScormAicc/scripts/basisAPI.js");
        echo $js_data;
        $js_data = file_get_contents("./Modules/ScormAicc/scripts/SCORM1_2standard.js");//want to give opportunities to different files (Uwe Kohnle)
        echo $js_data;
        print("}\r\n");

        include_once("./Modules/ScormAicc/classes/SCORM/class.ilObjSCORMInitData.php");

        print("IliasScormVars=" . ilObjSCORMInitData::getIliasScormVars($this->slm) . ";\r\n");

        //Resources
        print("IliasScormResources=" . ilObjSCORMInitData::getIliasScormResources($this->slm->getId()) . ";\r\n");

        //Tree
        print("IliasScormTree=" . ilObjSCORMInitData::getIliasScormTree($this->slm->getId()) . ";\r\n");

        //prevdata
        print("IliasScormData=" . ilObjSCORMInitData::getIliasScormData($this->slm->getId()) . ";\r\n");

        // set alternative API name - not necessary for scorm
        if ($this->slm->getAPIAdapterName() != "API") {
            print('var ' . $this->slm->getAPIAdapterName() . '=new iliasApi();');
        } else {
            print('var API=new iliasApi();');
        }
    }

Here is the call graph for this function:

attrib2arr()

ilSCORMPresentationGUI::attrib2arr

(

&

$a_attributes

)

Definition at line 71 of file class.ilSCORMPresentationGUI.php.

    {
        $attr = array();

        if (!is_array($a_attributes)) {
            return $attr;
        }
        foreach ($a_attributes as $attribute) {
            $attr[$attribute->name()] = $attribute->value();
        }
    
        return $attr;
    }

contentSelect()

ilSCORMPresentationGUI::contentSelect

(

)

Definition at line 419 of file class.ilSCORMPresentationGUI.php.

References $DIC, $lng, and ilUtil\getStyleSheetLocation().

    {
        global $DIC;
        $lng = $DIC['lng'];
        $this->tpl = new ilGlobalTemplate("tpl.scorm_content_select.html", true, true, "Modules/ScormAicc");
        $this->tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
        $this->tpl->setVariable('TXT_SPECIALPAGE', $lng->txt("seq_toc"));
        $this->tpl->printToStdout();
    }

Here is the call graph for this function:

downloadCertificate()

ilSCORMPresentationGUI::downloadCertificate

(

)

Download the certificate for the active user.

Definition at line 861 of file class.ilSCORMPresentationGUI.php.

References $_GET, $DIC, $ilUser, ilObject\_lookupObjId(), ilCertificatePdfAction\downloadPdf(), and exit.

    {
        global $DIC;

        $ilUser = $DIC->user();
        $tree = $DIC['tree'];
        $ilCtrl = $DIC->ctrl();

        $obj_id = ilObject::_lookupObjId($_GET["ref_id"]);

        $certValidator = new ilCertificateDownloadValidator();
        $allowed = $certValidator->isCertificateDownloadable($ilUser->getId(), $obj_id);
        if ($allowed) {
            $certificateLogger = $DIC->logger()->cert();

            $ilUserCertificateRepository = new ilUserCertificateRepository();
            $pdfGenerator = new ilPdfGenerator($ilUserCertificateRepository, $certificateLogger);

            $pdfAction = new ilCertificatePdfAction(
                $certificateLogger,
                $pdfGenerator,
                new ilCertificateUtilHelper(),
                $this->lng->txt('error_creating_certificate_pdf')
            );

            $pdfAction->downloadPdf($ilUser->getId(), $obj_id);
            exit;
        }
        // redirect to parent category if certificate is not accessible
        $parent = $tree->getParentId($_GET["ref_id"]);
        $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $parent);
        $ilCtrl->redirectByClass("ilrepositorygui", "");
    }

Here is the call graph for this function:

executeCommand()

ilSCORMPresentationGUI::executeCommand

(

)

execute command

Definition at line 47 of file class.ilSCORMPresentationGUI.php.

References $_GET, $DIC, $ilias, and $lng.

    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];
        $ilLog = $DIC['ilLog'];
        $ilias = $DIC['ilias'];
        $lng = $DIC['lng'];

        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd("frameset");

        if (!$ilAccess->checkAccess("write", "", $_GET["ref_id"]) &&
            (!$ilAccess->checkAccess("read", "", $_GET["ref_id"]) ||
            $this->slm->getOfflineStatus())) {
            $ilias->raiseError($lng->txt("permission_denied"), $ilias->error_obj->WARNING);
        }

        switch ($next_class) {
            default:
                $this->$cmd();
        }
    }

explorer()

ilSCORMPresentationGUI::explorer

(

$a_target = "sahs_content"

)

save the active module version to scorm_tracking

output table of content

Definition at line 350 of file class.ilSCORMPresentationGUI.php.

References $_GET, $DIC, $ilBench, $slm, ilUtil\getStyleSheetLocation(), ilTree\readRootId(), and ilExplorer\setTargetGet().

    {
        global $DIC;
        $ilBench = $DIC['ilBench'];
        $ilLog = $DIC['ilLog'];

        $ilBench->start("SCORMExplorer", "initExplorer");
        
        $this->tpl = new ilGlobalTemplate("tpl.sahs_exp_main.html", true, true, "Modules/ScormAicc");
        
        require_once("./Modules/ScormAicc/classes/SCORM/class.ilSCORMExplorer.php");
        $exp = new ilSCORMExplorer($this->ctrl->getLinkTarget($this, "view"), $this->slm);
        $exp->setTargetGet("obj_id");
        $exp->setFrameTarget($a_target);
        
        //$exp->setFiltered(true);
        $jsApi = false;
        if ($_GET["jsApi"] == "1") {
            $jsApi = true;
        }

        if ($_GET["scexpand"] == "") {
            $mtree = new ilSCORMTree($this->slm->getId());
            $expanded = $mtree->readRootId();
        } else {
            $expanded = $_GET["scexpand"];
        }
        $exp->setExpand($expanded);
        
        $exp->forceExpandAll(true, false);
        $ilBench->stop("SCORMExplorer", "initExplorer");

        // build html-output
        $ilBench->start("SCORMExplorer", "setOutput");
        $exp->setOutput(0);
        $ilBench->stop("SCORMExplorer", "setOutput");

        $ilBench->start("SCORMExplorer", "getOutput");
        $output = $exp->getOutput($jsApi);
        $ilBench->stop("SCORMExplorer", "getOutput");

        $this->tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
        $this->tpl->addBlockFile("CONTENT", "content", "tpl.sahs_explorer.html", "Modules/ScormAicc");
        //$this->tpl->setVariable("TXT_EXPLORER_HEADER", $this->lng->txt("cont_content"));
        $this->tpl->setVariable("EXP_REFRESH", $this->lng->txt("refresh"));
        $this->tpl->setVariable("EXPLORER", $output);
        $this->tpl->setVariable("ACTION", "ilias.php?baseClass=ilSAHSPresentationGUI&cmd=" . $_GET["cmd"] . "&frame=" . $_GET["frame"] .
            "&ref_id=" . $this->slm->getRefId() . "&scexpand=" . $_GET["scexpand"]);
        $this->tpl->parseCurrentBlock();
        //BUG 16794? $this->tpl->show();
        $this->tpl->printToStdout("DEFAULT", false);
    }

Here is the call graph for this function:

finishSahs()

ilSCORMPresentationGUI::finishSahs

(

)

Definition at line 724 of file class.ilSCORMPresentationGUI.php.

References $_GET, $DIC, $lng, ilTree\fetchSuccessorNode(), ilUtil\getImagePath(), and ilUtil\getStyleSheetLocation().

    {
        global $DIC;
        $lng = $DIC['lng'];
        $this->tpl = new ilGlobalTemplate("tpl.sahs_finish_cbt.html", true, true, "Modules/ScormAicc");
        $this->tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());

        // block not in template
        // $this->tpl->setCurrentBlock("switch_icon");
        $this->tpl->setVariable("SCO_ID", $_GET["sahs_id"]);
        $this->tpl->setVariable(
            "SCO_ICO",
            ilUtil::getImagePath(
                "scorm/" . str_replace(" ", "_", $_GET["status"]) . '.svg'
            )
        );
        $this->tpl->setVariable(
            "SCO_ALT",
            $lng->txt("cont_status") . ": "
            . $lng->txt("cont_sc_stat_" . str_replace(" ", "_", $_GET["status"])) . ", "
            . $lng->txt("cont_total_time") . ": "
            . $_GET["totime"]
        );
        // BEGIN Partial fix for SCO sequencing:
        //       With this partial fix, ILIAS can now proceed to the next
        //          SCO, if it is a sibling of the current SCO.
        //       This fix doesn't fix the case, if the next SCO has a
        //          different parent item.
        //$this->tpl->setVariable("SCO_LAUNCH_ID", $_GET["launch"]);
        
        $launch_id = $_GET['launch'];
        if ($launch_id == 'null' || $launch_id == null) {
            require_once("./Modules/ScormAicc/classes/SCORM/class.ilSCORMTree.php");
            $mtree = new ilSCORMTree($this->slm->getId());
            $node_data = $mtree->fetchSuccessorNode($_GET['sahs_id']);
            if ($node_data && $node_data[type] == 'sit') {
                $launch_id = $node_data['child'];
            }
        }
        // END Partial fix for SCO sequencing
        $this->tpl->setVariable("SCO_LAUNCH_ID", $launch_id);
        // $this->tpl->parseCurrentBlock();
        $this->tpl->printToStdout();
    }

Here is the call graph for this function:

frameset()

ilSCORMPresentationGUI::frameset

(

)

Output main frameset.

If only one SCO/Asset is given, it is displayed without the table of contents explorer frame on the left.

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

References $DIC, $lng, ilSCORMObject\_lookupPresentableItems(), exit, get_actual_attempts(), get_max_attempts(), increase_attemptAndsave_module_version(), and ilWACSignedPath\signFolderOfStartFile().

    {
        global $DIC;
        $lng = $DIC['lng'];
        $javascriptAPI = true;
        include_once("./Modules/ScormAicc/classes/SCORM/class.ilSCORMObject.php");
        $items = ilSCORMObject::_lookupPresentableItems($this->slm->getId());
        
        //check for max_attempts and raise error if max_attempts is exceeded
        if ($this->get_max_attempts() != 0) {
            if ($this->get_actual_attempts() >= $this->get_max_attempts()) {
                header('Content-Type: text/html; charset=utf-8');
                echo($lng->txt("cont_sc_max_attempt_exceed"));
                exit;
            }
        }
    
        $this->increase_attemptAndsave_module_version();

        //WAC
        require_once('./Services/WebAccessChecker/classes/class.ilWACSignedPath.php');
        ilWACSignedPath::signFolderOfStartFile($this->slm->getDataDirectory() . '/imsmanifest.xml');

        $debug = $this->slm->getDebug();
        if (count($items) > 1) {
            $this->ctrl->setParameter($this, "expand", "1");
            $this->ctrl->setParameter($this, "jsApi", "1");
            $exp_link = $this->ctrl->getLinkTarget($this, "explorer");
            
            // should be able to grep templates
            if ($debug) {
                $this->tpl = new ilGlobalTemplate("tpl.sahs_pres_frameset_js_debug.html", false, false, "Modules/ScormAicc");
            } else {
                $this->tpl = new ilGlobalTemplate("tpl.sahs_pres_frameset_js.html", false, false, "Modules/ScormAicc");
            }
                            
            $this->tpl->setVariable("EXPLORER_LINK", $exp_link);
            $pres_link = $this->ctrl->getLinkTarget($this, "contentSelect");
            $this->tpl->setVariable("PRESENTATION_LINK", $pres_link);
        } else {
            if ($debug) {
                $this->tpl = new ilGlobalTemplate("tpl.sahs_pres_frameset_js_debug_one_page.html", false, false, "Modules/ScormAicc");
            } else {
                $this->tpl = new ilGlobalTemplate("tpl.sahs_pres_frameset_js_one_page.html", false, false, "Modules/ScormAicc");
            }

            $this->ctrl->setParameter($this, "autolaunch", $items[0]);
        }
        $api_link = $this->ctrl->getLinkTarget($this, "apiInitData");
        $this->tpl->setVariable("TITLE", $this->slm->getTitle());
        $this->tpl->setVariable("API_LINK", $api_link);
        $this->tpl->printToStdout("DEFAULT", false);

        
        exit;
    }

Here is the call graph for this function:

get_actual_attempts()

ilSCORMPresentationGUI::get_actual_attempts

(

)

Get number of actual attempts for the user.

Definition at line 159 of file class.ilSCORMPresentationGUI.php.

References $DIC, $ilDB, and $ilUser.

Referenced by frameset().

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $ilUser = $DIC['ilUser'];
        $val_set = $ilDB->queryF(
            'SELECT package_attempts FROM sahs_user WHERE obj_id = %s AND user_id = %s',
            array('integer','integer'),
            array($this->slm->getId(),$ilUser->getId())
        );
        $val_rec = $ilDB->fetchAssoc($val_set);
        $attempts = $val_rec["package_attempts"];
        if ($attempts == null) {
            $attempts = 0;
        }
        return $attempts;
    }

Here is the caller graph for this function:

get_max_attempts()

ilSCORMPresentationGUI::get_max_attempts

(

)

Get max.

number of attempts allowed for this package

Definition at line 150 of file class.ilSCORMPresentationGUI.php.

References ilObjSCORMInitData\get_max_attempts().

Referenced by frameset().

    {
        include_once "./Modules/ScormAicc/classes/SCORM/class.ilObjSCORMInitData.php";
        return ilObjSCORMInitData::get_max_attempts($this->slm->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

increase_attemptAndsave_module_version()

ilSCORMPresentationGUI::increase_attemptAndsave_module_version

(

)

Increases attempts by one for this package.

Increases attempts by one and saves module_version for this package

Definition at line 261 of file class.ilSCORMPresentationGUI.php.

References $DIC, $ilDB, $ilUser, $res, and ilLPStatusWrapper\_updateStatus().

Referenced by frameset().

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $ilUser = $DIC['ilUser'];
        $res = $ilDB->queryF(
            'SELECT package_attempts,count(*) cnt FROM sahs_user WHERE obj_id = %s AND user_id = %s GROUP BY package_attempts',
            array('integer','integer'),
            array($this->slm->getId(),$ilUser->getId())
        );
        $val_rec = $ilDB->fetchAssoc($res);
        if ($val_rec["cnt"] == 0) { //offline_mode could be inserted
            $attempts = 1;
            $ilDB->manipulateF(
                'INSERT INTO sahs_user (obj_id,user_id,package_attempts,module_version,last_access) VALUES(%s,%s,%s,%s,%s)',
                array('integer', 'integer', 'integer', 'integer', 'timestamp'),
                array($this->slm->getId(), $ilUser->getId(), $attempts, $this->slm->getModuleVersion(), date('Y-m-d H:i:s'))
            );
        } else {
            $attempts = $val_rec["package_attempts"];
            if ($attempts == null) {
                $attempts = 0;
            }
            $attempts++;
            $ilDB->manipulateF(
                'UPDATE sahs_user SET package_attempts = %s, module_version = %s, last_access=%s WHERE obj_id = %s AND user_id = %s ',
                array('integer', 'integer', 'timestamp', 'integer', 'integer'),
                array($attempts, $this->slm->getModuleVersion(), date('Y-m-d H:i:s'), $this->slm->getId(), $ilUser->getId())
            );
        }
        //only SCORM 1.2, not 2004
        include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
        ilLPStatusWrapper::_updateStatus($this->slm->getId(), $ilUser->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

launchAsset()

ilSCORMPresentationGUI::launchAsset

(

)

Definition at line 778 of file class.ilSCORMPresentationGUI.php.

References $_GET, $_POST, $DIC, $ilDB, and $ilUser.

    {
        global $DIC;
        $ilUser = $DIC['ilUser'];
        $ilDB = $DIC['ilDB'];

        $sco_id = ($_GET["asset_id"] == "")
            ? $_POST["asset_id"]
            : $_GET["asset_id"];
        $ref_id = ($_GET["ref_id"] == "")
            ? $_POST["ref_id"]
            : $_GET["ref_id"];

        $this->slm = new ilObjSCORMLearningModule($ref_id, true);

        include_once("./Modules/ScormAicc/classes/SCORM/class.ilSCORMItem.php");
        include_once("./Modules/ScormAicc/classes/SCORM/class.ilSCORMResource.php");
        $item = new ilSCORMItem($sco_id);

        $id_ref = $item->getIdentifierRef();
        $resource = new ilSCORMResource();
        $resource->readByIdRef($id_ref, $item->getSLMId());
        $href = $resource->getHref();
        $this->tpl->setVariable("HREF", $this->slm->getDataDirectory("output") . "/" . $href);
        $this->tpl = new ilGlobalTemplate("tpl.scorm_launch_asset.html", true, true, "Modules/ScormAicc");
        $this->tpl->setVariable("HREF", $this->slm->getDataDirectory("output") . "/" . $href);
        $this->tpl->printToStdout();
    }

launchSahs()

ilSCORMPresentationGUI::launchSahs

(

)

This function is called by the API applet in the content frame when a SCO is started.

Definition at line 532 of file class.ilSCORMPresentationGUI.php.

References $_GET, $_POST, $DIC, $i, $ilDB, $ilUser, $lng, ilObject\_lookupObjId(), ilSCORMObject\_lookupPresentableItems(), ilUtil\getImagePath(), setArray(), and setSingleVariable().

    {
        global $DIC;
        $ilUser = $DIC['ilUser'];
        $ilDB = $DIC['ilDB'];

        $sco_id = ($_GET["sahs_id"] == "")
            ? $_POST["sahs_id"]
            : $_GET["sahs_id"];
        $ref_id = ($_GET["ref_id"] == "")
            ? $_POST["ref_id"]
            : $_GET["ref_id"];

        $this->slm = new ilObjSCORMLearningModule($ref_id, true);

        include_once("./Modules/ScormAicc/classes/SCORM/class.ilSCORMItem.php");
        include_once("./Modules/ScormAicc/classes/SCORM/class.ilSCORMResource.php");
        $item = new ilSCORMItem($sco_id);

        $id_ref = $item->getIdentifierRef();
        $resource = new ilSCORMResource();
        $resource->readByIdRef($id_ref, $item->getSLMId());
        //$slm_obj = new ilObjSCORMLearningModule($_GET["ref_id"]);
        $href = $resource->getHref();
        $this->tpl = new ilGlobalTemplate("tpl.sahs_launch_cbt.html", true, true, "Modules/ScormAicc");
        $this->tpl->setVariable("HREF", $this->slm->getDataDirectory("output") . "/" . $href);

        // set item data
        $this->tpl->setVariable("LAUNCH_DATA", $item->getDataFromLms());
        $this->tpl->setVariable("MAST_SCORE", $item->getMasteryScore());
        $this->tpl->setVariable("MAX_TIME", $item->getMaxTimeAllowed());
        $this->tpl->setVariable("LIMIT_ACT", $item->getTimeLimitAction());

        // set alternative API name
        if ($this->slm->getAPIAdapterName() != "API") {
            $this->tpl->setCurrentBlock("alt_api_ref");
            $this->tpl->setVariable("API_NAME", $this->slm->getAPIAdapterName());
            $this->tpl->parseCurrentBlock();
        }

        $val_set = $ilDB->queryF(
            '
                        SELECT * FROM scorm_tracking 
                        WHERE user_id = %s
                        AND sco_id = %s
                        AND obj_id = %s',
            array('integer','integer','integer'),
            array($ilUser->getId(),$sco_id,$this->slm->getId())
        );
        $re_value = array();
        while ($val_rec = $ilDB->fetchAssoc($val_set)) {
            $val_rec["rvalue"] = str_replace("\r\n", "\n", $val_rec["rvalue"]);
            $val_rec["rvalue"] = str_replace("\r", "\n", $val_rec["rvalue"]);
            $val_rec["rvalue"] = str_replace("\n", "\\n", $val_rec["rvalue"]);
            $re_value[$val_rec["lvalue"]] = $val_rec["rvalue"];
        }
        
        foreach ($re_value as $var => $value) {
            switch ($var) {
                case "cmi.core.lesson_location":
                case "cmi.core.lesson_status":
                case "cmi.core.entry":
                case "cmi.core.score.raw":
                case "cmi.core.score.max":
                case "cmi.core.score.min":
                case "cmi.core.total_time":
                case "cmi.core.exit":
                case "cmi.suspend_data":
                case "cmi.comments":
                case "cmi.student_preference.audio":
                case "cmi.student_preference.language":
                case "cmi.student_preference.speed":
                case "cmi.student_preference.text":
                    $this->setSingleVariable($var, $value);
                    break;

                case "cmi.objectives._count":
                    $this->setSingleVariable($var, $value);
                    $this->setArray("cmi.objectives", $value, "id", $re_value);
                    $this->setArray("cmi.objectives", $value, "score.raw", $re_value);
                    $this->setArray("cmi.objectives", $value, "score.max", $re_value);
                    $this->setArray("cmi.objectives", $value, "score.min", $re_value);
                    $this->setArray("cmi.objectives", $value, "status", $re_value);
                    break;

                case "cmi.interactions._count":
                    $this->setSingleVariable($var, $value);
                    $this->setArray("cmi.interactions", $value, "id", $re_value);
                    for ($i = 0; $i < $value; $i++) {
                        $var2 = "cmi.interactions." . $i . ".objectives._count";
                        if (isset($v_array[$var2])) {
                            $cnt = $v_array[$var2];
                            $this->setArray(
                                "cmi.interactions." . $i . ".objectives",
                                $cnt,
                                "id",
                                $re_value
                            );
                            /*
                            $this->setArray("cmi.interactions.".$i.".objectives",
                                $cnt, "score.raw", $re_value);
                            $this->setArray("cmi.interactions.".$i.".objectives",
                                $cnt, "score.max", $re_value);
                            $this->setArray("cmi.interactions.".$i.".objectives",
                                $cnt, "score.min", $re_value);
                            $this->setArray("cmi.interactions.".$i.".objectives",
                                $cnt, "status", $re_value);*/
                        }
                    }
                    $this->setArray("cmi.interactions", $value, "time", $re_value);
                    $this->setArray("cmi.interactions", $value, "type", $re_value);
                    for ($i = 0; $i < $value; $i++) {
                        $var2 = "cmi.interactions." . $i . ".correct_responses._count";
                        if (isset($v_array[$var2])) {
                            $cnt = $v_array[$var2];
                            $this->setArray(
                                "cmi.interactions." . $i . ".correct_responses",
                                $cnt,
                                "pattern",
                                $re_value
                            );
                            $this->setArray(
                                "cmi.interactions." . $i . ".correct_responses",
                                $cnt,
                                "weighting",
                                $re_value
                            );
                        }
                    }
                    $this->setArray("cmi.interactions", $value, "student_response", $re_value);
                    $this->setArray("cmi.interactions", $value, "result", $re_value);
                    $this->setArray("cmi.interactions", $value, "latency", $re_value);
                    break;
            }
        }

        global $DIC;
        $lng = $DIC['lng'];
        $this->tpl->setCurrentBlock("switch_icon");
        $this->tpl->setVariable("SCO_ID", $_GET["sahs_id"]);
        $this->tpl->setVariable("SCO_ICO", ilUtil::getImagePath("scorm/running.svg"));
        $this->tpl->setVariable(
            "SCO_ALT",
            $lng->txt("cont_status") . ": "
            . $lng->txt("cont_sc_stat_running")
        );
        $this->tpl->parseCurrentBlock();
        
        // set icon, if more than one SCO/Asset is presented
        $items = ilSCORMObject::_lookupPresentableItems($this->slm->getId());
        if (count($items) > 1) {
            $this->tpl->setVariable("SWITCH_ICON_CMD", "switch_icon();");
        }


        // lesson mode
        $lesson_mode = $this->slm->getDefaultLessonMode();
        if ($this->slm->getAutoReview()) {
            if ($re_value["cmi.core.lesson_status"] == "completed" ||
                $re_value["cmi.core.lesson_status"] == "passed" ||
                $re_value["cmi.core.lesson_status"] == "failed") {
                $lesson_mode = "review";
            }
        }
        $this->tpl->setVariable("LESSON_MODE", $lesson_mode);

        // credit mode
        if ($lesson_mode == "normal") {
            $this->tpl->setVariable(
                "CREDIT_MODE",
                str_replace("_", "-", $this->slm->getCreditMode())
            );
        } else {
            $this->tpl->setVariable("CREDIT_MODE", "no-credit");
        }

        // init cmi.core.total_time, cmi.core.lesson_status and cmi.core.entry
        $sahs_obj_id = ilObject::_lookupObjId($_GET["ref_id"]);
        if (!isset($re_value["cmi.core.total_time"])) {
            $item->insertTrackData("cmi.core.total_time", "0000:00:00", $sahs_obj_id);
        }
        if (!isset($re_value["cmi.core.lesson_status"])) {
            $item->insertTrackData("cmi.core.lesson_status", "not attempted", $sahs_obj_id);
        }
        if (!isset($re_value["cmi.core.entry"])) {
            $item->insertTrackData("cmi.core.entry", "", $sahs_obj_id);
        }

        $this->tpl->printToStdout();
        //echo htmlentities($this->tpl->get()); exit;
    }

Here is the call graph for this function:

logMessage()

ilSCORMPresentationGUI::logMessage

(

)

Definition at line 815 of file class.ilSCORMPresentationGUI.php.

References $DIC.

    {
        global $DIC;
        $ilLog = $DIC['ilLog'];
        $logString = file_get_contents('php://input');
        $ilLog->write("ScormAicc: ApiLog: Message: " . $logString);
    }

logWarning()

ilSCORMPresentationGUI::logWarning

(

)

Definition at line 823 of file class.ilSCORMPresentationGUI.php.

References $DIC.

    {
        global $DIC;
        $ilLog = $DIC['ilLog'];
        $logString = file_get_contents('php://input');
        $ilLog->write("ScormAicc: ApiLog: Warning: " . $logString, 20);
    }

pingSession()

ilSCORMPresentationGUI::pingSession

(

)

Definition at line 807 of file class.ilSCORMPresentationGUI.php.

References ilWACSignedPath\signFolderOfStartFile().

    {
        //WAC
        require_once('./Services/WebAccessChecker/classes/class.ilWACSignedPath.php');
        ilWACSignedPath::signFolderOfStartFile($this->slm->getDataDirectory() . '/imsmanifest.xml');
        return true;
    }

Here is the call graph for this function:

setArray()

ilSCORMPresentationGUI::setArray	(		$a_left,
			$a_value,
			$a_name,
		&	$v_array
	)

set single value

Definition at line 845 of file class.ilSCORMPresentationGUI.php.

References $i.

Referenced by launchSahs().

    {
        for ($i = 0; $i < $a_value; $i++) {
            $var = $a_left . "." . $i . "." . $a_name;
            if (isset($v_array[$var])) {
                $this->tpl->setCurrentBlock("set_value");
                $this->tpl->setVariable("VAR", $var);
                $this->tpl->setVariable("VALUE", $v_array[$var]);
                $this->tpl->parseCurrentBlock();
            }
        }
    }

Here is the caller graph for this function:

setSingleVariable()

ilSCORMPresentationGUI::setSingleVariable	(		$a_var,
			$a_value
	)

set single value

Definition at line 834 of file class.ilSCORMPresentationGUI.php.

Referenced by launchSahs().

    {
        $this->tpl->setCurrentBlock("set_value");
        $this->tpl->setVariable("VAR", $a_var);
        $this->tpl->setVariable("VALUE", $a_value);
        $this->tpl->parseCurrentBlock();
    }

Here is the caller graph for this function:

unloadSahs()

ilSCORMPresentationGUI::unloadSahs

(

)

Definition at line 769 of file class.ilSCORMPresentationGUI.php.

References $_GET, and ilUtil\getStyleSheetLocation().

    {
        $this->tpl = new ilGlobalTemplate("tpl.sahs_unload_cbt.html", true, true, "Modules/ScormAicc");
        $this->tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
        $this->tpl->setVariable("SCO_ID", $_GET["sahs_id"]);
        $this->tpl->printToStdout();
    }

Here is the call graph for this function:

view()

ilSCORMPresentationGUI::view

(

)

SCORM content screen.

Definition at line 407 of file class.ilSCORMPresentationGUI.php.

References $_GET, ilSCORMObjectGUI\getInstance(), and ilUtil\getStyleSheetLocation().

    {
        $sc_gui_object = ilSCORMObjectGUI::getInstance($_GET["obj_id"]);

        if (is_object($sc_gui_object)) {
            $sc_gui_object->view();
        }

        $this->tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
        $this->tpl->printToStdout(false);
    }

Here is the call graph for this function:

Field Documentation

$ilias

ilSCORMPresentationGUI::$ilias

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

Referenced by __construct(), api(), and executeCommand().

$lng

ilSCORMPresentationGUI::$lng

Definition at line 23 of file class.ilSCORMPresentationGUI.php.

Referenced by __construct(), contentSelect(), executeCommand(), finishSahs(), frameset(), and launchSahs().

$slm

ilSCORMPresentationGUI::$slm

Definition at line 21 of file class.ilSCORMPresentationGUI.php.

Referenced by explorer().

$tpl

ilSCORMPresentationGUI::$tpl

Definition at line 22 of file class.ilSCORMPresentationGUI.php.

Referenced by __construct().

---

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

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