ilSoapAdministration Class Reference

Inheritance diagram for ilSoapAdministration:

Collaboration diagram for ilSoapAdministration:

Public Member Functions
	__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	NUSOAP = 1
const	PHP5 = 2
int	$error_method
	Defines type of error handling (PHP5 || NUSOAP) More...

Protected Member Functions
	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
bool	$soap_check = true
string	$message = ''
string	$message_code = ''

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilSoapAdministration::__construct

(

bool

$use_nusoap = true

)

Definition at line 44 of file class.ilSoapAdministration.php.

References IL_SOAPMODE, IL_SOAPMODE_NUSOAP, and initAuthenticationObject().

    {
        if (
            defined('IL_SOAPMODE') &&
            defined('IL_SOAPMODE_NUSOAP') &&
            IL_SOAPMODE === IL_SOAPMODE_NUSOAP
        ) {
            $this->error_method = self::NUSOAP;
        } else {
            $this->error_method = self::PHP5;
        }

        $this->initAuthenticationObject();
    }

Here is the call graph for this function:

Member Function Documentation

appendMessage()

ilSoapAdministration::appendMessage

(

string

$a_str

)

Definition at line 120 of file class.ilSoapAdministration.php.

                                                : void
    {
        $this->message .= isset($this->message) ? ' ' : '';
        $this->message .= $a_str;
    }

checkObjectAccess()

ilSoapAdministration::checkObjectAccess ( int  $ref_id, array  $expected_type, string  $permission, bool  $returnObject = false  )

protected

check access for ref id: expected type, permission, return object instance if returnobject is true

Definition at line 213 of file class.ilSoapAdministration.php.

References $DIC, Vendor\Package\$e, ilObject\_exists(), ilObject\_isInTrash(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilObjectFactory\getInstanceByRefId(), and raiseError().

Referenced by ilSoapCourseAdministration\excludeCourseMember(), ilSoapCourseAdministration\getCoursesForUser(), ilSoapGroupAdministration\getGroupsForUser(), and ilSoapUserAdministration\getUsersForContainer().

      {
        global $DIC;

        $rbacsystem = $DIC->rbac()->system();

        if (!ilObject::_exists($ref_id, true)) {
            return $this->raiseError(
                'No object for id.',
                'CLIENT_OBJECT_NOT_FOUND'
            );
        }

        if (ilObject::_isInTrash($ref_id)) {
            return $this->raiseError(
                'Object is already trashed.',
                'CLIENT_OBJECT_DELETED'
            );
        }

        $type = ilObject::_lookupType(ilObject::_lookupObjId($ref_id));
        if (!in_array($type, $expected_type, true)) {
            return $this->raiseError(
                "Wrong type $type for id. Expected: " . implode(',', $expected_type),
                'CLIENT_OBJECT_WRONG_TYPE'
            );
        }
        if (!$rbacsystem->checkAccess($permission, $ref_id, $type)) {
            return $this->raiseError(
                'Missing permission $permission for type $type.',
                'CLIENT_OBJECT_WRONG_PERMISSION'
            );
        }
        if ($returnObject) {
            try {
                return ilObjectFactory::getInstanceByRefId($ref_id);
            } catch (ilObjectNotFoundException $e) {
                return $this->raiseError('No valid ref_id given', 'Client');
            }
        }
        return $type;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkSession()

ilSoapAdministration::checkSession ( string  $sid )

protected

Definition at line 59 of file class.ilSoapAdministration.php.

References $client, $DIC, $GLOBALS, explodeSid(), setMessage(), and setMessageCode().

Referenced by ilSoapCourseAdministration\addCourse(), ilSoapExerciseAdministration\addExercise(), ilSoapFileAdministration\addFile(), ilSoapGroupAdministration\addGroup(), ilSoapObjectAdministration\addReference(), ilSoapRBACAdministration\addRole(), ilSoapRBACAdministration\addRoleFromTemplate(), ilSoapRBACAdministration\addUserRoleEntry(), ilSoapCourseAdministration\assignCourseMember(), ilSoapObjectAdministration\copyObject(), ilSoapWebLinkAdministration\createWebLink(), ilSoapCourseAdministration\deleteCourse(), ilSoapObjectAdministration\deleteObject(), ilSoapRBACAdministration\deleteRole(), ilSoapRBACAdministration\deleteUserRoleEntry(), ilSoapCourseAdministration\excludeCourseMember(), ilSoapDataCollectionAdministration\exportDataCollectionContent(), ilSoapCourseAdministration\getCoursesForUser(), ilSoapGroupAdministration\getGroupsForUser(), ilSoapSCORMAdministration\getIMSManifestXML(), ilSoapLearningProgressAdministration\getLearningProgressChanges(), ilSoapRBACAdministration\getLocalRoles(), ilSoapUtils\getMobsOfObject(), ilSoapTestAdministration\getNrOfQuestionsInPass(), ilSoapObjectAdministration\getObjectByReference(), ilSoapObjectAdministration\getObjectsByTitle(), ilSoapRBACAdministration\getObjectTreeOperations(), ilSoapObjectAdministration\getObjIdByImportId(), ilSoapObjectAdministration\getObjIdsByRefIds(), ilSoapRBACAdministration\getOperations(), ilSoapObjectAdministration\getPathForRefId(), ilSoapTestAdministration\getPositionOfQuestion(), ilSoapTestAdministration\getPreviousReachedPoints(), ilSoapTestAdministration\getQuestionSolution(), ilSoapObjectAdministration\getRefIdsByImportId(), ilSoapObjectAdministration\getRefIdsByObjId(), ilSoapRBACAdministration\getRoles(), ilSoapSCORMAdministration\getSCORMCompletionStatus(), ilSOAPStructureObjectAdministration\getStructureObjects(), ilSoapTestAdministration\getTestResults(), ilSoapTestAdministration\getTestUserData(), ilSoapObjectAdministration\getTreeChilds(), ilSoapUserAdministration\getUserForRole(), ilSoapUserAdministration\getUserIdBySid(), ilSoapRBACAdministration\getUserRoles(), ilSoapUserAdministration\getUsersForContainer(), ilSoapUserAdministration\getUserXML(), ilSoapObjectAdministration\getXMLTree(), ilSoapRBACAdministration\grantPermissions(), ilSoapGroupAdministration\groupExists(), ilSoapUserAdministration\hasNewMail(), ilSoapSCORMAdministration\hasSCORMCertificate(), ilSoapUtils\ilClone(), ilSoapUtils\ilCloneDependencies(), ilSoapUserAdministration\importUsers(), ilAbstractSoapMethod\initIliasAndCheckSession(), ILIAS\OrgUnit\Webservices\SOAP\Base\initIliasAndCheckSession(), ilSoapUserAdministration\logout(), ilSoapUserAdministration\lookupUser(), ilSoapObjectAdministration\moveObject(), ilSoapWebLinkAdministration\readWebLink(), ilSoapObjectAdministration\removeFromSystemByImportId(), ilSoapTestAdministration\removeTestResults(), ilSoapRBACAdministration\revokePermissions(), ilSoapBackgroundTasksAdministration\runAsync(), ilSoapTestAdministration\saveQuestion(), ilSoapTestAdministration\saveQuestionSolution(), ilSoapUtils\saveTempFileAsMediaObject(), ilSoapObjectAdministration\searchObjects(), ilSoapRBACAdministration\searchRoles(), ilSoapUserAdministration\searchUser(), and ilSoapWebLinkAdministration\updateWebLink().

                                                : bool
    {
        global $DIC;

        $ilUser = $DIC->user();

        [$sid, $client] = $this->explodeSid($sid);

        if ($sid === '') {
            $this->setMessage('No session id given');
            $this->setMessageCode('Client');
            return false;
        }
        if (!$client) {
            $this->setMessage('No client given');
            $this->setMessageCode('Client');
            return false;
        }

        if (!$GLOBALS['DIC']['ilAuthSession']->isAuthenticated()) {
            $this->setMessage('Session invalid');
            $this->setMessageCode('Client');
            return false;
        }

        $can = $DIC['legalDocuments']->canUseSoapApi()->applyTo(new Ok($ilUser))->except(
            fn($error) => new Error(is_string($error) ? $error : $error->getMessage())
        );
        if (!$can->isOk()) {
            $this->setMessage($can->error());
            $this->setMessageCode('Server');
            return false;
        }

        if ($this->soap_check) {
            $set = new ilSetting();
            $this->setMessage('SOAP is not enabled in ILIAS administration for this client');
            $this->setMessageCode('Server');
            return ((int) $set->get('soap_user_administration', '0')) === 1;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

explodeSid()

ilSoapAdministration::explodeSid ( string  $sid )

protected

Definition at line 103 of file class.ilSoapAdministration.php.

Referenced by checkSession(), and initAuth().

                                              : array
    {
        $exploded = explode('::', $sid);

        return is_array($exploded) ? $exploded : array('sid' => '', 'client' => '');
    }

Here is the caller graph for this function:

getClientInfoXML()

ilSoapAdministration::getClientInfoXML

(

string

$clientid

)

Returns

soap_fault|SoapFault|string|null

Definition at line 281 of file class.ilSoapAdministration.php.

References ilContext\CONTEXT_SOAP_WITHOUT_CLIENT, ILIAS_WEB_DIR, ilContext\init(), ilInitialisation\initILIAS(), and raiseError().

    {
        ilContext::init(ilContext::CONTEXT_SOAP_WITHOUT_CLIENT);

        ilInitialisation::initILIAS();

        $clientdir = ILIAS_WEB_DIR . '/' . $clientid;
        $writer = new ilSoapInstallationInfoXMLWriter();
        $writer->start();
        if (!$writer->addClient($clientdir)) {
            return $this->raiseError(
                'Client ID ' . $clientid . 'does not exist!',
                'Client'
            );
        }
        $writer->end();
        return $writer->getXML();
    }

Here is the call graph for this function:

getInstallationInfoXML()

ilSoapAdministration::getInstallationInfoXML

(

)

Definition at line 260 of file class.ilSoapAdministration.php.

References ilContext\CONTEXT_SOAP_WITHOUT_CLIENT, ILIAS_WEB_DIR, ilContext\init(), and ilInitialisation\initILIAS().

                                            : string
    {
        ilContext::init(ilContext::CONTEXT_SOAP_WITHOUT_CLIENT);

        ilInitialisation::initILIAS();

        $clientdirs = glob(ILIAS_WEB_DIR . '/*', GLOB_ONLYDIR);
        $writer = new ilSoapInstallationInfoXMLWriter();
        $writer->start();
        if (is_array($clientdirs)) {
            foreach ($clientdirs as $clientdir) {
                $writer->addClient($clientdir);
            }
        }
        $writer->end();
        return $writer->getXML();
    }

Here is the call graph for this function:

getMessage()

ilSoapAdministration::getMessage

(

)

Definition at line 115 of file class.ilSoapAdministration.php.

References $message.

Referenced by ilSoapCourseAdministration\addCourse(), ilSoapExerciseAdministration\addExercise(), ilSoapFileAdministration\addFile(), ilSoapGroupAdministration\addGroup(), ilSoapObjectAdministration\addReference(), ilSoapRBACAdministration\addRole(), ilSoapRBACAdministration\addRoleFromTemplate(), ilSoapRBACAdministration\addUserRoleEntry(), ilSoapCourseAdministration\assignCourseMember(), ilSoapObjectAdministration\copyObject(), ilSoapWebLinkAdministration\createWebLink(), ilSoapCourseAdministration\deleteCourse(), ilSoapObjectAdministration\deleteObject(), ilSoapRBACAdministration\deleteRole(), ilSoapRBACAdministration\deleteUserRoleEntry(), ilSoapCourseAdministration\excludeCourseMember(), ilSoapDataCollectionAdministration\exportDataCollectionContent(), ilSoapCourseAdministration\getCoursesForUser(), ilSoapGroupAdministration\getGroupsForUser(), ilSoapSCORMAdministration\getIMSManifestXML(), ilSoapLearningProgressAdministration\getLearningProgressChanges(), ilSoapRBACAdministration\getLocalRoles(), ilSoapUtils\getMobsOfObject(), ilSoapTestAdministration\getNrOfQuestionsInPass(), ilSoapObjectAdministration\getObjectByReference(), ilSoapObjectAdministration\getObjectsByTitle(), ilSoapRBACAdministration\getObjectTreeOperations(), ilSoapObjectAdministration\getObjIdByImportId(), ilSoapObjectAdministration\getObjIdsByRefIds(), ilSoapRBACAdministration\getOperations(), ilSoapObjectAdministration\getPathForRefId(), ilSoapTestAdministration\getPositionOfQuestion(), ilSoapTestAdministration\getPreviousReachedPoints(), ilSoapTestAdministration\getQuestionSolution(), ilSoapObjectAdministration\getRefIdsByImportId(), ilSoapObjectAdministration\getRefIdsByObjId(), ilSoapRBACAdministration\getRoles(), ilSoapSCORMAdministration\getSCORMCompletionStatus(), ilSOAPStructureObjectAdministration\getStructureObjects(), ilSoapTestAdministration\getTestResults(), ilSoapTestAdministration\getTestUserData(), ilSoapObjectAdministration\getTreeChilds(), ilSoapUserAdministration\getUserForRole(), ilSoapUserAdministration\getUserIdBySid(), ilSoapRBACAdministration\getUserRoles(), ilSoapUserAdministration\getUsersForContainer(), ilSoapUserAdministration\getUserXML(), ilSoapObjectAdministration\getXMLTree(), ilSoapRBACAdministration\grantPermissions(), ilSoapGroupAdministration\groupExists(), ilSoapUserAdministration\hasNewMail(), ilSoapSCORMAdministration\hasSCORMCertificate(), ilSoapUtils\ilClone(), ilSoapUtils\ilCloneDependencies(), ilSoapUserAdministration\importUsers(), ilAbstractSoapMethod\initIliasAndCheckSession(), ILIAS\OrgUnit\Webservices\SOAP\Base\initIliasAndCheckSession(), ilSoapUserAdministration\logout(), ilSoapUserAdministration\lookupUser(), ilSoapObjectAdministration\moveObject(), ilSoapWebLinkAdministration\readWebLink(), ilSoapObjectAdministration\removeFromSystemByImportId(), ilSoapTestAdministration\removeTestResults(), ilSoapRBACAdministration\revokePermissions(), ilSoapBackgroundTasksAdministration\runAsync(), ilSoapTestAdministration\saveQuestion(), ilSoapTestAdministration\saveQuestionSolution(), ilSoapUtils\saveTempFileAsMediaObject(), ilSoapObjectAdministration\searchObjects(), ilSoapRBACAdministration\searchRoles(), ilSoapUserAdministration\searchUser(), and ilSoapWebLinkAdministration\updateWebLink().

                                : string
    {
        return $this->message;
    }

Here is the caller graph for this function:

getMessageCode()

ilSoapAdministration::getMessageCode

(

)

Definition at line 131 of file class.ilSoapAdministration.php.

References $message_code.

Referenced by ilSoapCourseAdministration\addCourse(), ilSoapExerciseAdministration\addExercise(), ilSoapFileAdministration\addFile(), ilSoapGroupAdministration\addGroup(), ilSoapObjectAdministration\addReference(), ilSoapRBACAdministration\addRole(), ilSoapRBACAdministration\addRoleFromTemplate(), ilSoapRBACAdministration\addUserRoleEntry(), ilSoapCourseAdministration\assignCourseMember(), ilSoapObjectAdministration\copyObject(), ilSoapWebLinkAdministration\createWebLink(), ilSoapCourseAdministration\deleteCourse(), ilSoapObjectAdministration\deleteObject(), ilSoapRBACAdministration\deleteRole(), ilSoapRBACAdministration\deleteUserRoleEntry(), ilSoapCourseAdministration\excludeCourseMember(), ilSoapDataCollectionAdministration\exportDataCollectionContent(), ilSoapCourseAdministration\getCoursesForUser(), ilSoapGroupAdministration\getGroupsForUser(), ilSoapSCORMAdministration\getIMSManifestXML(), ilSoapLearningProgressAdministration\getLearningProgressChanges(), ilSoapRBACAdministration\getLocalRoles(), ilSoapUtils\getMobsOfObject(), ilSoapTestAdministration\getNrOfQuestionsInPass(), ilSoapObjectAdministration\getObjectByReference(), ilSoapObjectAdministration\getObjectsByTitle(), ilSoapRBACAdministration\getObjectTreeOperations(), ilSoapObjectAdministration\getObjIdByImportId(), ilSoapObjectAdministration\getObjIdsByRefIds(), ilSoapRBACAdministration\getOperations(), ilSoapObjectAdministration\getPathForRefId(), ilSoapTestAdministration\getPositionOfQuestion(), ilSoapTestAdministration\getPreviousReachedPoints(), ilSoapTestAdministration\getQuestionSolution(), ilSoapObjectAdministration\getRefIdsByImportId(), ilSoapObjectAdministration\getRefIdsByObjId(), ilSoapRBACAdministration\getRoles(), ilSoapSCORMAdministration\getSCORMCompletionStatus(), ilSOAPStructureObjectAdministration\getStructureObjects(), ilSoapTestAdministration\getTestResults(), ilSoapTestAdministration\getTestUserData(), ilSoapObjectAdministration\getTreeChilds(), ilSoapUserAdministration\getUserForRole(), ilSoapUserAdministration\getUserIdBySid(), ilSoapRBACAdministration\getUserRoles(), ilSoapUserAdministration\getUsersForContainer(), ilSoapUserAdministration\getUserXML(), ilSoapObjectAdministration\getXMLTree(), ilSoapRBACAdministration\grantPermissions(), ilSoapGroupAdministration\groupExists(), ilSoapUserAdministration\hasNewMail(), ilSoapSCORMAdministration\hasSCORMCertificate(), ilSoapUtils\ilCloneDependencies(), ilSoapUserAdministration\importUsers(), ilSoapUserAdministration\logout(), ilSoapUserAdministration\lookupUser(), ilSoapObjectAdministration\moveObject(), ilSoapWebLinkAdministration\readWebLink(), ilSoapObjectAdministration\removeFromSystemByImportId(), ilSoapTestAdministration\removeTestResults(), ilSoapRBACAdministration\revokePermissions(), ilSoapBackgroundTasksAdministration\runAsync(), ilSoapTestAdministration\saveQuestion(), ilSoapTestAdministration\saveQuestionSolution(), ilSoapUtils\saveTempFileAsMediaObject(), ilSoapObjectAdministration\searchObjects(), ilSoapRBACAdministration\searchRoles(), ilSoapUserAdministration\searchUser(), and ilSoapWebLinkAdministration\updateWebLink().

                                    : string
    {
        return $this->message_code;
    }

Here is the caller graph for this function:

initAuth()

ilSoapAdministration::initAuth ( string  $sid )

protected

Definition at line 136 of file class.ilSoapAdministration.php.

References $client, ilContext\CONTEXT_SOAP, explodeSid(), ilContext\getType(), ilInitialisation\reInitUser(), and ilUtil\setCookie().

Referenced by ilSoapCourseAdministration\addCourse(), ilSoapExerciseAdministration\addExercise(), ilSoapFileAdministration\addFile(), ilSoapGroupAdministration\addGroup(), ilSoapObjectAdministration\addReference(), ilSoapRBACAdministration\addRole(), ilSoapRBACAdministration\addRoleFromTemplate(), ilSoapRBACAdministration\addUserRoleEntry(), ilSoapCourseAdministration\assignCourseMember(), ilSoapObjectAdministration\copyObject(), ilSoapWebLinkAdministration\createWebLink(), ilSoapCourseAdministration\deleteCourse(), ilSoapUtils\deleteExpiredDualOptInUserObjects(), ilSoapObjectAdministration\deleteObject(), ilSoapRBACAdministration\deleteRole(), ilSoapRBACAdministration\deleteUserRoleEntry(), ilSoapCourseAdministration\excludeCourseMember(), ilSoapDataCollectionAdministration\exportDataCollectionContent(), ilSoapCourseAdministration\getCoursesForUser(), ilSoapGroupAdministration\getGroupsForUser(), ilSoapSCORMAdministration\getIMSManifestXML(), ilSoapLearningProgressAdministration\getLearningProgressChanges(), ilSoapRBACAdministration\getLocalRoles(), ilSoapUtils\getMobsOfObject(), ilSoapTestAdministration\getNrOfQuestionsInPass(), ilSoapObjectAdministration\getObjectByReference(), ilSoapObjectAdministration\getObjectsByTitle(), ilSoapRBACAdministration\getObjectTreeOperations(), ilSoapObjectAdministration\getObjIdByImportId(), ilSoapObjectAdministration\getObjIdsByRefIds(), ilSoapRBACAdministration\getOperations(), ilSoapObjectAdministration\getPathForRefId(), ilSoapTestAdministration\getPositionOfQuestion(), ilSoapTestAdministration\getPreviousReachedPoints(), ilSoapTestAdministration\getQuestionSolution(), ilSoapObjectAdministration\getRefIdsByImportId(), ilSoapObjectAdministration\getRefIdsByObjId(), ilSoapRBACAdministration\getRoles(), ilSoapSCORMAdministration\getSCORMCompletionStatus(), ilSOAPStructureObjectAdministration\getStructureObjects(), ilSoapTestAdministration\getTestResults(), ilSoapTestAdministration\getTestUserData(), ilSoapObjectAdministration\getTreeChilds(), ilSoapUserAdministration\getUserForRole(), ilSoapUserAdministration\getUserIdBySid(), ilSoapRBACAdministration\getUserRoles(), ilSoapUserAdministration\getUsersForContainer(), ilSoapUserAdministration\getUserXML(), ilSoapObjectAdministration\getXMLTree(), ilSoapRBACAdministration\grantPermissions(), ilSoapGroupAdministration\groupExists(), ilSoapUserAdministration\hasNewMail(), ilSoapSCORMAdministration\hasSCORMCertificate(), ilSoapUtils\ilClone(), ilSoapUtils\ilCloneDependencies(), ilSoapUserAdministration\importUsers(), ilAbstractSoapMethod\initIliasAndCheckSession(), ILIAS\OrgUnit\Webservices\SOAP\Base\initIliasAndCheckSession(), ilSoapUserAdministration\logout(), ilSoapUserAdministration\lookupUser(), ilSoapObjectAdministration\moveObject(), ilSoapWebLinkAdministration\readWebLink(), ilSoapObjectAdministration\removeFromSystemByImportId(), ilSoapTestAdministration\removeTestResults(), ilSoapRBACAdministration\revokePermissions(), ilSoapBackgroundTasksAdministration\runAsync(), ilSoapTestAdministration\saveQuestion(), ilSoapTestAdministration\saveQuestionSolution(), ilSoapUtils\saveTempFileAsMediaObject(), ilSoapObjectAdministration\searchObjects(), ilSoapRBACAdministration\searchRoles(), ilSoapUserAdministration\searchUser(), and ilSoapWebLinkAdministration\updateWebLink().

                                            : void
    {
        [$sid, $client] = $this->explodeSid($sid);

        if (session_status() === PHP_SESSION_ACTIVE && $sid === session_id()) {
            return;
        }

        if (session_status() === PHP_SESSION_ACTIVE) {
            session_destroy();
        }

        session_id($sid);

        if (ilContext::getType() !== ilContext::CONTEXT_SOAP) {
            ilInitialisation::reInitUser();
            ilUtil::setCookie(session_name(), $sid);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initAuthenticationObject()

ilSoapAdministration::initAuthenticationObject ( )

protected

Definition at line 176 of file class.ilSoapAdministration.php.

References ilAuthFactory\CONTEXT_SOAP, and ilAuthFactory\setContext().

Referenced by __construct().

                                                 : void
    {
        ilAuthFactory::setContext(ilAuthFactory::CONTEXT_SOAP);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initIlias()

ilSoapAdministration::initIlias ( )

protected

Definition at line 156 of file class.ilSoapAdministration.php.

References Vendor\Package\$e, ilContext\CONTEXT_SOAP, ilContext\getType(), and ilInitialisation\reinitILIAS().

Referenced by ilSoapCourseAdministration\addCourse(), ilSoapExerciseAdministration\addExercise(), ilSoapFileAdministration\addFile(), ilSoapGroupAdministration\addGroup(), ilSoapObjectAdministration\addReference(), ilSoapRBACAdministration\addRole(), ilSoapRBACAdministration\addRoleFromTemplate(), ilSoapRBACAdministration\addUserRoleEntry(), ilSoapCourseAdministration\assignCourseMember(), ilSoapObjectAdministration\copyObject(), ilSoapWebLinkAdministration\createWebLink(), ilSoapCourseAdministration\deleteCourse(), ilSoapUtils\deleteExpiredDualOptInUserObjects(), ilSoapObjectAdministration\deleteObject(), ilSoapRBACAdministration\deleteRole(), ilSoapRBACAdministration\deleteUserRoleEntry(), ilSoapCourseAdministration\excludeCourseMember(), ilSoapDataCollectionAdministration\exportDataCollectionContent(), ilSoapCourseAdministration\getCoursesForUser(), ilSoapGroupAdministration\getGroupsForUser(), ilSoapSCORMAdministration\getIMSManifestXML(), ilSoapLearningProgressAdministration\getLearningProgressChanges(), ilSoapRBACAdministration\getLocalRoles(), ilSoapUtils\getMobsOfObject(), ilSoapTestAdministration\getNrOfQuestionsInPass(), ilSoapObjectAdministration\getObjectByReference(), ilSoapObjectAdministration\getObjectsByTitle(), ilSoapRBACAdministration\getObjectTreeOperations(), ilSoapObjectAdministration\getObjIdByImportId(), ilSoapObjectAdministration\getObjIdsByRefIds(), ilSoapRBACAdministration\getOperations(), ilSoapObjectAdministration\getPathForRefId(), ilSoapTestAdministration\getPositionOfQuestion(), ilSoapTestAdministration\getPreviousReachedPoints(), ilSoapTestAdministration\getQuestionSolution(), ilSoapObjectAdministration\getRefIdsByImportId(), ilSoapObjectAdministration\getRefIdsByObjId(), ilSoapRBACAdministration\getRoles(), ilSoapSCORMAdministration\getSCORMCompletionStatus(), ilSOAPStructureObjectAdministration\getStructureObjects(), ilSoapTestAdministration\getTestResults(), ilSoapTestAdministration\getTestUserData(), ilSoapObjectAdministration\getTreeChilds(), ilSoapUserAdministration\getUserForRole(), ilSoapUserAdministration\getUserIdBySid(), ilSoapRBACAdministration\getUserRoles(), ilSoapUserAdministration\getUsersForContainer(), ilSoapUserAdministration\getUserXML(), ilSoapObjectAdministration\getXMLTree(), ilSoapRBACAdministration\grantPermissions(), ilSoapGroupAdministration\groupExists(), ilSoapUserAdministration\hasNewMail(), ilSoapSCORMAdministration\hasSCORMCertificate(), ilSoapUtils\ilClone(), ilSoapUtils\ilCloneDependencies(), ilSoapUserAdministration\importUsers(), ILIAS\OrgUnit\Webservices\SOAP\Base\initIliasAndCheckSession(), ilSoapUserAdministration\login(), ilSoapUserAdministration\logout(), ilSoapUserAdministration\lookupUser(), ilSoapObjectAdministration\moveObject(), ilSoapWebLinkAdministration\readWebLink(), ilSoapObjectAdministration\removeFromSystemByImportId(), ilSoapTestAdministration\removeTestResults(), ilSoapRBACAdministration\revokePermissions(), ilSoapBackgroundTasksAdministration\runAsync(), ilSoapTestAdministration\saveQuestion(), ilSoapTestAdministration\saveQuestionSolution(), ilSoapUtils\saveTempFileAsMediaObject(), ilSoapObjectAdministration\searchObjects(), ilSoapRBACAdministration\searchRoles(), ilSoapUserAdministration\searchUser(), and ilSoapWebLinkAdministration\updateWebLink().

                                  : void
    {
        if (ilContext::getType() === ilContext::CONTEXT_SOAP) {
            try {
                ilInitialisation::reinitILIAS();
            } catch (Exception $e) {
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isFault()

ilSoapAdministration::isFault

(

$object

)

Definition at line 198 of file class.ilSoapAdministration.php.

Referenced by ilSoapObjectAdministration\copyObject(), ilSoapCourseAdministration\excludeCourseMember(), ilSoapUserAdministration\getUsersForContainer(), ilSoapObjectAdministration\getXMLTree(), ilSoapObjectAdministration\moveObject(), ilSoapObjectAdministration\removeFromSystemByImportId(), and ilSoapObjectAdministration\validateReferences().

                                    : bool
    {
        switch ($this->error_method) {
            case self::NUSOAP:
                require_once __DIR__ . '/../lib/nusoap.php';
                return $object instanceof soap_fault;
            case self::PHP5:
                return $object instanceof SoapFault;
        }
        return true;
    }

Here is the caller graph for this function:

raiseError()

ilSoapAdministration::raiseError ( string  $a_message,   $a_code  )

protected

Parameters

string	$a_message
string | int	$a_code

Returns

soap_fault|SoapFault|null

Definition at line 186 of file class.ilSoapAdministration.php.

References null.

Referenced by ilSoapCourseAdministration\addCourse(), ILIAS\OrgUnit\Webservices\SOAP\Base\addError(), ilSoapExerciseAdministration\addExercise(), ilSoapFileAdministration\addFile(), ilSoapGroupAdministration\addGroup(), ilSoapObjectAdministration\addReference(), ilSoapRBACAdministration\addRole(), ilSoapRBACAdministration\addRoleFromTemplate(), ilSoapRBACAdministration\addUserRoleEntry(), ilSoapCourseAdministration\assignCourseMember(), ilSoapObjectAdministration\canAddType(), checkObjectAccess(), ilSoapObjectAdministration\copyObject(), ilSoapWebLinkAdministration\createWebLink(), ilSoapCourseAdministration\deleteCourse(), ilSoapObjectAdministration\deleteObject(), ilSoapRBACAdministration\deleteRole(), ilSoapRBACAdministration\deleteUserRoleEntry(), ilSoapCourseAdministration\excludeCourseMember(), ilSoapDataCollectionAdministration\exportDataCollectionContent(), getClientInfoXML(), ilSoapCourseAdministration\getCoursesForUser(), ilSoapGroupAdministration\getGroupsForUser(), ilSoapUserAdministration\getImportProtocolAsXML(), ilSoapSCORMAdministration\getIMSManifestXML(), ilSoapLearningProgressAdministration\getLearningProgressChanges(), ilSoapRBACAdministration\getLocalRoles(), ilSoapUtils\getMobsOfObject(), ilSoapTestAdministration\getNrOfQuestionsInPass(), ilSoapObjectAdministration\getObjectByReference(), ilSoapObjectAdministration\getObjectsByTitle(), ilSoapRBACAdministration\getObjectTreeOperations(), ilSoapObjectAdministration\getObjIdByImportId(), ilSoapObjectAdministration\getObjIdsByRefIds(), ilSoapRBACAdministration\getOperations(), ilSoapObjectAdministration\getPathForRefId(), ilSoapTestAdministration\getPositionOfQuestion(), ilSoapTestAdministration\getPreviousReachedPoints(), ilSoapTestAdministration\getQuestionSolution(), ilSoapObjectAdministration\getRefIdsByImportId(), ilSoapObjectAdministration\getRefIdsByObjId(), ilSoapRBACAdministration\getRoles(), ilSoapSCORMAdministration\getSCORMCompletionStatus(), ilSOAPStructureObjectAdministration\getStructureObjects(), ilSoapTestAdministration\getTestResults(), ilSoapTestAdministration\getTestUserData(), ilSoapObjectAdministration\getTreeChilds(), ilSoapUserAdministration\getUserForRole(), ilSoapUserAdministration\getUserIdBySid(), ilSoapUserAdministration\getUserMappingAsXML(), ilSoapRBACAdministration\getUserRoles(), ilSoapUserAdministration\getUsersForContainer(), ilSoapUserAdministration\getUserXML(), ilSoapObjectAdministration\getXMLTree(), ilSoapRBACAdministration\grantPermissions(), ilSoapGroupAdministration\groupExists(), ilSoapUserAdministration\hasNewMail(), ilSoapSCORMAdministration\hasSCORMCertificate(), ilSoapUtils\ilCloneDependencies(), ilSoapUserAdministration\importUsers(), ilSoapUserAdministration\login(), ilSoapUserAdministration\logout(), ilSoapUserAdministration\lookupUser(), ilSoapObjectAdministration\moveObject(), ilSoapRBACAdministration\parseUserID(), ilSoapWebLinkAdministration\readWebLink(), ilSoapObjectAdministration\removeFromSystemByImportId(), ilSoapTestAdministration\removeTestResults(), ilSoapRBACAdministration\revokePermissions(), ilSoapBackgroundTasksAdministration\runAsync(), ilSoapTestAdministration\saveQuestion(), ilSoapTestAdministration\saveQuestionSolution(), ilSoapUtils\saveTempFileAsMediaObject(), ilSoapObjectAdministration\searchObjects(), ilSoapRBACAdministration\searchRoles(), ilSoapUserAdministration\searchUser(), ilSoapWebLinkAdministration\updateWebLink(), and ilSoapObjectAdministration\validateReferences().

    {
        switch ($this->error_method) {
            case self::NUSOAP:
                require_once __DIR__ . '/../lib/nusoap.php';
                return new soap_fault($a_code, '', $a_message);
            case self::PHP5:
                return new SoapFault($a_code, $a_message);
        }
        return null;
    }

Here is the caller graph for this function:

reInitUser()

ilSoapAdministration::reInitUser

(

)

Definition at line 166 of file class.ilSoapAdministration.php.

References Vendor\Package\$e, ilContext\CONTEXT_SOAP, ilContext\getType(), and ilInitialisation\reInitUser().

Referenced by ilAbstractSoapMethod\initIliasAndCheckSession().

                                : void
    {
        if (ilContext::getType() === ilContext::CONTEXT_SOAP) {
            try {
                ilInitialisation::reInitUser();
            } catch (Exception $e) {
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setMessage()

ilSoapAdministration::setMessage ( string  $a_str )

protected

Definition at line 110 of file class.ilSoapAdministration.php.

Referenced by checkSession().

                                                : void
    {
        $this->message = $a_str;
    }

Here is the caller graph for this function:

setMessageCode()

ilSoapAdministration::setMessageCode

(

string

$a_code

)

Definition at line 126 of file class.ilSoapAdministration.php.

Referenced by checkSession().

                                                  : void
    {
        $this->message_code = $a_code;
    }

Here is the caller graph for this function:

Field Documentation

$error_method

int ilSoapAdministration::$error_method

Defines type of error handling (PHP5 || NUSOAP)

Definition at line 42 of file class.ilSoapAdministration.php.

$message

string ilSoapAdministration::$message = ''

protected

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

Referenced by ilSoapUserAdministration\getImportProtocolAsXML(), getMessage(), and ilSoapUserAdministration\getUserMappingAsXML().

$message_code

string ilSoapAdministration::$message_code = ''

protected

Definition at line 37 of file class.ilSoapAdministration.php.

Referenced by getMessageCode().

$soap_check

bool ilSoapAdministration::$soap_check = true

protected

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

NUSOAP

const ilSoapAdministration::NUSOAP = 1

Definition at line 32 of file class.ilSoapAdministration.php.

PHP5

const ilSoapAdministration::PHP5 = 2

Definition at line 33 of file class.ilSoapAdministration.php.

---

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

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