class.ilSoapSCORMAdministration.php

Go to the documentation of this file.

<?php
class ilSoapSCORMAdministration extends ilSoapAdministration
{
    public function getIMSManifestXML(string $sid, int $requested_ref_id)
    {
        $this->initAuth($sid);
        $this->initIlias();

        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
        if (!($requested_ref_id > 0)) {
            return $this->raiseError(
                'No ref id given. Aborting!',
                'Client'
            );
        }
        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];
        $tree = $DIC['tree'];
        $ilLog = $DIC['ilLog'];

        if (!$obj_id = ilObject::_lookupObjectId($requested_ref_id)) {
            return $this->raiseError(
                'No exercise found for id: ' . $requested_ref_id,
                'Client'
            );
        }

        if (ilObject::_isInTrash($requested_ref_id)) {
            return $this->raiseError("Parent with ID $requested_ref_id has been deleted.", 'Client');
        }

        $permission_ok = false;
        foreach ($ref_ids = ilObject::_getAllReferences($obj_id) as $ref_id) {
            if ($rbacsystem->checkAccess('read', $ref_id)) {
                $permission_ok = true;
                break;
            }
        }

        if (!$permission_ok) {
            return $this->raiseError(
                'No permission to read the object with id: ' . $requested_ref_id,
                'Server'
            );
        }

        $lm_obj = ilObjectFactory::getInstanceByObjId($obj_id, false);
        if (!is_object($lm_obj) || $lm_obj->getType() !== "sahs") {
            return $this->raiseError(
                'Wrong obj id or type for scorm object with id ' . $requested_ref_id,
                'Server'
            );
        }

        $imsFilename = $lm_obj->getDataDirectory() . DIRECTORY_SEPARATOR . "imsmanifest.xml";

        if (!file_exists($imsFilename)) {
            return $this->raiseError(
                'Could not find manifest file for object with ref id ' . $requested_ref_id,
                'Server'
            );
        }
        return file_get_contents($imsFilename);
    }

    public function hasSCORMCertificate(string $sid, int $ref_id, int $usr_id)
    {
        $this->initAuth($sid);
        $this->initIlias();

        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
        if (!($ref_id > 0)) {
            return $this->raiseError(
                'No ref id given. Aborting!',
                'Client'
            );
        }
        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];
        $tree = $DIC['tree'];
        $ilLog = $DIC['ilLog'];

        if (!$obj_id = ilObject::_lookupObjectId($ref_id)) {
            return $this->raiseError(
                'No exercise found for id: ' . $ref_id,
                'Client'
            );
        }

        if (ilObject::_isInTrash($ref_id)) {
            return $this->raiseError("Parent with ID $ref_id has been deleted.", 'Client');
        }

        $certValidator = new ilCertificateUserCertificateAccessValidator();

        return $certValidator->validate($usr_id, $obj_id);
    }

    public function getSCORMCompletionStatus(string $sid, int $a_usr_id, int $a_ref_id)
    {
        $this->initAuth($sid);
        $this->initIlias();

        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }

        if (!($a_ref_id > 0)) {
            return $this->raiseError('No ref_id given. Aborting!', 'Client');
        }

        ilInitialisation::initILIAS();

        if (!$obj_id = ilObject::_lookupObjectId($a_ref_id)) {
            return $this->raiseError(
                'No scorm module found for id: ' . $a_ref_id,
                'Client'
            );
        }

        if (!ilObjUserTracking::_enabledLearningProgress()) {
            return $this->raiseError('Learning progress not enabled in this installation. Aborting!', 'Server');
        }

        $status = ilLPStatus::_lookupStatus($obj_id, $a_usr_id);
        if ($status === ilLPStatus::LP_STATUS_COMPLETED_NUM) {
            return 'completed';
        } elseif ($status === ilLPStatus::LP_STATUS_FAILED_NUM) {
            return 'failed';
        } elseif ($status === ilLPStatus::LP_STATUS_IN_PROGRESS_NUM) {
            return 'in_progress';
        } else {
            return 'not_attempted';
        }
    }
}