This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilSoapLearningProgressAdministration:

Collaboration diagram for ilSoapLearningProgressAdministration:

Public Member Functions
	getLearningProgressChanges (string $sid, string $timestamp, bool $include_ref_ids, array $type_filter)

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)

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
const	NUSOAP = 1

const	PHP5 = 2

int	$error_method
	Defines type of error handling (PHP5 \|\| NUSOAP) More...

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

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

	deleteScormTracking (int $a_obj_id, array $a_usr_ids)
	Delete SCORM Tracking. More...

	deleteScorm2004Tracking (int $a_obj_id, array $a_usr_ids)
	Delete scorm 2004 tracking. 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...

Static Protected Attributes
static array	$DELETE_PROGRESS_FILTER_TYPES = ['sahs', 'tst']

static array	$PROGRESS_INFO_TYPES

Additional Inherited Members
Protected Attributes inherited from ilSoapAdministration
bool	$soap_check = true

string	$message = ''

string	$message_code = ''

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 24 of file class.ilSoapLearningProgressAdministration.php.

Member Function Documentation

◆ addUserProgress()

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

protected

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

                                                                                      : void
    {
        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, $user_id, ilObjUser\_lookupName(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Here is the call graph for this function:

◆ applyProgressFilter()

ilSoapLearningProgressAdministration::applyProgressFilter	(	int	$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 413 of file class.ilSoapLearningProgressAdministration.php.

                                                                                      : array
    {
        $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 || in_array(self::PROGRESS_FILTER_ALL, $filter)) {
            $GLOBALS['DIC']['log']->write(__METHOD__ . ': Deleting all progress data');
            return $all_users;
        }
 
        $filter_users = array();
        if (in_array(self::PROGRESS_FILTER_IN_PROGRESS, $filter)) {
            $GLOBALS['DIC']['log']->write(__METHOD__ . ': Filtering  in progress.');
            $filter_users = array_merge($filter, ilLPStatusWrapper::_getInProgress($obj_id));
        }
        if (in_array(self::PROGRESS_FILTER_COMPLETED, $filter)) {
            $GLOBALS['DIC']['log']->write(__METHOD__ . ': Filtering  completed.');
            $filter_users = array_merge($filter, ilLPStatusWrapper::_getCompleted($obj_id));
        }
        if (in_array(self::PROGRESS_FILTER_FAILED, $filter)) {
            $GLOBALS['DIC']['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	(	int	$a_obj_id,
		array	$a_usr_ids
	)

protected

Delete scorm 2004 tracking.

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

                                                                               : void
    {
        global $DIC;
 
        $ilDB = $DIC['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(ilDBConstants::FETCHMODE_OBJECT)) {
            $scos[] = $row->cp_node_id;
        }
 
        $query = 'DELETE FROM cmi_node ' .
            'WHERE ' . $ilDB->in('user_id', $a_usr_ids, false, 'integer') . ' ' .
            'AND ' . $ilDB->in('cp_node_id', $scos, false, 'integer');
        $ilDB->manipulate($query);
    }

References $DIC, $ilDB, $res, and ilDBConstants\FETCHMODE_OBJECT.

◆ deleteScormTracking()

ilSoapLearningProgressAdministration::deleteScormTracking	(	int	$a_obj_id,
		array	$a_usr_ids
	)

protected

Delete SCORM Tracking.

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

                                                                           : bool
    {
        global $DIC;
 
        $ilDB = $DIC['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 $DIC, $ilDB, and $res.

◆ getLearningProgressChanges()

ilSoapLearningProgressAdministration::getLearningProgressChanges	(	string	$sid,
		string	$timestamp,
		bool	$include_ref_ids,
		array	$type_filter
	)

Parameters

string[] $type_filter

Returns: soap_fault|SoapFault|string|null

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

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
        $tree = $DIC['tree'];
        $ilLog = $DIC['ilLog'];
 
        // check administrator
        $types = "";
        if (is_array($type_filter)) {
            $types = implode(",", $type_filter);
        }
 
        // output lp changes as xml
        try {
            $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 $DIC, Vendor\Package\$e, $timestamp, ilSoapAdministration\checkSession(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

Here is the call graph for this function:

Field Documentation

◆ $DELETE_PROGRESS_FILTER_TYPES

array ilSoapLearningProgressAdministration::$DELETE_PROGRESS_FILTER_TYPES = ['sahs', 'tst']

staticprotected

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

◆ $PROGRESS_INFO_TYPES

array ilSoapLearningProgressAdministration::$PROGRESS_INFO_TYPES

staticprotected

Initial value:

= [
        self::PROGRESS_FILTER_ALL,
        self::PROGRESS_FILTER_IN_PROGRESS,
        self::PROGRESS_FILTER_COMPLETED,
        self::PROGRESS_FILTER_FAILED,
        self::PROGRESS_FILTER_NOT_ATTEMPTED
    ]