Inheritance diagram for ilSCORMPresentationGUI:

Collaboration diagram for ilSCORMPresentationGUI:

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

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:: class.ilSCORMPresentationGUI.php 32417 2011-12-31 15:00:11Z ukohnle

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

Member Function Documentation

ilSCORMPresentationGUI::api ( )

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

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

        {
                global $ilias;
                $slm_obj =& new ilObjSCORMLearningModule($_GET["ref_id"]);
                $this->tpl = new ilTemplate("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->show(false);
                exit;
        }

Here is the call graph for this function:

ilSCORMPresentationGUI::apiInitData ( )

SCORM Data for Javascript-API.

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

References $_GET, $ilDB, $ilias, $ilLog, $lng, and ilUtil\getImagePath().

                               {
                global $ilias, $ilLog, $ilUser, $lng, $ilDB;
        
                function encodeURIComponent($str) {
                        $revert = array('%21'=>'!', '%2A'=>'*', '%27'=>"'", '%28'=>'(', '%29'=>')', '%7E'=>'~');
                        return strtr(rawurlencode($str), $revert);
                }
                if ($_GET["ref_id"] == "") {
                        print ('alert("no start without ref_id");');
                        die;
                }
                $slm_obj =& new ilObjSCORMLearningModule($_GET["ref_id"]);
                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");
                
                //variables to set in administration interface
                $b_checkSetValues='true';
                $b_storeObjectives='true';
                $b_storeInteractions='true';
                $b_readInteractions='false';
                $c_storeSessionTime='s';//n=no, s=sco, i=ilias
                $i_lessonScoreMax='-1';
                $i_lessonMasteryScore='-1';
                
                //other variables
                $b_messageLog='false';
                if ($ilLog->current_log_level == 30) $b_messageLog='true';
                $launchId='0';
                if ($_GET["autolaunch"] != "") $launchId=$_GET["autolaunch"];
                $session_timeout = 0; //unlimited sessions
                if ($slm_obj->getSession()) {
                        $session_timeout = (int)($ilias->ini->readVariable("session","expire"))/2;
                }
                $b_autoReview='false';
                if ($this->slm->getAutoReview()) $b_autoReview='true';
                $b_debug='false';
                if ($this->slm->getDebug()) $b_debug='true';
                $b_autoContinue='false';
                if ($this->slm->getAutoContinue()) $b_autoContinue='true';
                $s_out='IliasScormVars={'
                        .'refId:'.$_GET["ref_id"].','
                        .'objId:'.$this->slm->getId().','
                        .'launchId:'.$launchId.','
                        .'launchNr:0,'
                        .'pingSession:'. $session_timeout.','
                        .'studentId:'.$ilias->account->getId().','
                        .'studentName:"'.encodeURIComponent($ilias->account->getLastname().', '.$ilias->account->getFirstname()).'",'
                        .'studentLogin:"'.encodeURIComponent($ilias->account->getLogin()).'",'
                        .'studentOu:"'.encodeURIComponent($ilias->account->getDepartment()).'",'
                        .'credit:"'.str_replace("_", "-", $this->slm->getCreditMode()).'",'
                        .'lesson_mode:"'.$this->slm->getDefaultLessonMode().'",'
                        .'b_autoReview:'.$b_autoReview.','
                        .'b_messageLog:'.$b_messageLog.','
                        .'b_checkSetValues:'.$b_checkSetValues.','
                        .'b_storeObjectives:'.$b_storeObjectives.','
                        .'b_storeInteractions:'.$b_storeInteractions.','
                        .'b_readInteractions:'.$b_readInteractions.','
                        .'c_storeSessionTime:"'.$c_storeSessionTime.'",'
                        .'b_autoContinue:'.$b_autoContinue.','
                        .'i_lessonScoreMax:'.$i_lessonScoreMax.','
                        .'i_lessonMasteryScore:'.$i_lessonMasteryScore.','
                        .'b_debug:'.$b_debug.','
                        .'dataDirectory:"'.encodeURIComponent($this->slm->getDataDirectory("output").'/').'",'
                        .'img:{'
                                .'asset:"'.encodeURIComponent(ilUtil::getImagePath('scorm/asset.gif')).'",'
                                .'browsed:"'.encodeURIComponent(ilUtil::getImagePath('scorm/browsed.gif')).'",'
                                .'completed:"'.encodeURIComponent(ilUtil::getImagePath('scorm/completed.gif')).'",'
                                .'failed:"'.encodeURIComponent(ilUtil::getImagePath('scorm/failed.gif')).'",'
                                .'incomplete:"'.encodeURIComponent(ilUtil::getImagePath('scorm/incomplete.gif')).'",'
                                .'not_attempted:"'.encodeURIComponent(ilUtil::getImagePath('scorm/not_attempted.gif')).'",'
                                .'passed:"'.encodeURIComponent(ilUtil::getImagePath('scorm/passed.gif')).'",'
                                .'running:"'.encodeURIComponent(ilUtil::getImagePath('scorm/running.gif')).'"'
                        .'},'
                        .'statusTxt:{'
                                .'wait:"'.encodeURIComponent($lng->txt("please_wait")).'",'
                                .'status:"'.encodeURIComponent($lng->txt("cont_status")).'",'
                                .'browsed:"'.encodeURIComponent($lng->txt("cont_sc_stat_browsed")).'",'
                                .'completed:"'.encodeURIComponent($lng->txt("cont_sc_stat_completed")).'",'
                                .'failed:"'.encodeURIComponent($lng->txt("cont_sc_stat_failed")).'",'
                                .'incomplete:"'.encodeURIComponent($lng->txt("cont_sc_stat_incomplete")).'",'
                                .'not_attempted:"'.encodeURIComponent($lng->txt("cont_sc_stat_not_attempted")).'",'
                                .'passed:"'.encodeURIComponent($lng->txt("cont_sc_stat_passed")).'",'
                                .'running:"'.encodeURIComponent($lng->txt("cont_sc_stat_running")).'"'
                        .'}'
                .'};';
//              header('Content-Type: text/javascript; charset=UTF-8');
                print($s_out."\r\n");
                //prevdata
                $s_out = 'IliasScormData=[';
                $tquery = 'SELECT sco_id,lvalue,rvalue FROM scorm_tracking '
                                .'WHERE user_id = %s AND obj_id = %s '
                                ."AND sco_id > 0 AND lvalue != 'cmi.core.entry' AND lvalue != 'cmi.core.session_time'";
                if ($b_readInteractions == 'false') $tquery.=" AND SUBSTR(lvalue, 1, 16) != 'cmi.interactions'";
                $val_set = $ilDB->queryF($tquery,
                        array('integer','integer'),
                        array($ilUser->getId(),$this->slm->getId())     
                );
                while($val_rec = $ilDB->fetchAssoc($val_set)) {
                        if (!strpos($val_rec["lvalue"],"._count"))
                                $s_out.='['.$val_rec["sco_id"].',"'.$val_rec["lvalue"].'","'.encodeURIComponent($val_rec["rvalue"]).'"],';
                }
                //manifestData
                $val_set = $ilDB->queryF('
                        SELECT sc_item.obj_id,maxtimeallowed,timelimitaction,datafromlms,masteryscore 
                        FROM sc_item, scorm_object 
                        WHERE scorm_object.obj_id=sc_item.obj_id
                        AND scorm_object.c_type = %s
                        AND scorm_object.slm_id = %s',
                        array('text','integer'),
                        array('sit',$this->slm->getId())        
                );
                while($val_rec = $ilDB->fetchAssoc($val_set)) {
                        if($val_rec["maxtimeallowed"]!=null)
                                $s_out.='['.$val_rec["obj_id"].',"cmi.student_data.max_time_allowed","'.encodeURIComponent($val_rec["maxtimeallowed"]).'"],';
                        if($val_rec["timelimitaction"]!=null)
                                $s_out.='['.$val_rec["obj_id"].',"cmi.student_data.time_limit_action","'.encodeURIComponent($val_rec["timelimitaction"]).'"],';
                        if($val_rec["datafromlms"]!=null)
                                $s_out.='['.$val_rec["obj_id"].',"cmi.launch_data","'.encodeURIComponent($val_rec["datafromlms"]).'"],';
                        if($val_rec["masteryscore"]!=null)
                                $s_out.='['.$val_rec["obj_id"].',"cmi.student_data.mastery_score","'.encodeURIComponent($val_rec["masteryscore"]).'"],';
                }
                if(substr($s_out,(strlen($s_out)-1))==",") $s_out=substr($s_out,0,(strlen($s_out)-1));
                $s_out.='];';
                print($s_out."\r\n");
                //URLs
                $s_out='IliasScormResources=[';
                $s_resourceIds="";//necessary if resources exist having different href with same identifier
                $val_set = $ilDB->queryF("
                        SELECT sc_resource.obj_id
                        FROM scorm_tree, sc_resource
                        WHERE scorm_tree.slm_id=%s 
                        AND sc_resource.obj_id=scorm_tree.child",
                        array('integer'),
                        array($this->slm->getId())      
                );
                while($val_rec = $ilDB->fetchAssoc($val_set)) {
                        $s_resourceIds .= ",".$val_rec["obj_id"];
                }
                $s_resourceIds = substr($s_resourceIds,1);
                $tquery="SELECT scorm_tree.lft, scorm_tree.child, 
                        CASE WHEN sc_resource.scormtype = 'asset' THEN 1 ELSE 0 END AS asset,
                        sc_resource.href
                        FROM scorm_tree, sc_resource, sc_item
                        WHERE scorm_tree.slm_id=%s 
                        AND sc_item.obj_id=scorm_tree.child 
                        AND sc_resource.import_id=sc_item.identifierref 
                        AND sc_resource.obj_id in (".$s_resourceIds.") 
                        ORDER BY scorm_tree.lft";
                $val_set = $ilDB->queryF($tquery,
                        array('integer'),
                        array($this->slm->getId())      
                );
                while($val_rec = $ilDB->fetchAssoc($val_set)) {
                        $s_out.='['.$val_rec["lft"].','.$val_rec["child"].','.$val_rec["asset"].',"'.encodeURIComponent($val_rec["href"]).'"],';
                }
                
                if(substr($s_out,(strlen($s_out)-1))==",") $s_out=substr($s_out,0,(strlen($s_out)-1));
                $s_out.="];\r\n";
                // set alternative API name
                if ($this->slm->getAPIAdapterName() != "API") $s_out.='var '.$this->slm->getAPIAdapterName().'=new iliasApi();';
                else $s_out.='var API=new iliasApi();';
                print($s_out);
                
        }

Here is the call graph for this function:

ilSCORMPresentationGUI::attrib2arr ( & $a_attributes )

Definition at line 65 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;
        }

ilSCORMPresentationGUI::contentSelect ( )

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

References $lng, and ilUtil\getStyleSheetLocation().

                                 {
                global $lng;
                $this->tpl = new ilTemplate("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->show();
        }

Here is the call graph for this function:

ilSCORMPresentationGUI::downloadCertificate ( )

Download the certificate for the active user.

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

References $_GET, ilObjUser\_lookupFields(), ilObjSCORMLearningModule\_lookupLastAccess(), ilObjSCORM2004LearningModule\_lookupLastAccess(), ilObject\_lookupObjId(), ilObjSAHSLearningModule\_lookupSubType(), ilObjSAHSLearningModuleAccess\_lookupUserCertificate(), exit, and ilUtil\redirect().

        {
                global $ilUser, $tree;
                $allowed = false;
                $last_access = 0;
                $obj_id = ilObject::_lookupObjId($_GET["ref_id"]);
                include_once "./Modules/ScormAicc/classes/class.ilObjSAHSLearningModuleAccess.php";
                if (ilObjSAHSLearningModuleAccess::_lookupUserCertificate($obj_id))
                {
                        include_once "./Modules/ScormAicc/classes/class.ilObjSAHSLearningModule.php";
                        $type = ilObjSAHSLearningModule::_lookupSubType($obj_id);
                        switch ($type)
                        {
                                case "scorm":
                                        include_once "./Modules/ScormAicc/classes/class.ilObjSCORMLearningModule.php";
                                        $allowed = true;
                                        $last_access = ilObjSCORMLearningModule::_lookupLastAccess($obj_id, $ilUser->getId());
                                        break;
                                case "scorm2004":
                                        include_once "./Modules/Scorm2004/classes/class.ilObjSCORM2004LearningModule.php";
                                        $allowed = true;
                                        $last_access = ilObjSCORM2004LearningModule::_lookupLastAccess($obj_id, $ilUser->getId());
                                        break;
                                default:
                                        break;
                        }
                }
                
                if ($allowed)
                {
                        include_once "./Services/Certificate/classes/class.ilCertificate.php";
                        include_once "./Modules/ScormAicc/classes/class.ilSCORMCertificateAdapter.php";
                        $certificate = new ilCertificate(new ilSCORMCertificateAdapter($this->slm));
                        $params = array(
                                "user_data" => ilObjUser::_lookupFields($ilUser->getId()),
                                "last_access" => $last_access
                        );
                        $certificate->outCertificate($params, true);
                        exit;
                }
                // redirect to parent category if certificate is not accessible
                $parent = $tree->getParentId($_GET["ref_id"]);
                $cmd_link = "repository.php?ref_id=".$parent;
                ilUtil::redirect($cmd_link);
        }

Here is the call graph for this function:

& ilSCORMPresentationGUI::executeCommand ( )

execute command

Reimplemented in ilAICCPresentationGUI, and ilHACPPresentationGUI.

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

References $_GET, $cmd, $ilias, $ilLog, and $lng.

        {
                global $ilAccess, $ilLog, $ilias, $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->getOnline()))
                {
                        $ilias->raiseError($lng->txt("permission_denied"), $ilias->error_obj->WARNING);
                }
                switch($next_class)
                {
                        default:
                                $this->$cmd();
                }
        }

ilSCORMPresentationGUI::explorer ( $a_target = "sahs_content" )

output table of content

Reimplemented in ilAICCPresentationGUI, and ilHACPPresentationGUI.

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

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

        {
                global $ilBench, $ilLog;
                $ilBench->start("SCORMExplorer", "initExplorer");
                
                $this->tpl = new ilTemplate("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();
                $this->tpl->show();
        }

Here is the call graph for this function:

ilSCORMPresentationGUI::finishSahs ( )

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

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

        {
                global $lng;
                $this->tpl = new ilTemplate("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"]).'.gif')
                );
                $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->show();
        }

Here is the call graph for this function:

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 86 of file class.ilSCORMPresentationGUI.php.

References $lng, ilSCORMObject\_lookupPresentableItems(), exit, get_actual_attempts(), get_max_attempts(), increase_attempt(), and save_module_version().

                                {
                global $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;           
                        }
                }
                
                //count attempt
                //Cause there is no way to check if the Java-Applet is sucessfully loaded, an attempt equals opening the SCORM player
                
                $this->increase_attempt();
                $this->save_module_version();
                if ($javascriptAPI == false) {
                        if (count($items) > 1
                                || strtolower(get_class($this->slm)) == "ilobjaicclearningmodule"
                                || strtolower(get_class($this->slm)) == "ilobjhacplearningmodule")
                        {
                                $this->ctrl->setParameter($this, "expand", "1");
                                $exp_link = $this->ctrl->getLinkTarget($this, "explorer");
                                $this->tpl = new ilTemplate("tpl.sahs_pres_frameset.html", false, false, "Modules/ScormAicc");
                                $this->tpl->setVariable("EXPLORER_LINK", $exp_link);
                                $api_link = $this->ctrl->getLinkTarget($this, "api");
                                $this->tpl->setVariable("API_LINK", $api_link);
                                $pres_link = $this->ctrl->getLinkTarget($this, "view");
                                $this->tpl->setVariable("PRESENTATION_LINK", $pres_link);
                                $this->tpl->show("DEFAULT", false);
                        }
                        else if (count($items) == 1)
                        {
                                $this->tpl = new ilTemplate("tpl.sahs_pres_frameset_one_page.html", false, false, "Modules/ScormAicc");
                                $this->ctrl->setParameter($this, "autolaunch", $items[0]);
                                $api_link = $this->ctrl->getLinkTarget($this, "api");
                                $this->tpl->setVariable("API_LINK", $api_link);
                                $pres_link = $this->ctrl->getLinkTarget($this, "view");
                                $this->tpl->setVariable("PRESENTATION_LINK", $pres_link);
                                $this->tpl->show("DEFAULT", false);
                        }
                } else {
                        $debug = $this->slm->getDebug();
                        $template = "tpl.sahs_pres_frameset_js";
                        if ($debug) $template .= "_debug";
                        if (count($items) > 1
                                || strtolower(get_class($this->slm)) == "ilobjaicclearningmodule"
                                || strtolower(get_class($this->slm)) == "ilobjhacplearningmodule")
                        {
                                $template .= ".html";
                                $this->ctrl->setParameter($this, "expand", "1");
                                $this->ctrl->setParameter($this, "jsApi", "1");
                                $exp_link = $this->ctrl->getLinkTarget($this, "explorer");
                                $this->tpl = new ilTemplate($template, 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 {
                                $template .= "_one_page.html";
                                $this->tpl = new ilTemplate($template, false, false, "Modules/ScormAicc");
                                $this->ctrl->setParameter($this, "autolaunch", $items[0]);
                        }
                        $api_link = $this->ctrl->getLinkTarget($this, "apiInitData");
                        $this->tpl->setVariable("API_LINK", $api_link);
                        $this->tpl->show("DEFAULT", false);
                }
                
                exit;
                
        }

Here is the call graph for this function:

ilSCORMPresentationGUI::get_actual_attempts ( )

Get number of actual attempts for the user.

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

References $ilDB.

Referenced by frameset().

                                       {
                global $ilDB, $ilUser;
                $val_set = $ilDB->queryF('
                        SELECT * FROM scorm_tracking 
                        WHERE user_id =  %s
                        AND sco_id = %s
                        AND lvalue= %s
                        AND obj_id = %s',
                        array('integer','integer','text','integer'),
                        array($ilUser->getId(),0,'package_attempts',$this->slm->getId())
                );
                $val_rec = $ilDB->fetchAssoc($val_set); 
                
                $val_rec["rvalue"] = str_replace("\r\n", "\n", $val_rec["rvalue"]);
                if ($val_rec["rvalue"] == null) {
                        $val_rec["rvalue"]=0;
                }
                return $val_rec["rvalue"];
        }

Here is the caller graph for this function:

ilSCORMPresentationGUI::get_max_attempts ( )

Get max.

number of attempts allowed for this package

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

References $ilDB.

Referenced by frameset().

                                    {
                
                global $ilDB;
                
                $val_set = $ilDB->queryF('SELECT * FROM sahs_lm WHERE id = %s',
                array('integer'), array($this->slm->getId()));
                $val_rec = $ilDB->fetchAssoc($val_set);
                
                return $val_rec["max_attempt"]; 
        }

Here is the caller graph for this function:

ilSCORMPresentationGUI::ilSCORMPresentationGUI ( )

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

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

        {
                global $ilias, $tpl, $lng, $ilCtrl;
                $this->ilias =& $ilias;
                $this->tpl =& $tpl;
                $this->lng =& $lng;
                $this->ctrl =& $ilCtrl;
                // Todo: check lm id
                $this->slm =& new ilObjSCORMLearningModule($_GET["ref_id"], true);
        }

ilSCORMPresentationGUI::increase_attempt ( )

Increases attempts by one for this package.

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

References $ilDB, ilLPStatusWrapper\_updateStatus(), and ilUtil\now().

Referenced by frameset().

                                    {
                global $ilDB, $ilUser;
                
                //get existing account - sco id is always 0
                $val_set = $ilDB->queryF('
                        SELECT * FROM scorm_tracking 
                        WHERE user_id =  %s
                        AND sco_id = %s
                        AND lvalue= %s
                        AND obj_id = %s',
                        array('integer','integer','text','integer'),
                        array($ilUser->getId(),0,'package_attempts',$this->slm->getId())
                        );
                $val_rec = $ilDB->fetchAssoc($val_set);         
                
                $val_rec["rvalue"] = str_replace("\r\n", "\n", $val_rec["rvalue"]);
                if ($val_rec["rvalue"] == null) {
                        $val_rec["rvalue"]=0;
                }
                $new_rec =  $val_rec["rvalue"]+1;
                //increase attempt by 1
                if($ilDB->numRows($val_set) > 0)
                {
                        $ilDB->update('scorm_tracking',
                                array(
                                        'rvalue'                => array('clob', $new_rec),
                                        'c_timestamp'   => array('timestamp', ilUtil::now())
                                ),
                                array(
                                        'user_id'               => array('integer', $ilUser->getId()),
                                        'sco_id'                => array('integer', 0),
                                        'lvalue'                => array('text', 'package_attempts'),
                                        'obj_id'                => array('integer', $this->slm->getId())
                                )
                        );
                }
                else
                {
                        $ilDB->insert('scorm_tracking', array(
                                'obj_id'                => array('integer', $this->slm->getId()),
                                'user_id'               => array('integer', $ilUser->getId()),
                                'sco_id'                => array('integer', 0),
                                'lvalue'                => array('text', 'package_attempts'),
                                'rvalue'                => array('clob', $new_rec),
                                'c_timestamp'   => array('timestamp', ilUtil::now())
                        ));
                }
                
                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:

ilSCORMPresentationGUI::launchAsset ( )

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

References $_GET, $_POST, $ilDB, and $ref_id.

        {
                global $ilUser, $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 ilTemplate("tpl.scorm_launch_asset.html", true, true, "Modules/ScormAicc");
                $this->tpl->setVariable("HREF", $this->slm->getDataDirectory("output")."/".$href);
                $this->tpl->show();
        }

ilSCORMPresentationGUI::launchSahs ( )

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

Reimplemented in ilAICCPresentationGUI, and ilHACPPresentationGUI.

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

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

        {
                global $ilUser, $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 ilTemplate("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 $lng;
                $this->tpl->setCurrentBlock("switch_icon");
                $this->tpl->setVariable("SCO_ID", $_GET["sahs_id"]);
                $this->tpl->setVariable("SCO_ICO", ilUtil::getImagePath("scorm/running.gif"));
                $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
                        || strtolower(get_class($this->slm)) == "ilobjaicclearningmodule"
                        || strtolower(get_class($this->slm)) == "ilobjhacplearningmodule")
                {
                        $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->show();
                //echo htmlentities($this->tpl->get()); exit;
        }

Here is the call graph for this function:

ilSCORMPresentationGUI::logMessage ( )

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

References $ilLog.

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

ilSCORMPresentationGUI::logWarning ( )

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

References $ilLog.

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

ilSCORMPresentationGUI::pingSession ( )

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

        {
                return true;
        }

ilSCORMPresentationGUI::save_module_version ( )

save the active module version to scorm_tracking

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

References $ilDB, ilLPStatusWrapper\_updateStatus(), and ilUtil\now().

Referenced by frameset().

                                       {
                global $ilDB, $ilUser;
                
                $val_set = $ilDB->queryF('
                        SELECT * FROM scorm_tracking 
                        WHERE user_id =  %s
                        AND sco_id = %s
                        AND lvalue= %s
                        AND obj_id = %s',
                        array('integer','integer','text','integer'),
                        array($ilUser->getId(),0,'module_version',$this->slm->getId())
                        );
                
                if($ilDB->numRows($val_set) > 0)
                {
                        $ilDB->update('scorm_tracking',
                                array(
                                        'rvalue'                => array('clob', $this->slm->getModuleVersion()),
                                        'c_timestamp'   => array('timestamp', ilUtil::now())
                                ),
                                array(
                                        'user_id'               => array('integer', $ilUser->getId()),
                                        'sco_id'                => array('integer', 0),
                                        'lvalue'                => array('text', 'module_version'),
                                        'obj_id'                => array('integer', $this->slm->getId())
                                )
                        );
                }
                else
                {
                        $ilDB->insert('scorm_tracking', array(
                                'obj_id'                => array('integer', $this->slm->getId()),
                                'user_id'               => array('integer', $ilUser->getId()),
                                'sco_id'                => array('integer', 0),
                                'lvalue'                => array('text', 'module_version'),
                                'rvalue'                => array('clob', $this->slm->getModuleVersion()),
                                'c_timestamp'   => array('timestamp', ilUtil::now())
                        ));
                }
                
                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:

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

set single value

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

Referenced by ilHACPPresentationGUI\launchSahs(), ilAICCPresentationGUI\launchSahs(), and 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:

ilSCORMPresentationGUI::setSingleVariable	(	$a_var,
		$a_value
	)

set single value

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

Referenced by ilHACPPresentationGUI\launchSahs(), ilAICCPresentationGUI\launchSahs(), and 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:

ilSCORMPresentationGUI::unloadSahs ( )

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

References $_GET, and ilUtil\getStyleSheetLocation().

        {
                $this->tpl = new ilTemplate("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->show();
        }

Here is the call graph for this function:

ilSCORMPresentationGUI::view ( )

SCORM content screen.

Reimplemented in ilAICCPresentationGUI.

Definition at line 365 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->show(false);
        }