ilSoapSCORMAdministration Class Reference

Inheritance diagram for ilSoapSCORMAdministration:

Collaboration diagram for ilSoapSCORMAdministration:

Public Member Functions
	getIMSManifestXML (string $sid, int $requested_ref_id)
	hasSCORMCertificate (string $sid, int $ref_id, int $usr_id)
	getSCORMCompletionStatus (string $sid, int $a_usr_id, int $a_ref_id)
Public Member Functions inherited from ilSoapAdministration
	__construct (bool $use_nusoap=true)
	getMessage ()
	appendMessage (string $a_str)
	setMessageCode (string $a_code)
	getMessageCode ()
	reInitUser ()
	isFault ($object)
	getInstallationInfoXML ()
	getClientInfoXML (string $clientid)

Additional Inherited Members
Data Fields inherited from ilSoapAdministration
const	NUSOAP = 1
const	PHP5 = 2
int	$error_method
	Defines type of error handling (PHP5 || NUSOAP) More...
Protected Member Functions inherited from ilSoapAdministration
	checkSession (string $sid)
	explodeSid (string $sid)
	setMessage (string $a_str)
	initAuth (string $sid)
	initIlias ()
	initAuthenticationObject ()
	raiseError (string $a_message, $a_code)
	checkObjectAccess (int $ref_id, array $expected_type, string $permission, bool $returnObject=false)
	check access for ref id: expected type, permission, return object instance if returnobject is true More...
Protected Attributes inherited from ilSoapAdministration
bool	$soap_check = true
string	$message = ''
string	$message_code = ''

Detailed Description

Definition at line 24 of file class.ilSoapSCORMAdministration.php.

Member Function Documentation

getIMSManifestXML()

ilSoapSCORMAdministration::getIMSManifestXML	(	string	$sid,
		int	$requested_ref_id
	)

Returns

false|soap_fault|SoapFault|string|null

Definition at line 29 of file class.ilSoapSCORMAdministration.php.

References $DIC, $ref_id, ilObject\_getAllReferences(), ilObject\_isInTrash(), ilObject\_lookupObjectId(), ilSoapAdministration\checkSession(), ilObjectFactory\getInstanceByObjId(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

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

Here is the call graph for this function:

getSCORMCompletionStatus()

ilSoapSCORMAdministration::getSCORMCompletionStatus	(	string	$sid,
		int	$a_usr_id,
		int	$a_ref_id
	)

Returns

soap_fault|SoapFault|string|null

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

References ilObjUserTracking\_enabledLearningProgress(), ilObject\_lookupObjectId(), ilLPStatus\_lookupStatus(), ilSoapAdministration\checkSession(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), ilInitialisation\initILIAS(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilSoapAdministration\raiseError().

    {
        $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';
        }
    }

Here is the call graph for this function:

hasSCORMCertificate()

ilSoapSCORMAdministration::hasSCORMCertificate	(	string	$sid,
		int	$ref_id,
		int	$usr_id
	)

Returns

bool|soap_fault|SoapFault|null

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

References $DIC, ilObject\_isInTrash(), ilObject\_lookupObjectId(), ilSoapAdministration\checkSession(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

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

Here is the call graph for this function:

---

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

• components/ILIAS/soap/classes/class.ilSoapSCORMAdministration.php