ilSoapDataCollectionAdministration Class Reference

Inheritance diagram for ilSoapDataCollectionAdministration:

Collaboration diagram for ilSoapDataCollectionAdministration:

Public Member Functions
	exportDataCollectionContent ($sid, $target_ref_id, $table_id=null, $format=ilDclContentExporter::EXPORT_EXCEL, $filepath=null)
	Export DataCollection async. More...
Public Member Functions inherited from ilSoapAdministration
	__construct ($use_nusoap=true)
	Constructor. More...
	initErrorWriter ()
	Overwrite error handler. More...
	__explodeSid ($sid)
	__setMessage ($a_str)
	__getMessage ()
	__appendMessage ($a_str)
	__setMessageCode ($a_code)
	__getMessageCode ()
	initAuth ($sid)
	Init authentication. More...
	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 33 of file class.ilSoapDataCollectionAdministration.php.

Member Function Documentation

exportDataCollectionContent()

ilSoapDataCollectionAdministration::exportDataCollectionContent	(		$sid,
			$target_ref_id,
			$table_id = null,
			$format = ilDclContentExporter::EXPORT_EXCEL,
			$filepath = null
	)

Export DataCollection async.

Parameters

	$sid
	$target_ref_id
null | int	$table_id
string	$format
null | string	$filepath

Returns

soap_fault|SoapFault

Definition at line 47 of file class.ilSoapDataCollectionAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
 
        require_once "Modules/DataCollection/classes/class.ilObjDataCollection.php";
        if (!$target_obj = new ilObjDataCollection($target_ref_id)) {
            return $this->__raiseError('No valid target given.', 'CLIENT');
        }
 
        if (ilObject::_isInTrash($target_ref_id)) {
            return $this->__raiseError(
                "Parent with ID $target_ref_id has been deleted.",
                'CLIENT_TARGET_DELETED'
            );
        }
 
        if (!ilObjDataCollectionAccess::hasReadAccess($target_ref_id)) {
            return $this->__raiseError(
                'Check access failed. No permission to read DataCollection',
                "CLIENT_PERMISSION_ISSUE"
            );
        }
 
        try {
            require_once "Modules/DataCollection/classes/Content/class.ilDclContentExporter.php";
            $exporter = new ilDclContentExporter($target_ref_id, $table_id);
            return $exporter->export($format, $filepath);
        } catch (ilException $exception) {
            return $this->__raiseError($exception->getMessage(), $exception->getCode());
        }
    }

References $format, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObject\_isInTrash(), ilObjDataCollectionAccess\hasReadAccess(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

Here is the call graph for this function:

---

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

• webservice/soap/classes/class.ilSoapDataCollectionAdministration.php