ilSoapExerciseAdministration Class Reference

Soap exercise administration methods. More...

Inheritance diagram for ilSoapExerciseAdministration:

Collaboration diagram for ilSoapExerciseAdministration:

Public Member Functions
	addExercise (string $sid, int $target_id, string $exercise_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 exercise administration methods.

Author

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

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

Member Function Documentation

addExercise()

ilSoapExerciseAdministration::addExercise	(	string	$sid,
		int	$target_id,
		string	$exercise_xml
	)

Returns

int|soap_fault|SoapFault|null

Definition at line 36 of file class.ilSoapExerciseAdministration.php.

References $DIC, $exercise, ilExerciseException\$ID_MISMATCH, $ref_id, $requested_ref_id, ilObject\_getAllReferences(), ilObject\_isInTrash(), ilObject\_lookupObjectId(), ilSoapAdministration\checkSession(), ilObjectFactory\getInstanceByObjId(), ilObjectFactory\getInstanceByRefId(), ilSoapAdministration\getMessage(), ilSoapAdministration\getMessageCode(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilSoapAdministration\raiseError().

    {
        $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'];

        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_OBJECT_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 (!$rbacsystem->checkAccess('create', $target_id, "exc")) {
            return $this->raiseError('No permission to create exercises in target  ' . $target_id . '!', 'Client');
        }

        // create object, put it into the tree and use the parser to update the settings

        $exercise = new ilObjExercise();
        $exercise->create();
        $exercise->createReference();
        $exercise->putInTree($target_id);
        $exercise->setPermissions($target_id);
        $exercise->saveData();

        // we need this as workaround because file and member objects need to be initialised
        $exercise->read();

        $exerciseXMLParser = new ilExerciseXMLParser($exercise, $exercise_xml);
        try {
            if ($exerciseXMLParser->start()) {
                $exerciseXMLParser->getAssignment()->update();
                return $exercise->update() ? $exercise->getRefId() : -1;
            }
            throw new ilExerciseException("Could not parse XML");
        } catch (ilExerciseException $exception) {
            return $this->raiseError(
                $exception->getMessage(),
                $exception->getCode() == ilExerciseException::$ID_MISMATCH ? "Client" : "Server"
            );
        }
    }

Here is the call graph for this function:

---

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

• components/ILIAS/soap/classes/class.ilSoapExerciseAdministration.php