This class handles all DB changes necessary for fraunhofer. More...

Inheritance diagram for ilSoapLearningProgressAdministration:

Collaboration diagram for ilSoapLearningProgressAdministration:

Public Member Functions
	getProgressInfo ($sid, $a_ref_id, $a_progress_filter)

	getLearningProgressChanges ($sid, $timestamp, $include_ref_ids, $type_filter)
	Get learning progress changes. More...

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)

Data Fields
const	PROGRESS_FILTER_ALL = 0

const	PROGRESS_FILTER_IN_PROGRESS = 1

const	PROGRESS_FILTER_COMPLETED = 2

const	PROGRESS_FILTER_FAILED = 3

const	PROGRESS_FILTER_NOT_ATTEMPTED = 4

const	SOAP_LP_ERROR_AUTHENTICATION = 50

const	SOAP_LP_ERROR_INVALID_FILTER = 52

const	SOAP_LP_ERROR_INVALID_REF_ID = 54

const	SOAP_LP_ERROR_LP_NOT_AVAILABLE = 56

const	SOAP_LP_ERROR_NO_PERMISSION = 58

const	SOAP_LP_ERROR_LP_NOT_ENABLED = 60

const	USER_FILTER_ALL = -1

Data Fields inherited from ilSoapAdministration
	$sauth = null

	$error_method = null

Protected Member Functions
	addUserProgress (ilXmlWriter $writer, $users, $a_type)

	applyProgressFilter ($obj_id, Array $usr_ids, Array $filter)
	Apply progress filter. More...

	deleteScormTracking ($a_obj_id, $a_usr_ids)
	Delete SCORM Tracking @global type $ilDB. More...

	deleteScorm2004Tracking ($a_obj_id, $a_usr_ids)
	Delete scorm 2004 tracking. More...

Static Protected Attributes
static	$DELETE_PROGRESS_FILTER_TYPES = array('sahs', 'tst')

static	$PROGRESS_INFO_TYPES

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...

Protected Attributes inherited from ilSoapAdministration
	$soap_check = true

Detailed Description

This class handles all DB changes necessary for fraunhofer.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 14 of file class.ilSoapLearningProgressAdministration.php.

Member Function Documentation

◆ addUserProgress()

ilSoapLearningProgressAdministration::addUserProgress	(	ilXmlWriter	$writer,
			$users,
			$a_type
	)

protected

Definition at line 311 of file class.ilSoapLearningProgressAdministration.php.

        {
                foreach($users  as $user_id)
                {
                        $writer->xmlStartTag(
                                        'User',
                                        array(
                                                'id' => $user_id,
                                                'status' => $a_type
                                        )
                        );
                        
                        $info = ilObjUser::_lookupName($user_id);
                        $writer->xmlElement('Login',array(),(string) $info['login']);
                        $writer->xmlElement('Firstname',array(),(string) $info['firstname']);
                        $writer->xmlElement('Lastname',array(),(string) $info['lastname']);
                        $writer->xmlEndTag('User');
                        
                }
        }

References $info, ilObjUser\_lookupName(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by getProgressInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyProgressFilter()

ilSoapLearningProgressAdministration::applyProgressFilter	(		$obj_id,
		Array	$usr_ids,
		Array	$filter
	)

protected

Apply progress filter.

Parameters

int	$obj_id
array	$usr_ids
array	$filter

Returns: array $filtered_users

Definition at line 341 of file class.ilSoapLearningProgressAdministration.php.

        {
                include_once './Services/Tracking/classes/class.ilLPStatusWrapper.php';
                
 
                $all_users = array();
                if(in_array(self::USER_FILTER_ALL, $usr_ids))
                {
                        $all_users = array_unique(
                                        array_merge(
                                                ilLPStatusWrapper::_getInProgress($obj_id),
                                                ilLPStatusWrapper::_getCompleted($obj_id),
                                                ilLPStatusWrapper::_getFailed($obj_id)
                                        )
                                );
                }
                else
                {
                        $all_users = $usr_ids;
                }
 
                if(!$filter or in_array(self::PROGRESS_FILTER_ALL, $filter))
                {
                        $GLOBALS['log']->write(__METHOD__.': Deleting all progress data');
                        return $all_users;
                }
                
                $filter_users = array();
                if(in_array(self::PROGRESS_FILTER_IN_PROGRESS, $filter))
                {
                        $GLOBALS['log']->write(__METHOD__.': Filtering  in progress.');
                        $filter_users = array_merge($filter, ilLPStatusWrapper::_getInProgress($obj_id));
                }
                if(in_array(self::PROGRESS_FILTER_COMPLETED, $filter))
                {
                        $GLOBALS['log']->write(__METHOD__.': Filtering  completed.');
                        $filter_users = array_merge($filter, ilLPStatusWrapper::_getCompleted($obj_id));
                }
                if(in_array(self::PROGRESS_FILTER_FAILED, $filter))
                {
                        $GLOBALS['log']->write(__METHOD__.': Filtering  failed.');
                        $filter_users = array_merge($filter, ilLPStatusWrapper::_getFailed($obj_id));
                }
                
                // Build intersection
                return array_intersect($all_users, $filter_users);
        }

References $GLOBALS, ilLPStatusWrapper\_getCompleted(), ilLPStatusWrapper\_getFailed(), and ilLPStatusWrapper\_getInProgress().

Here is the call graph for this function:

◆ deleteScorm2004Tracking()

ilSoapLearningProgressAdministration::deleteScorm2004Tracking	(	$a_obj_id,
		$a_usr_ids
	)

protected

Delete scorm 2004 tracking.

Parameters

type	$a_obj_id
type	$a_usr_ids

Definition at line 412 of file class.ilSoapLearningProgressAdministration.php.

        {
                global $ilDB;
                
                $query = 'SELECT cp_node_id FROM cp_node '.
                        'WHERE nodename = '. $ilDB->quote('item','text').' '.
                        'AND cp_node.slm_id = '.$ilDB->quote($a_obj_id,'integer');
                $res = $ilDB->query($query);
                
                $scos = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $scos[] = $row->cp_node_id;
                }
                
                $query = 'DELETE FROM cmi_node '.
                                'WHERE '.$ilDB->in('user_id',(array) $a_usr_ids,false,'integer').' '.
                                'AND '.$ilDB->in('cp_node_id',$scos,false,'integer');
                $ilDB->manipulate($query);
        
        }

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

◆ deleteScormTracking()

ilSoapLearningProgressAdministration::deleteScormTracking	(	$a_obj_id,
		$a_usr_ids
	)

protected

Delete SCORM Tracking @global type $ilDB.

Parameters

type	$a_obj_id
type	$a_usr_ids

Returns: boolean

Definition at line 396 of file class.ilSoapLearningProgressAdministration.php.

        {
                global $ilDB;
                
                $query = 'DELETE FROM scorm_tracking '.
                        'WHERE '.$ilDB->in('user_id',$a_usr_ids,false,'integer').' '.
                        'AND obj_id = '. $ilDB->quote($a_obj_id,'integer').' ';
                $res = $ilDB->manipulate($query);
                return true;
        }

References $ilDB, $query, and $res.

◆ getLearningProgressChanges()

ilSoapLearningProgressAdministration::getLearningProgressChanges	(	$sid,
		$timestamp,
		$include_ref_ids,
		$type_filter
	)

Get learning progress changes.

Definition at line 437 of file class.ilSoapLearningProgressAdministration.php.

        {
                $this->initAuth($sid);
                $this->initIlias();
 
                if(!$this->__checkSession($sid))
                {
                        return $this->__raiseError($this->__getMessage(),$this->__getMessageCode());
                }
                global $rbacsystem, $tree, $ilLog;
 
                // check administrator
                $types = "";
                if (is_array($type_filter))
                {
                        $types = implode($type_filter, ",");
                }
                
                // output lp changes as xml
                try
                {
                        include_once './Services/Tracking/classes/class.ilLPXmlWriter.php';
                        $writer = new ilLPXmlWriter(true);
                        $writer->setTimestamp($timestamp);
                        $writer->setIncludeRefIds($include_ref_ids);
                        $writer->setTypeFilter($type_filter);
                        $writer->write();
                
                        return $writer->xmlDumpMem(true);
                }
                catch(UnexpectedValueException $e)
                {
                        return $this->__raiseError($e->getMessage(), 'Client');
                }
        }

References $ilLog, $timestamp, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

Here is the call graph for this function:

◆ getProgressInfo()

ilSoapLearningProgressAdministration::getProgressInfo	(	$sid,
		$a_ref_id,
		$a_progress_filter
	)

Definition at line 172 of file class.ilSoapLearningProgressAdministration.php.

        {
                global $ilAccess;
                $this->initAuth($sid);
                $this->initIlias();
 
                // Check session
                if(!$this->__checkSession($sid))
                {
                        return $this->__raiseError('Error '.self::SOAP_LP_ERROR_AUTHENTICATION.':'.$this->__getMessage(),
                                self::SOAP_LP_ERROR_AUTHENTICATION);
                }
                
                // Check filter
                if(array_diff((array) $a_progress_filter, self::$PROGRESS_INFO_TYPES))
                {
                        return $this->__raiseError('Error '.self::SOAP_LP_ERROR_INVALID_FILTER.': Invalid filter type given',
                                self::SOAP_LP_ERROR_INVALID_FILTER);
                }
                // Check LP enabled
                include_once("Services/Tracking/classes/class.ilObjUserTracking.php");
                if(!ilObjUserTracking::_enabledLearningProgress())
                {
                        return $this->__raiseError('Error '. self::SOAP_LP_ERROR_LP_NOT_ENABLED .': Learning progress not enabled in ILIAS',
                                self::SOAP_LP_ERROR_LP_NOT_ENABLED);
                }
 
                include_once './Services/Object/classes/class.ilObjectFactory.php';
                $obj = ilObjectFactory::getInstanceByRefId($a_ref_id, false);
                if(!$obj instanceof ilObject)
                {
                        return $this->__raiseError('Error '.self::SOAP_LP_ERROR_INVALID_REF_ID.': Invalid reference id '. $a_ref_id.' given',
                                self::SOAP_LP_ERROR_INVALID_REF_ID);
                }
                
                // check lp available
                include_once './Services/Tracking/classes/class.ilLPObjSettings.php';
                $mode = ilLPObjSettings::_lookupDBMode($obj->getId());
                if($mode == ilLPObjSettings::LP_MODE_UNDEFINED)
                {
                        return $this->__raiseError('Error '.self::SOAP_LP_ERROR_LP_NOT_AVAILABLE.': Learning progress not available for objects of type '.
                                $obj->getType(),
                                self::SOAP_LP_ERROR_LP_NOT_AVAILABLE);
                }
 
                // check rbac
                if(!$ilAccess->checkAccess('edit_learning_progress','',$a_ref_id))
                {
                        return $this->__raiseError('Error '. self::SOAP_LP_ERROR_NO_PERMISSION .': No Permission to access learning progress in this object',
                                self::SOAP_LP_ERROR_NO_PERMISSION);
                }
                
                include_once './Services/Xml/classes/class.ilXmlWriter.php';
                $writer = new ilXmlWriter();
                $writer->xmlStartTag(
                                'LearningProgressInfo',
                                array(
                                        'ref_id' => $obj->getRefId(),
                                        'type' => $obj->getType()
                                )
                );
                
                $writer->xmlStartTag('LearningProgressSummary');
                
                include_once './Services/Tracking/classes/class.ilLPStatusWrapper.php';
                if(in_array(self::PROGRESS_FILTER_ALL, $a_progress_filter) or in_array(self::PROGRESS_FILTER_COMPLETED, $a_progress_filter))
                {
                        $completed = ilLPStatusWrapper::_getCountCompleted($obj->getId());
                        $writer->xmlElement(
                                        'Status',
                                        array(
                                                'type'  => self::PROGRESS_FILTER_COMPLETED,
                                                'num'   => (int) $completed
                                        )
                        );
                }
                if(in_array(self::PROGRESS_FILTER_ALL, $a_progress_filter) or in_array(self::PROGRESS_FILTER_IN_PROGRESS, $a_progress_filter))
                {
                        $completed = ilLPStatusWrapper::_getCountInProgress($obj->getId());
                        $writer->xmlElement(
                                        'Status',
                                        array(
                                                'type'  => self::PROGRESS_FILTER_IN_PROGRESS,
                                                'num'   => (int) $completed
                                        )
                        );
                }
                if(in_array(self::PROGRESS_FILTER_ALL, $a_progress_filter) or in_array(self::PROGRESS_FILTER_FAILED, $a_progress_filter))
                {
                        $completed = ilLPStatusWrapper::_getCountFailed($obj->getId());
                        $writer->xmlElement(
                                        'Status',
                                        array(
                                                'type'  => self::PROGRESS_FILTER_FAILED,
                                                'num'   => (int) $completed
                                        )
                        );
                }
                if(in_array(self::PROGRESS_FILTER_ALL, $a_progress_filter) or in_array(self::PROGRESS_FILTER_NOT_ATTEMPTED, $a_progress_filter))
                {
                        $completed = ilLPStatusWrapper::_getCountNotAttempted($obj->getId());
                        $writer->xmlElement(
                                        'Status',
                                        array(
                                                'type'  => self::PROGRESS_FILTER_NOT_ATTEMPTED,
                                                'num'   => (int) $completed
                                        )
                        );
                }
                $writer->xmlEndTag('LearningProgressSummary');
                
 
                $writer->xmlStartTag('UserProgress');
                if(in_array(self::PROGRESS_FILTER_ALL, $a_progress_filter) or in_array(self::PROGRESS_FILTER_COMPLETED, $a_progress_filter))
                {
                        $completed = ilLPStatusWrapper::_getCompleted($obj->getId());
                        $this->addUserProgress($writer, $completed, self::PROGRESS_FILTER_COMPLETED);
                }
                if(in_array(self::PROGRESS_FILTER_ALL, $a_progress_filter) or in_array(self::PROGRESS_FILTER_IN_PROGRESS, $a_progress_filter))
                {
                        $completed = ilLPStatusWrapper::_getInProgress($obj->getId());
                        $this->addUserProgress($writer, $completed, self::PROGRESS_FILTER_IN_PROGRESS);
                }
                if(in_array(self::PROGRESS_FILTER_ALL, $a_progress_filter) or in_array(self::PROGRESS_FILTER_FAILED, $a_progress_filter))
                {
                        $completed = ilLPStatusWrapper::_getFailed($obj->getId());
                        $this->addUserProgress($writer, $completed, self::PROGRESS_FILTER_FAILED);
                }
                if(in_array(self::PROGRESS_FILTER_ALL, $a_progress_filter) or in_array(self::PROGRESS_FILTER_NOT_ATTEMPTED, $a_progress_filter))
                {
                        $completed = ilLPStatusWrapper::_getNotAttempted($obj->getId());
                        $this->addUserProgress($writer, $completed, self::PROGRESS_FILTER_NOT_ATTEMPTED);
                }
                $writer->xmlEndTag('UserProgress');
                $writer->xmlEndTag('LearningProgressInfo');
 
                return $writer->xmlDumpMem();
        }

Here is the call graph for this function:

Field Documentation

◆ $DELETE_PROGRESS_FILTER_TYPES

ilSoapLearningProgressAdministration::$DELETE_PROGRESS_FILTER_TYPES = array('sahs', 'tst')

staticprotected

Definition at line 16 of file class.ilSoapLearningProgressAdministration.php.

◆ $PROGRESS_INFO_TYPES

ilSoapLearningProgressAdministration::$PROGRESS_INFO_TYPES

staticprotected

Initial value:

= array(
                self::PROGRESS_FILTER_ALL,
                self::PROGRESS_FILTER_IN_PROGRESS,
                self::PROGRESS_FILTER_COMPLETED,
                self::PROGRESS_FILTER_FAILED,
                self::PROGRESS_FILTER_NOT_ATTEMPTED
        )

Definition at line 31 of file class.ilSoapLearningProgressAdministration.php.