Collaboration diagram for ilSCORMPresentationGUI:

Public Member Functions
	__construct ()

	executeCommand ()
	execute command More...

	attrib2arr (?array $a_attributes)

	frameset ()
	Output main frameset. 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 (string $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...

	pingSession ()

	logMessage ()

	logWarning ()

	downloadCertificate ()
	Download the certificate for the active user. More...

Data Fields
ilObjSCORMLearningModule	$slm

ilGlobalTemplate	$tpl

ilLanguage	$lng

Protected Attributes
ilLogger	$logger

int	$refId

ilCtrlInterface	$ctrl

Private Member Functions
	getApiLogPayload ()

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

Constructor & Destructor Documentation

◆ __construct()

ilSCORMPresentationGUI::__construct ( )

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

    {
        global $DIC;
        $ilCtrl = $DIC->ctrl();
        //        $this->tpl = $DIC['tpl'];
        $this->lng = $DIC->language();
        $this->ctrl = $ilCtrl;
        $this->logger = ilLoggerFactory::getLogger('sahs');
 
        $this->lng->loadLanguageModule('cert');
 
        // Todo: check lm id
        $this->refId = $DIC->http()->wrapper()->query()->retrieve('ref_id', $DIC->refinery()->kindlyTo()->int());
        $this->slm = new ilObjSCORMLearningModule($this->refId, true);
    }

References $DIC, ILIAS\Repository\ctrl(), ilLoggerFactory\getLogger(), ILIAS\Repository\lng(), and ILIAS\Repository\logger().

Here is the call graph for this function:

Member Function Documentation

◆ apiInitData()

ilSCORMPresentationGUI::apiInitData ( )

SCORM Data for Javascript-API.

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

                                 : void
    {
        global $DIC;
 
        if (!($DIC->http()->wrapper()->query()->has('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("../components/ILIAS/ScormAicc/scripts/basisAPI.js");
        echo $js_data;
        $js_data = file_get_contents("../components/ILIAS/ScormAicc/scripts/SCORM1_2standard.js");//want to give opportunities to different files (Uwe Kohnle)
        echo $js_data;
        print("}\r\n");
 
        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();');
        }
    }

References $DIC, ilObjSCORMInitData\getIliasScormData(), ilObjSCORMInitData\getIliasScormResources(), ilObjSCORMInitData\getIliasScormTree(), ilObjSCORMInitData\getIliasScormVars(), and ILIAS\UI\examples\Symbol\Glyph\Header\header().

Here is the call graph for this function:

◆ attrib2arr()

ilSCORMPresentationGUI::attrib2arr ( ?array $a_attributes )

Returns: mixed[]

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

                                                    : array
    {
        $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 441 of file class.ilSCORMPresentationGUI.php.

                                   : void
    {
        global $DIC;
        $lng = $DIC->language();
        $this->tpl = new ilGlobalTemplate("tpl.scorm_content_select.html", true, true, "components/ILIAS/ScormAicc");
        $this->tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
        $this->tpl->setVariable('TXT_SPECIALPAGE', $lng->txt("seq_toc"));
        $this->tpl->printToStdout("DEFAULT", false);
    }

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

Here is the call graph for this function:

◆ downloadCertificate()

ilSCORMPresentationGUI::downloadCertificate ( )

Download the certificate for the active user.

Exceptions

ilCtrlException

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

                                         : void
    {
        global $DIC;
 
        $ilUser = $DIC->user();
        $tree = $DIC['tree'];
        $ilCtrl = $DIC->ctrl();
        $refId = $DIC->http()->wrapper()->query()->retrieve('ref_id', $DIC->refinery()->kindlyTo()->int());
        $obj_id = ilObject::_lookupObjId($refId);
 
        $certValidator = new ilCertificateDownloadValidator();
        $allowed = $certValidator->isCertificateDownloadable($ilUser->getId(), $obj_id);
        if ($allowed) {
            $certificateLogger = $DIC->logger()->forComponent('sahs');
 
            $ilUserCertificateRepository = new ilUserCertificateRepository();
            $pdfGenerator = new ilPdfGenerator($ilUserCertificateRepository);
            $pdfAction = new ilCertificatePdfAction(
                $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($refId);
        $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $parent);
        $ilCtrl->redirectByClass("ilrepositorygui", "");
    }

References $DIC, $refId, ilObject\_lookupObjId(), exit, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ executeCommand()

ilSCORMPresentationGUI::executeCommand ( )

execute command

Exceptions

ilCtrlException

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

                                    : void
    {
        global $DIC;
        $ilAccess = $DIC->access();
        $lng = $DIC->language();
        $ilErr = $DIC["ilErr"];
 
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd("frameset");
 
        if (!$ilAccess->checkAccess("write", "", $this->refId) &&
            (!$ilAccess->checkAccess("read", "", $this->refId) ||
            $this->slm->getOfflineStatus())) {
            $ilErr->raiseError($lng->txt("permission_denied"), $ilErr->WARNING);
        }
 
        //        switch ($next_class) {
        //            default:
        $this->$cmd();
        //        }
    }

References $DIC, $lng, ILIAS\Repository\ctrl(), and ilLanguage\txt().

Here is the call graph for this function:

◆ explorer()

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

save the active module version to scorm_tracking

output table of content

Exceptions

ilCtrlException
ilTemplateException

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

                                                               : void
    {
        global $DIC;
        $ilBench = $DIC['ilBench'];
 
        $ilBench->start("SCORMExplorer", "initExplorer");
 
        $this->tpl = new ilGlobalTemplate("tpl.sahs_exp_main.html", true, true, "components/ILIAS/ScormAicc");
        //        $this->tpl = new ilTemplate("tpl.sahs_exp_main.html", true, true, "components/ILIAS/ScormAicc");
        $exp = new ilSCORMExplorer($this->ctrl->getLinkTarget($this, "view"), $this->slm);
        $exp->setTargetGet("obj_id");
        $exp->setFrameTarget($a_target);
 
        //$exp->setFiltered(true);
        $jsApi = true;
 
        $expanded = "";
        if ($DIC->http()->wrapper()->query()->has('scexpand')) {
            $expanded = $DIC->http()->wrapper()->query()->retrieve('scexpand', $DIC->refinery()->kindlyTo()->string());
        }
        if ($expanded == "") {
            $mtree = new ilSCORMTree($this->slm->getId());
            $expanded = $mtree->readRootId();
        }
        $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", "components/ILIAS/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);
 
        $cmd = "";
        if ($DIC->http()->wrapper()->query()->has('cmd')) {
            $cmd = $DIC->http()->wrapper()->query()->retrieve('cmd', $DIC->refinery()->kindlyTo()->string());
        }
        $frame = "";
        if ($DIC->http()->wrapper()->query()->has('frame')) {
            $frame = $DIC->http()->wrapper()->query()->retrieve('frame', $DIC->refinery()->kindlyTo()->string());
        }
        $this->tpl->setVariable("ACTION", "ilias.php?baseClass=ilSAHSPresentationGUI&cmd=" . $cmd . "&frame=" . $frame .
            "&ref_id=" . $this->slm->getRefId() . "&scexpand=" . $expanded);
        $this->tpl->parseCurrentBlock();
        //BUG 16794? $this->tpl->show();
        //        $this->tpl->show();
        $this->tpl->printToStdout("DEFAULT", false);
    }

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

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.

Exceptions

ilCtrlException

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

                              : void
    {
        global $DIC;
        $lng = $DIC->language();
        $javascriptAPI = true;
        $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();
        if (!$this->slm->hasContainerResource()) {
            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, "components/ILIAS/ScormAicc");
            } else {
                $this->tpl = new ilGlobalTemplate("tpl.sahs_pres_frameset_js.html", false, false, "components/ILIAS/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, "components/ILIAS/ScormAicc");
            } else {
                $this->tpl = new ilGlobalTemplate("tpl.sahs_pres_frameset_js_one_page.html", false, false, "components/ILIAS/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("ICON", ilUtil::getImagePath("favicon.ico", ""));
        $this->tpl->setVariable("API_LINK", $api_link);
        $this->tpl->printToStdout("DEFAULT", false, true);
 
 
        exit;
    }

References $DIC, $lng, ilSCORMObject\_lookupPresentableItems(), ILIAS\Repository\ctrl(), exit, ilUtil\getImagePath(), increase_attemptAndsave_module_version(), and ilWACSignedPath\signFolderOfStartFile().

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

                                         : int
    {
        global $DIC;
        $ilDB = $DIC->database();
        $ilUser = $DIC->user();
        $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;
    }

References $DIC, and $ilDB.

◆ getApiLogPayload()

ilSCORMPresentationGUI::getApiLogPayload ( )

private

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

                                       : string
    {
        $payload = (string) file_get_contents('php://input');
        return substr(str_replace(["\r", "\n"], ["\\r", "\\n"], $payload), 0, 4096);
    }

Referenced by logMessage(), and logWarning().

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

                                                            : void
    {
        global $DIC;
        $ilDB = $DIC->database();
        $ilUser = $DIC->user();
        $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 (!is_array($val_rec)) {
            $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())
            );
        }
        ilLPStatusWrapper::_updateStatus($this->slm->getId(), $ilUser->getId());
    }

References $DIC, $ilDB, $res, ilLPStatusWrapper\_updateStatus(), and ILIAS\UI\examples\Symbol\Glyph\Date\date().

Referenced by frameset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ logMessage()

ilSCORMPresentationGUI::logMessage ( )

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

                                : void
    {
        $this->logger->info("ScormAicc: ApiLog: Message: " . $this->getApiLogPayload());
    }

References getApiLogPayload(), and ILIAS\Repository\logger().

Here is the call graph for this function:

◆ logWarning()

ilSCORMPresentationGUI::logWarning ( )

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

                                : void
    {
        $this->logger->warning("ScormAicc: ApiLog: Warning: " . $this->getApiLogPayload());
    }

References getApiLogPayload(), and ILIAS\Repository\logger().

Here is the call graph for this function:

◆ pingSession()

ilSCORMPresentationGUI::pingSession ( )

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

                                 : bool
    {
        if (!$this->slm->hasContainerResource()) {
            ilWACSignedPath::signFolderOfStartFile($this->slm->getDataDirectory() . '/imsmanifest.xml');
        }
        return true;
    }

References ilWACSignedPath\signFolderOfStartFile().

Here is the call graph for this function:

◆ view()

ilSCORMPresentationGUI::view ( )

SCORM content screen.

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

                          : void
    {
        global $DIC;
        $objId = $DIC->http()->wrapper()->query()->retrieve('obj_id', $DIC->refinery()->kindlyTo()->int());
        $sc_gui_object = ilSCORMObjectGUI::getInstance($objId);
 
        if (is_object($sc_gui_object)) {
            $sc_gui_object->view();
        }
 
        $this->tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
        $this->tpl->printToStdout('DEFAULT', false);
    }