Inheritance diagram for ilSoapSCORMAdministration:

Collaboration diagram for ilSoapSCORMAdministration:

Public Member Functions
	ilSoapExerciseAdministration ()

	getIMSManifestXML ($sid, $ref_id)
	get ims manifest xml More...

	hasSCORMCertificate ($sid, $ref_id, $usr_id)

	getSCORMCompletionStatus ($sid, $a_usr_id, $a_ref_id)

Public Member Functions inherited from ilSoapAdministration
	ilSoapAdministration ($use_nusoap=true)

	initErrorWriter ()
	Overwrite error handler. More...

	__explodeSid ($sid)

	__setMessage ($a_str)

	__getMessage ()

	__appendMessage ($a_str)

	__setMessageCode ($a_code)

	__getMessageCode ()

	initAuth ($sid)

	initIlias ()

	__initAuthenticationObject ($a_auth_mode=AUTH_LOCAL)

	__raiseError ($a_message, $a_code)

	getNIC ($sid)
	get client information from current as xml result set More...

	isFault ($object)

	checkObjectAccess ($ref_id, $expected_type, $permission, $returnObject=false)
	check access for ref id: expected type, permission, return object instance if returnobject is true More...

	getInstallationInfoXML ()

	getClientInfoXML ($clientid)

Additional Inherited Members
Static Public Member Functions inherited from ilSoapAdministration
static	return_bytes ($val)
	calculate bytes from K,M,G modifiers e.g: 8M = 8 * 1024 * 1024 bytes More...

Data Fields inherited from ilSoapAdministration
	$sauth = null

	$error_method = null

Protected Attributes inherited from ilSoapAdministration
	$soap_check = true

Detailed Description

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

Member Function Documentation

◆ getIMSManifestXML()

ilSoapSCORMAdministration::getIMSManifestXML	(	$sid,
		$ref_id
	)

get ims manifest xml

Parameters

string	$sid
int	$ref_id

Returns: xml following scorm.dtd

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

        {
                $this->initAuth($sid);
                $this->initIlias();
                
                if(!$this->__checkSession($sid))
                {
                        return $this->__raiseError($this->__getMessage(),$this->__getMessageCode());
                }
                if(!strlen($ref_id))
                {
                        return $this->__raiseError('No ref id given. Aborting!',
                                                                           'Client');
                }
                global $rbacsystem, $tree, $ilLog;
 
                // get obj_id
                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');
                }
 
                // Check access
                $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: '.$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 '.$ref_id,
                                                                           'Server');
                }
                // get scorm xml
                require_once("./Modules/ScormAicc/classes/SCORM/class.ilSCORMObject.php");
                require_once("./Modules/ScormAicc/classes/SCORM/class.ilSCORMResource.php");
 
                $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 '.$ref_id,
                                                                           'Server');
                        
                }
                return file_get_contents($imsFilename);
        }

References $ilLog, $ref_id, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObject\_getAllReferences(), ilObject\_isInTrash(), ilObject\_lookupObjectId(), ilObjectFactory\getInstanceByObjId(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

Here is the call graph for this function:

◆ getSCORMCompletionStatus()

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

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

        {
                $this->initAuth($sid);
                $this->initIlias();
                
                if(!$this->__checkSession($sid))
                {
                        return $this->__raiseError($this->__getMessage(),$this->__getMessageCode());
                }
 
                if(!strlen($a_ref_id))
                {
                        return $this->__raiseError('No ref_id given. Aborting!', 'Client');
                }
                
                include_once 'include/inc.header.php';
                
                // get obj_id
                if(!$obj_id = ilObject::_lookupObjectId($a_ref_id))
                {
                        return $this->__raiseError('No scorm module found for id: '.$a_ref_id,
                                                                           'Client');
                }       
                
                include_once 'Services/Tracking/classes/class.ilLPStatus.php';          
                include_once 'Services/Tracking/classes/class.ilObjUserTracking.php';
                
                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';
                }
                else if($status == ilLPStatus::LP_STATUS_FAILED_NUM)
                {
                        return 'failed';
                }
                else if($status == ilLPStatus::LP_STATUS_IN_PROGRESS_NUM)
                {
                        return 'in_progress';
                }
                else
                {
                        return 'not_attempted';
                }
        }

References ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObjUserTracking\_enabledLearningProgress(), ilObject\_lookupObjectId(), ilLPStatus\_lookupStatus(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, and ilLPStatus\LP_STATUS_IN_PROGRESS_NUM.

Here is the call graph for this function:

◆ hasSCORMCertificate()

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

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

        {
                $this->initAuth($sid);
                $this->initIlias();
 
                if(!$this->__checkSession($sid))
                {
                        return $this->__raiseError($this->__getMessage(),$this->__getMessageCode());
                }
                if(!strlen($ref_id))
                {
                        return $this->__raiseError('No ref id given. Aborting!',
                                                                           'Client');
                }
                global $rbacsystem, $tree, $ilLog;
 
                // get obj_id
                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');
                }
 
                $result = false;
                include_once("./Modules/ScormAicc/classes/class.ilObjSAHSLearningModuleAccess.php");
                $result = ilObjSAHSLearningModuleAccess::_lookupUserCertificate($obj_id, $usr_id);
 
                return $result;
        }

References $ilLog, $ref_id, $result, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObject\_isInTrash(), ilObject\_lookupObjectId(), ilObjSAHSLearningModuleAccess\_lookupUserCertificate(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

Here is the call graph for this function:

◆ ilSoapExerciseAdministration()

ilSoapSCORMAdministration::ilSoapExerciseAdministration ( )

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

        {
                parent::ilSoapAdministration();
        }

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

webservice/soap/classes/class.ilSoapSCORMAdministration.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getIMSManifestXML()

◆ getSCORMCompletionStatus()

◆ hasSCORMCertificate()

◆ ilSoapExerciseAdministration()