ilSoapFileAdministration Class Reference

Soap file administration methods. More...

Inheritance diagram for ilSoapFileAdministration:

Collaboration diagram for ilSoapFileAdministration:

Public Member Functions
	addFile (string $sid, int $target_id, string $file_xml)
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

Soap file administration methods.

Author

Roland Küstermann rolan.nosp@m.d@ku.nosp@m.ester.nosp@m.mann.nosp@m..com

Definition at line 30 of file class.ilSoapFileAdministration.php.

Member Function Documentation

addFile()

ilSoapFileAdministration::addFile	(	string	$sid,
		int	$target_id,
		string	$file_xml
	)

Returns

int|soap_fault|SoapFault|null

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

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
        global $DIC;
 
        $ilAccess = $DIC['ilAccess'];
 
        if (!$target_obj = ilObjectFactory::getInstanceByRefId($target_id, false)) {
            return $this->raiseError('No valid target given.', 'Client');
        }
 
        if (ilObject::_isInTrash($target_id)) {
            return $this->raiseError("Parent with ID $target_id has been deleted.", 'CLIENT_TARGET_DELETED');
        }
 
        $allowed_types = array('cat', 'grp', 'crs', 'fold', 'root');
        if (!in_array($target_obj->getType(), $allowed_types)) {
            return $this->raiseError(
                'No valid target type. Target must be reference id of "course, group, category or folder"',
                'Client'
            );
        }
 
        if (!$ilAccess->checkAccess('create', '', $target_id, "file")) {
            return $this->raiseError('No permission to create Files in target  ' . $target_id . '!', 'Client');
        }
 
        // create object, put it into the tree and use the parser to update the settings
        include_once './Modules/File/classes/class.ilFileXMLParser.php';
        include_once './Modules/File/classes/class.ilFileException.php';
        include_once './Modules/File/classes/class.ilObjFile.php';
 
        $file = new ilObjFile();
        try {
            $fileXMLParser = new ilFileXMLParser($file, $file_xml);
 
            if ($fileXMLParser->start()) {
                global $DIC;
 
                $ilLog = $DIC['ilLog'];
 
                $ilLog->write(__METHOD__ . ': File type: ' . $file->getFileType());
 
                $file->create();
                $file->createReference();
                $file->putInTree($target_id);
                $file->setPermissions($target_id);
 
                // we now can save the file contents since we know the obj id now.
                $fileXMLParser->setFileContents();
                #$file->update();
 
                return $file->getRefId();
            }
 
            return $this->raiseError("Could not add file", "Server");
        } catch (ilFileException $exception) {
            return $this->raiseError(
                $exception->getMessage(),
                $exception->getCode() == ilFileException::$ID_MISMATCH ? "Client" : "Server"
            );
        }
    }

References $DIC, ilFileException\$ID_MISMATCH, $target_id, ilObject\_isInTrash(), ilSoapAdministration\checkSession(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

Here is the call graph for this function:

---

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

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