ILIAS  release_8 Revision v8.24
Public Member Functions | Static Public Member Functions
ilSoapFunctions Class Reference
+ Collaboration diagram for ilSoapFunctions:

Public Member Functions

 getUserIdsOfPositionAndOrgUnit (... $params)
 
 __call ($name, $arguments)
 

Static Public Member Functions

static login (string $client, string $username, string $password)
 
static logout (string $sid)
 
static lookupUser (string $sid, string $user_name)
 
static addCourse (string $sid, int $target_id, string $crs_xml)
 
static deleteCourse (string $sid, int $course_id)
 
static assignCourseMember (string $sid, int $course_id, int $user_id, string $type)
 
static isAssignedToCourse (string $sid, int $course_id, int $user_id)
 
static excludeCourseMember (string $sid, int $course_id, int $user_id)
 
static getCourseXML (string $sid, int $course_id)
 
static updateCourse (string $sid, int $course_id, string $xml)
 
static getObjIdByImportId (string $sid, string $import_id)
 
static getRefIdsByImportId (string $sid, string $import_id)
 
static getRefIdsByObjId (string $sid, int $object_id)
 
static getObjectByReference (string $sid, int $a_ref_id, ?int $user_id=null)
 
static getObjectsByTitle (string $sid, string $a_title, ?int $user_id=null)
 
static addObject (string $sid, int $a_target_id, string $a_xml)
 
static addReference (string $sid, int $a_source_id, int $a_target_id)
 
static deleteObject (string $sid, int $reference_id)
 
static removeFromSystemByImportId (string $sid, string $import_id)
 
static updateObjects (string $sid, string $obj_xml)
 
static searchObjects (string $sid, array $types, string $key, string $combination, ?int $user_id=null)
 
static getTreeChilds (string $sid, int $ref_id, array $types, int $user_id)
 
static getXMLTree (string $sid, int $ref_id, array $types, ?int $user_id=null)
 
static getOperations (string $sid)
 
static addUserRoleEntry (string $sid, int $user_id, int $role_id)
 
static deleteUserRoleEntry (string $sid, int $user_id, int $role_id)
 
static revokePermissions (string $sid, int $ref_id, int $role_id)
 
static grantPermissions (string $sid, int $ref_id, int $role_id, array $permissions)
 
static getLocalRoles (string $sid, int $ref_id)
 
static getUserRoles (string $sid, int $user_id)
 
static deleteRole (string $sid, int $role_id)
 
static addRole (string $sid, int $target_id, string $obj_xml)
 
static addRoleFromTemplate (string $sid, int $target_id, string $obj_xml, int $template_id)
 
static getObjectTreeOperations (string $sid, int $ref_id, int $user_id)
 
static addGroup (string $sid, int $target_id, string $group_xml)
 
static groupExists (string $sid, string $title)
 
static getGroup (string $sid, int $ref_id)
 
static assignGroupMember (string $sid, int $group_id, int $user_id, string $type)
 
static isAssignedToGroup (string $sid, int $group_id, int $user_id)
 
static excludeGroupMember (string $sid, int $group_id, int $user_id)
 
static distributeMails (string $sid, string $mail_xml)
 
static ilClone (string $sid, int $copy_identifier)
 
static ilCloneDependencies (string $sid, int $copy_identifier)
 
static saveQuestion (string $sid, int $active_id, int $question_id, int $pass, array $solution)
 
static saveQuestionSolution (string $sid, int $active_id, int $question_id, int $pass, int $solution)
 
static getQuestionSolution (string $sid, int $active_id, int $question_id, int $pass)
 
static getTestUserData (string $sid, int $active_id)
 
static getNrOfQuestionsInPass (string $sid, int $active_id, int $pass)
 
static getPositionOfQuestion (string $sid, int $active_id, int $question_id, int $pass)
 
static getPreviousReachedPoints (string $sid, int $active_id, int $question_id, int $pass)
 
static saveTempFileAsMediaObject (string $sid, string $name, string $tmp_name)
 
static getMobsOfObject (string $sid, string $a_type, int $a_id)
 
static getStructureObjects (string $sid, int $ref_id)
 
static getRoles (string $sid, string $role_type, int $id)
 
static importUsers (string $sid, int $folder_id, string $usr_xml, int $conflict_rule, bool $send_account_mail)
 
static getUsersForContainer (string $sid, int $ref_id, bool $attach_roles, int $active)
 
static getUsersForRole (string $sid, int $role_id, bool $attach_roles, int $active)
 
static searchUser (string $sid, array $a_keyfields, string $query_operator, array $a_keyvalues, bool $attach_roles, int $active)
 
static hasNewMail (string $sid)
 
static getExerciseXML (string $sid, int $ref_id, int $attachFileContentsMode)
 
static updateExercise (string $sid, int $ref_id, string $xml)
 
static addExercise (string $sid, int $ref_id, string $xml)
 
static getFileXML (string $sid, int $ref_id, int $attachFileContentsMode)
 
static updateFile (string $sid, int $ref_id, string $xml)
 
static addFile (string $sid, int $ref_id, string $xml)
 
static getObjIdsByRefIds (string $sid, array $ref_ids)
 
static getUserXML (string $sid, array $user_ids, bool $attach_roles)
 
static updateGroup (string $sid, int $ref_id, string $grp_xml)
 
static getIMSManifestXML (string $sid, int $ref_id)
 
static hasSCORMCertificate (string $sid, int $ref_id, int $usr_id)
 
static copyObject (string $sid, string $copy_settings_xml)
 
static startBackgroundTaskWorker (string $sid)
 
static moveObject (string $sid, int $ref_id, int $target_id)
 
static getTestResults (string $sid, int $ref_id, bool $sum_only)
 
static removeTestResults (string $sid, int $ref_id, array $a_user_ids)
 
static getCoursesForUser (string $sid, string $parameters)
 
static getGroupsForUser (string $sid, string $parameters)
 
static getPathForRefId (string $sid, int $ref_id)
 
static searchRoles (string $sid, string $key, string $combination, string $role_type)
 
static getInstallationInfoXML ()
 
static getClientInfoXML (string $clientid)
 
static buildHTTPPath ()
 
static getSCORMCompletionStatus (string $sid, int $usr_id, int $a_ref_id)
 
static getUserIdBySid (string $sid)
 
static readWebLink (string $sid, int $ref_id)
 
static createWebLink (string $sid, int $ref_id, string $xml)
 
static updateWebLink (string $sid, int $ref_id, string $xml)
 
static deleteExpiredDualOptInUserObjects (string $sid, int $usr_id)
 
static deleteProgress (string $sid, array $ref_ids, array $usr_ids, array $type_filter, array $progress_filter)
 
static getLearningProgressChanges (string $sid, string $timestamp, bool $include_ref_ids, array $type_filter)
 
static getProgressInfo (string $sid, int $ref_id, array $progress_filter)
 
static exportDataCollectionContent (string $sid, int $data_collection_id, ?int $table_id=null, string $format="xls", ?string $filepath=null)
 
static addUserToPositionInOrgUnit (... $params)
 
static getEmployeePositionId (... $params)
 
static importOrgUnitsSimpleXML (... $params)
 
static getOrgUnitsSimpleXML (... $params)
 
static getPositionIds (... $params)
 
static getPositionTitle (... $params)
 
static removeUserFromPositionInOrgUnit (... $params)
 
static getSuperiorPositionId (... $params)
 
static getUserIdsOfPosition (... $params)
 

Detailed Description

Definition at line 39 of file inc.soap_functions.php.

Member Function Documentation

◆ __call()

ilSoapFunctions::__call (   $name,
  $arguments 
)
Parameters
mixed$name
mixed$arguments
Returns
mixed
Exceptions
SoapFault

Definition at line 1090 of file inc.soap_functions.php.

1091 {
1092 // SoapHookPlugins need the client-ID submitted
1093 // no initialized ILIAS => no request wrapper available.
1094 if (!isset($_GET['client_id'])) {
1095 throw new SoapFault('SOAP-ENV:Server', "Function '$name' does not exist");
1096 }
1097 // Note: We need to bootstrap ILIAS in order to get $ilPluginAdmin and load the soap plugins.
1098 // We MUST use a context that does not handle authentication at this point (session is checked by SOAP).
1099 ilContext::init(ilContext::CONTEXT_SOAP_NO_AUTH);
1100 require_once 'Services/Init/classes/class.ilInitialisation.php';
1101 ilInitialisation::initILIAS();
1102 ilContext::init(ilContext::CONTEXT_SOAP);
1103 global $DIC;
1104 $soapHook = new ilSoapHook($DIC['component.factory']);
1105 // Method name may be invoked with namespace e.g. 'myMethod' vs 'ns:myMethod'
1106 if (strpos($name, ':') !== false) {
1107 [$_, $name] = explode(':', $name);
1108 }
1109 $method = $soapHook->getMethodByName($name);
1110 if ($method) {
1111 try {
1112 return $method->execute($arguments);
1113 } catch (ilSoapPluginException $e) {
1114 throw new SoapFault('SOAP-ENV:Server', $e->getMessage());
1115 }
1116 }
1117 throw new SoapFault('SOAP-ENV:Server', "Function '$name' does not exist");
1118 }
ilContext\CONTEXT_SOAP_NO_AUTH
const CONTEXT_SOAP_NO_AUTH
Definition: class.ilContext.php:35
ilContext\init
static init(string $a_type)
Init context by type.
Definition: class.ilContext.php:52
ilContext\CONTEXT_SOAP
const CONTEXT_SOAP
Definition: class.ilContext.php:34
ilInitialisation\initILIAS
static initILIAS()
ilias initialisation
Definition: class.ilInitialisation.php:1225
ilSoapHook
Class ilSoapHook.
Definition: class.ilSoapHook.php:10
ilSoapPluginException
Class ilSoapPluginException.
Definition: class.ilSoapPluginException.php:11
$DIC
global $DIC
Definition: feed.php:28
$name
if($format !==null) $name
Definition: metadata.php:247
$_GET
$_GET['client_id']
Definition: saml1-acs.php:21

References $_GET, $DIC, Vendor\Package\$e, $name, ilContext\CONTEXT_SOAP, ilContext\CONTEXT_SOAP_NO_AUTH, ilContext\init(), and ilInitialisation\initILIAS().

+ Here is the call graph for this function:

◆ addCourse()

static ilSoapFunctions::addCourse ( string  $sid,
int  $target_id,
string  $crs_xml 
)
static
Returns
int|soap_fault|SoapFault|string|null

Definition at line 76 of file inc.soap_functions.php.

77 {
78 include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';
79 $sca = new ilSoapCourseAdministration();
80 return $sca->addCourse($sid, $target_id, $crs_xml);
81 }
$target_id
$target_id
Definition: goto.php:52

References $target_id.

◆ addExercise()

static ilSoapFunctions::addExercise ( string  $sid,
int  $ref_id,
string  $xml 
)
static
Returns
int|soap_fault|SoapFault|null

Definition at line 666 of file inc.soap_functions.php.

667 {
668 include_once './webservice/soap/classes/class.ilSoapExerciseAdministration.php';
669 $sta = new ilSoapExerciseAdministration();
670 return $sta->addExercise($sid, $ref_id, $xml);
671 }
ilSoapExerciseAdministration
Soap exercise administration methods.
Definition: class.ilSoapExerciseAdministration.php:31
$ref_id
$ref_id
Definition: ltiauth.php:67
$xml
$xml
Definition: metadata.php:351

References $ref_id, and $xml.

◆ addFile()

static ilSoapFunctions::addFile ( string  $sid,
int  $ref_id,
string  $xml 
)
static
Returns
int|soap_fault|SoapFault|null

Definition at line 696 of file inc.soap_functions.php.

697 {
698 include_once './webservice/soap/classes/class.ilSoapFileAdministration.php';
699 $sta = new ilSoapFileAdministration();
700 return $sta->addFile($sid, $ref_id, $xml);
701 }
ilSoapFileAdministration
Soap file administration methods.
Definition: class.ilSoapFileAdministration.php:31

References $ref_id, and $xml.

◆ addGroup()

static ilSoapFunctions::addGroup ( string  $sid,
int  $target_id,
string  $group_xml 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 386 of file inc.soap_functions.php.

387 {
388 include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';
389 $soa = new ilSoapGroupAdministration();
390 return $soa->addGroup($sid, $target_id, $group_xml);
391 }

References $target_id.

◆ addObject()

static ilSoapFunctions::addObject ( string  $sid,
int  $a_target_id,
string  $a_xml 
)
static
Returns
bool|int|soap_fault|SoapFault|string|null

Definition at line 196 of file inc.soap_functions.php.

197 {
198 include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
199 $soa = new ilSoapObjectAdministration();
200 return $soa->addObject($sid, $a_target_id, $a_xml);
201 }

◆ addReference()

static ilSoapFunctions::addReference ( string  $sid,
int  $a_source_id,
int  $a_target_id 
)
static
Returns
int|soap_fault|SoapFault|string|null

Definition at line 206 of file inc.soap_functions.php.

207 {
208 include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
209 $soa = new ilSoapObjectAdministration();
210 return $soa->addReference($sid, $a_source_id, $a_target_id);
211 }

◆ addRole()

static ilSoapFunctions::addRole ( string  $sid,
int  $target_id,
string  $obj_xml 
)
static
Returns
array|soap_fault|SoapFault|null

Definition at line 356 of file inc.soap_functions.php.

357 {
358 include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
359 $soa = new ilSoapRBACAdministration();
360 return $soa->addRole($sid, $target_id, $obj_xml);
361 }
ilSoapRBACAdministration
Soap rbac administration methods.
Definition: class.ilSoapRBACAdministration.php:31

References $target_id.

◆ addRoleFromTemplate()

static ilSoapFunctions::addRoleFromTemplate ( string  $sid,
int  $target_id,
string  $obj_xml,
int  $template_id 
)
static
Returns
array|soap_fault|SoapFault|null

Definition at line 366 of file inc.soap_functions.php.

367 {
368 include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
369 $soa = new ilSoapRBACAdministration();
370 return $soa->addRoleFromTemplate($sid, $target_id, $obj_xml, $template_id);
371 }

References $target_id.

◆ addUserRoleEntry()

static ilSoapFunctions::addUserRoleEntry ( string  $sid,
int  $user_id,
int  $role_id 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 286 of file inc.soap_functions.php.

287 {
288 include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
289 $soa = new ilSoapRBACAdministration();
290 return $soa->addUserRoleEntry($sid, $user_id, $role_id);
291 }

◆ addUserToPositionInOrgUnit()

static ilSoapFunctions::addUserToPositionInOrgUnit (   $params)
static
Parameters
...$params
Returns
mixed

Definition at line 988 of file inc.soap_functions.php.

989 {
990 $h = new AddUserIdToPositionInOrgUnit();
991 return $h->execute($params);
992 }
$params
if(! $DIC->user() ->getId()||!ilLTIConsumerAccess::hasCustomProviderCreationAccess()) $params
Definition: ltiregstart.php:33

References $params.

◆ assignCourseMember()

static ilSoapFunctions::assignCourseMember ( string  $sid,
int  $course_id,
int  $user_id,
string  $type 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 96 of file inc.soap_functions.php.

97 {
98 include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';
99 $sca = new ilSoapCourseAdministration();
100 return $sca->assignCourseMember($sid, $course_id, $user_id, $type);
101 }
$type
$type
Definition: proxy_ylocal.php:10

References $type.

◆ assignGroupMember()

static ilSoapFunctions::assignGroupMember ( string  $sid,
int  $group_id,
int  $user_id,
string  $type 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 416 of file inc.soap_functions.php.

417 {
418 include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';
419 $sca = new ilSoapGroupAdministration();
420 return $sca->assignGroupMember($sid, $group_id, $user_id, $type);
421 }

References $type.

◆ buildHTTPPath()

static ilSoapFunctions::buildHTTPPath ( )
static
Returns
string

Definition at line 860 of file inc.soap_functions.php.

860 : string
861 {
862 if (($_SERVER["HTTPS"] ?? '') === "on") {
863 $protocol = 'https://';
864 } else {
865 $protocol = 'http://';
866 }
867 $host = $_SERVER['HTTP_HOST'] ?? '';
868
869 $path = dirname($_SERVER['REQUEST_URI'] ?? '');
870
871 //dirname cuts the last directory from a directory path e.g content/classes return content
872 include_once 'Services/FileServices/classes/class.ilFileUtils.php';
873 $module = ilFileUtils::removeTrailingPathSeparators(ILIAS_MODULE);
874
875 $dirs = explode('/', $module);
876 $uri = $path;
877 foreach ($dirs as $dir) {
878 $uri = dirname($uri);
879 }
880 return ilFileUtils::removeTrailingPathSeparators($protocol . $host . $uri);
881 }
ilFileUtils\removeTrailingPathSeparators
static removeTrailingPathSeparators(string $path)
Definition: class.ilFileUtils.php:1038
$path
$path
Definition: ltiservices.php:32
$_SERVER
$_SERVER['HTTP_HOST']
Definition: raiseError.php:10
ILIAS_MODULE
const ILIAS_MODULE
Definition: server.php:14

References $_SERVER, $path, ILIAS_MODULE, and ilFileUtils\removeTrailingPathSeparators().

Referenced by ilSoapInstallationInfoXMLWriter\buildHeader().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ copyObject()

static ilSoapFunctions::copyObject ( string  $sid,
string  $copy_settings_xml 
)
static
Returns
bool|int|mixed|soap_fault|SoapFault|null

Definition at line 753 of file inc.soap_functions.php.

754 {
755 include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
756 $soa = new ilSoapObjectAdministration();
757 return $soa->copyObject($sid, $copy_settings_xml);
758 }

◆ createWebLink()

static ilSoapFunctions::createWebLink ( string  $sid,
int  $ref_id,
string  $xml 
)
static
Returns
int|soap_fault|SoapFault|null

Definition at line 916 of file inc.soap_functions.php.

917 {
918 include_once './webservice/soap/classes/class.ilSoapWebLinkAdministration.php';
919
920 $swa = new ilSoapWebLinkAdministration();
921 return $swa->createWebLink($sid, $ref_id, $xml);
922 }
ilSoapWebLinkAdministration
Soap methods for adminstrating web links.
Definition: class.ilSoapWebLinkAdministration.php:9

References $ref_id, and $xml.

◆ deleteCourse()

static ilSoapFunctions::deleteCourse ( string  $sid,
int  $course_id 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 86 of file inc.soap_functions.php.

87 {
88 include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';
89 $sca = new ilSoapCourseAdministration();
90 return $sca->deleteCourse($sid, $course_id);
91 }

◆ deleteExpiredDualOptInUserObjects()

static ilSoapFunctions::deleteExpiredDualOptInUserObjects ( string  $sid,
int  $usr_id 
)
static

Definition at line 934 of file inc.soap_functions.php.

934 : bool
935 {
936 include_once './webservice/soap/classes/class.ilSoapUtils.php';
937
938 $sou = new ilSoapUtils();
939 $sou->disableSOAPCheck();
940 $sou->ignoreUserAbort();
941 return $sou->deleteExpiredDualOptInUserObjects($sid, $usr_id);
942 }
ilSoapUtils
Soap utitliy functions.
Definition: class.ilSoapUtils.php:33

◆ deleteObject()

static ilSoapFunctions::deleteObject ( string  $sid,
int  $reference_id 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 216 of file inc.soap_functions.php.

217 {
218 include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
219 $soa = new ilSoapObjectAdministration();
220 return $soa->deleteObject($sid, $reference_id);
221 }

◆ deleteProgress()

static ilSoapFunctions::deleteProgress ( string  $sid,
array  $ref_ids,
array  $usr_ids,
array  $type_filter,
array  $progress_filter 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 947 of file inc.soap_functions.php.

948 {
949 include_once './webservice/soap/classes/class.ilSoapLearningProgressAdministration.php';
950 $sla = new ilSoapLearningProgressAdministration();
951 return $sla->deleteProgress($sid, $ref_ids, $usr_ids, $type_filter, $progress_filter);
952 }
ilSoapLearningProgressAdministration
This class handles all DB changes necessary for fraunhofer.
Definition: class.ilSoapLearningProgressAdministration.php:13

◆ deleteRole()

static ilSoapFunctions::deleteRole ( string  $sid,
int  $role_id 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 346 of file inc.soap_functions.php.

347 {
348 include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
349 $soa = new ilSoapRBACAdministration();
350 return $soa->deleteRole($sid, $role_id);
351 }

◆ deleteUserRoleEntry()

static ilSoapFunctions::deleteUserRoleEntry ( string  $sid,
int  $user_id,
int  $role_id 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 296 of file inc.soap_functions.php.

297 {
298 include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
299 $soa = new ilSoapRBACAdministration();
300 return $soa->deleteUserRoleEntry($sid, $user_id, $role_id);
301 }

◆ distributeMails()

static ilSoapFunctions::distributeMails ( string  $sid,
string  $mail_xml 
)
static
Deprecated:
Returns
bool|soap_fault|SoapFault|null

Definition at line 447 of file inc.soap_functions.php.

448 {
449 include_once './webservice/soap/classes/class.ilSoapUtils.php';
450 $sou = new ilSoapUtils();
451 return $sou->distributeMails($sid, $mail_xml);
452 }

◆ excludeCourseMember()

static ilSoapFunctions::excludeCourseMember ( string  $sid,
int  $course_id,
int  $user_id 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 116 of file inc.soap_functions.php.

117 {
118 include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';
119 $sca = new ilSoapCourseAdministration();
120 return $sca->excludeCourseMember($sid, $course_id, $user_id);
121 }

◆ excludeGroupMember()

static ilSoapFunctions::excludeGroupMember ( string  $sid,
int  $group_id,
int  $user_id 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 436 of file inc.soap_functions.php.

437 {
438 include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';
439 $sca = new ilSoapGroupAdministration();
440 return $sca->excludeGroupMember($sid, $group_id, $user_id);
441 }

◆ exportDataCollectionContent()

static ilSoapFunctions::exportDataCollectionContent ( string  $sid,
int  $data_collection_id,
?int  $table_id = null,
string  $format = "xls",
?string  $filepath = null 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 977 of file inc.soap_functions.php.

978 {
979 include_once './webservice/soap/classes/class.ilSoapDataCollectionAdministration.php';
980 $dcl = new ilSoapDataCollectionAdministration();
981 return $dcl->exportDataCollectionContent($sid, $data_collection_id, $table_id, $format, $filepath);
982 }
ilSoapDataCollectionAdministration
Soap data-collection administration methods.
Definition: class.ilSoapDataCollectionAdministration.php:30
$format
$format
Definition: metadata.php:235

References $format.

◆ getClientInfoXML()

static ilSoapFunctions::getClientInfoXML ( string  $clientid)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 850 of file inc.soap_functions.php.

851 {
852 include_once 'webservice/soap/classes/class.ilSoapAdministration.php';
853 $roa = new ilSoapAdministration();
854 return $roa->getClientInfoXML($clientid);
855 }
ilSoapAdministration
soap server Base class for all SOAP registered methods.
Definition: class.ilSoapAdministration.php:31

◆ getCoursesForUser()

static ilSoapFunctions::getCoursesForUser ( string  $sid,
string  $parameters 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 803 of file inc.soap_functions.php.

804 {
805 include_once 'webservice/soap/classes/class.ilSoapCourseAdministration.php';
806 $soc = new ilSoapCourseAdministration();
807 return $soc->getCoursesForUser($sid, $parameters);
808 }

◆ getCourseXML()

static ilSoapFunctions::getCourseXML ( string  $sid,
int  $course_id 
)
static
Returns
ilObjCourse|soap_fault|SoapFault|string|null

Definition at line 126 of file inc.soap_functions.php.

127 {
128 include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';
129 $sca = new ilSoapCourseAdministration();
130 return $sca->getCourseXML($sid, $course_id);
131 }

◆ getEmployeePositionId()

static ilSoapFunctions::getEmployeePositionId (   $params)
static
Parameters
...$params
Returns
mixed

Definition at line 998 of file inc.soap_functions.php.

999 {
1000 $h = new EmployeePositionId();
1001 return $h->execute($params);
1002 }

References $params.

◆ getExerciseXML()

static ilSoapFunctions::getExerciseXML ( string  $sid,
int  $ref_id,
int  $attachFileContentsMode 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 646 of file inc.soap_functions.php.

647 {
648 include_once './webservice/soap/classes/class.ilSoapExerciseAdministration.php';
649 $sta = new ilSoapExerciseAdministration();
650 return $sta->getExerciseXML($sid, $ref_id, $attachFileContentsMode);
651 }

References $ref_id.

◆ getFileXML()

static ilSoapFunctions::getFileXML ( string  $sid,
int  $ref_id,
int  $attachFileContentsMode 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 676 of file inc.soap_functions.php.

677 {
678 include_once './webservice/soap/classes/class.ilSoapFileAdministration.php';
679 $sta = new ilSoapFileAdministration();
680 return $sta->getFileXML($sid, $ref_id, $attachFileContentsMode);
681 }

References $ref_id.

◆ getGroup()

static ilSoapFunctions::getGroup ( string  $sid,
int  $ref_id 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 406 of file inc.soap_functions.php.

407 {
408 include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';
409 $soa = new ilSoapGroupAdministration();
410 return $soa->getGroup($sid, $ref_id);
411 }

References $ref_id.

◆ getGroupsForUser()

static ilSoapFunctions::getGroupsForUser ( string  $sid,
string  $parameters 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 813 of file inc.soap_functions.php.

814 {
815 include_once 'webservice/soap/classes/class.ilSoapGroupAdministration.php';
816 $soc = new ilSoapGroupAdministration();
817 return $soc->getGroupsForUser($sid, $parameters);
818 }

◆ getIMSManifestXML()

static ilSoapFunctions::getIMSManifestXML ( string  $sid,
int  $ref_id 
)
static
Returns
false|soap_fault|SoapFault|string|null

Definition at line 736 of file inc.soap_functions.php.

737 {
738 include_once './webservice/soap/classes/class.ilSoapSCORMAdministration.php';
739 $sua = new ilSoapSCORMAdministration();
740 return $sua->getIMSManifestXML($sid, $ref_id);
741 }

References $ref_id.

◆ getInstallationInfoXML()

static ilSoapFunctions::getInstallationInfoXML ( )
static

Definition at line 840 of file inc.soap_functions.php.

840 : string
841 {
842 include_once 'webservice/soap/classes/class.ilSoapAdministration.php';
843 $roa = new ilSoapAdministration();
844 return $roa->getInstallationInfoXML();
845 }

◆ getLearningProgressChanges()

static ilSoapFunctions::getLearningProgressChanges ( string  $sid,
string  $timestamp,
bool  $include_ref_ids,
array  $type_filter 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 957 of file inc.soap_functions.php.

958 {
959 include_once './webservice/soap/classes/class.ilSoapLearningProgressAdministration.php';
960 $s = new ilSoapLearningProgressAdministration();
961 return $s->getLearningProgressChanges($sid, $timestamp, $include_ref_ids, $type_filter);
962 }
$timestamp
foreach($mandatory_scripts as $file) $timestamp
Definition: buildRTE.php:70

References $timestamp.

◆ getLocalRoles()

static ilSoapFunctions::getLocalRoles ( string  $sid,
int  $ref_id 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 326 of file inc.soap_functions.php.

327 {
328 include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
329 $soa = new ilSoapRBACAdministration();
330 return $soa->getLocalRoles($sid, $ref_id);
331 }

References $ref_id.

◆ getMobsOfObject()

static ilSoapFunctions::getMobsOfObject ( string  $sid,
string  $a_type,
int  $a_id 
)
static
Returns
int[]|soap_fault|SoapFault|null

Definition at line 565 of file inc.soap_functions.php.

566 {
567 include_once './webservice/soap/classes/class.ilSoapUtils.php';
568 $sou = new ilSoapUtils();
569 $sou->disableSOAPCheck();
570 return $sou->getMobsOfObject($sid, $a_type, $a_id);
571 }

◆ getNrOfQuestionsInPass()

static ilSoapFunctions::getNrOfQuestionsInPass ( string  $sid,
int  $active_id,
int  $pass 
)
static
Returns
int|soap_fault|SoapFault|null

Definition at line 523 of file inc.soap_functions.php.

524 {
525 include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
526 $sass = new ilSoapTestAdministration();
527 return $sass->getNrOfQuestionsInPass($sid, $active_id, $pass);
528 }

◆ getObjectByReference()

static ilSoapFunctions::getObjectByReference ( string  $sid,
int  $a_ref_id,
?int  $user_id = null 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 176 of file inc.soap_functions.php.

177 {
178 include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
179 $soa = new ilSoapObjectAdministration();
180 return $soa->getObjectByReference($sid, $a_ref_id, $user_id);
181 }

◆ getObjectsByTitle()

static ilSoapFunctions::getObjectsByTitle ( string  $sid,
string  $a_title,
?int  $user_id = null 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 186 of file inc.soap_functions.php.

187 {
188 include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
189 $soa = new ilSoapObjectAdministration();
190 return $soa->getObjectsByTitle($sid, $a_title, $user_id);
191 }

◆ getObjectTreeOperations()

static ilSoapFunctions::getObjectTreeOperations ( string  $sid,
int  $ref_id,
int  $user_id 
)
static
Returns
array|soap_fault|SoapFault|null

Definition at line 376 of file inc.soap_functions.php.

377 {
378 include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
379 $soa = new ilSoapRBACAdministration();
380 return $soa->getObjectTreeOperations($sid, $ref_id, $user_id);
381 }

References $ref_id.

◆ getObjIdByImportId()

static ilSoapFunctions::getObjIdByImportId ( string  $sid,
string  $import_id 
)
static
Returns
int|soap_fault|SoapFault|string|null

Definition at line 146 of file inc.soap_functions.php.

147 {
148 include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
149 $soa = new ilSoapObjectAdministration();
150 return $soa->getObjIdByImportId($sid, $import_id);
151 }

◆ getObjIdsByRefIds()

static ilSoapFunctions::getObjIdsByRefIds ( string  $sid,
array  $ref_ids 
)
static
Returns
array|soap_fault|SoapFault|null

Definition at line 706 of file inc.soap_functions.php.

707 {
708 include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
709 $soa = new ilSoapObjectAdministration();
710 return $soa->getObjIdsByRefIds($sid, $ref_ids);
711 }

◆ getOperations()

static ilSoapFunctions::getOperations ( string  $sid)
static
Returns
soap_fault|SoapFault|null|array

Definition at line 276 of file inc.soap_functions.php.

277 {
278 include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
279 $soa = new ilSoapRBACAdministration();
280 return $soa->getOperations($sid);
281 }

◆ getOrgUnitsSimpleXML()

static ilSoapFunctions::getOrgUnitsSimpleXML (   $params)
static
Parameters
...$params
Returns
mixed

Definition at line 1018 of file inc.soap_functions.php.

1019 {
1020 $h = new OrgUnitTree();
1021 return $h->execute($params);
1022 }

References $params.

◆ getPathForRefId()

static ilSoapFunctions::getPathForRefId ( string  $sid,
int  $ref_id 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 823 of file inc.soap_functions.php.

824 {
825 include_once 'webservice/soap/classes/class.ilSoapObjectAdministration.php';
826 $soa = new ilSoapObjectAdministration();
827 return $soa->getPathForRefId($sid, $ref_id);
828 }

References $ref_id.

◆ getPositionIds()

static ilSoapFunctions::getPositionIds (   $params)
static
Parameters
...$params
Returns
mixed

Definition at line 1028 of file inc.soap_functions.php.

1029 {
1030 $h = new PositionIds();
1031 return $h->execute($params);
1032 }

References $params.

◆ getPositionOfQuestion()

static ilSoapFunctions::getPositionOfQuestion ( string  $sid,
int  $active_id,
int  $question_id,
int  $pass 
)
static
Returns
false|int|soap_fault|SoapFault|string|null

Definition at line 533 of file inc.soap_functions.php.

534 {
535 include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
536 $sass = new ilSoapTestAdministration();
537 return $sass->getPositionOfQuestion($sid, $active_id, $question_id, $pass);
538 }

◆ getPositionTitle()

static ilSoapFunctions::getPositionTitle (   $params)
static
Parameters
...$params
Returns
mixed

Definition at line 1038 of file inc.soap_functions.php.

1039 {
1040 $h = new PositionTitle();
1041 return $h->execute($params);
1042 }

References $params.

◆ getPreviousReachedPoints()

static ilSoapFunctions::getPreviousReachedPoints ( string  $sid,
int  $active_id,
int  $question_id,
int  $pass 
)
static
Returns
array|int|soap_fault|SoapFault|null

Definition at line 543 of file inc.soap_functions.php.

544 {
545 include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
546 $sass = new ilSoapTestAdministration();
547 return $sass->getPreviousReachedPoints($sid, $active_id, $question_id, $pass);
548 }

◆ getProgressInfo()

static ilSoapFunctions::getProgressInfo ( string  $sid,
int  $ref_id,
array  $progress_filter 
)
static
Returns
soap_fault|SoapFault|string

Definition at line 967 of file inc.soap_functions.php.

968 {
969 include_once './webservice/soap/classes/class.ilSoapLearningProgressAdministration.php';
970 $sla = new ilSoapLearningProgressAdministration();
971 return $sla->getProgressInfo($sid, $ref_id, $progress_filter);
972 }

References $ref_id.

◆ getQuestionSolution()

static ilSoapFunctions::getQuestionSolution ( string  $sid,
int  $active_id,
int  $question_id,
int  $pass 
)
static
Returns
array|soap_fault|SoapFault|null

Definition at line 503 of file inc.soap_functions.php.

504 {
505 include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
506 $sass = new ilSoapTestAdministration();
507 return $sass->getQuestionSolution($sid, $active_id, $question_id, $pass);
508 }

◆ getRefIdsByImportId()

static ilSoapFunctions::getRefIdsByImportId ( string  $sid,
string  $import_id 
)
static
Returns
array|soap_fault|SoapFault|null

Definition at line 156 of file inc.soap_functions.php.

157 {
158 include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
159 $soa = new ilSoapObjectAdministration();
160 return $soa->getRefIdsByImportId($sid, $import_id);
161 }

◆ getRefIdsByObjId()

static ilSoapFunctions::getRefIdsByObjId ( string  $sid,
int  $object_id 
)
static
Returns
array|soap_fault|SoapFault|null

Definition at line 166 of file inc.soap_functions.php.

167 {
168 include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
169 $soa = new ilSoapObjectAdministration();
170 return $soa->getRefIdsByObjId($sid, $object_id);
171 }

◆ getRoles()

static ilSoapFunctions::getRoles ( string  $sid,
string  $role_type,
int  $id 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 586 of file inc.soap_functions.php.

587 {
588 include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
589 $soa = new ilSoapRBACAdministration();
590 return $soa->getRoles($sid, $role_type, $id);
591 }
$id
$id
plugin.php for ilComponentBuildPluginInfoObjectiveTest::testAddPlugins
Definition: plugin.php:23

References $id.

◆ getSCORMCompletionStatus()

static ilSoapFunctions::getSCORMCompletionStatus ( string  $sid,
int  $usr_id,
int  $a_ref_id 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 886 of file inc.soap_functions.php.

887 {
888 include_once './webservice/soap/classes/class.ilSoapSCORMAdministration.php';
889 $sua = new ilSoapSCORMAdministration();
890 return $sua->getSCORMCompletionStatus($sid, $usr_id, $a_ref_id);
891 }

◆ getStructureObjects()

static ilSoapFunctions::getStructureObjects ( string  $sid,
int  $ref_id 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 576 of file inc.soap_functions.php.

577 {
578 include_once './webservice/soap/classes/class.ilSoapStructureObjectAdministration.php';
579 $sca = new ilSOAPStructureObjectAdministration();
580 return $sca->getStructureObjects($sid, $ref_id);
581 }

References $ref_id.

◆ getSuperiorPositionId()

static ilSoapFunctions::getSuperiorPositionId (   $params)
static
Parameters
...$params
Returns
mixed

Definition at line 1058 of file inc.soap_functions.php.

1059 {
1060 $h = new SuperiorPositionId();
1061 return $h->execute($params);
1062 }

References $params.

◆ getTestResults()

static ilSoapFunctions::getTestResults ( string  $sid,
int  $ref_id,
bool  $sum_only 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 783 of file inc.soap_functions.php.

784 {
785 include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
786 $soa = new ilSoapTestAdministration();
787 return $soa->getTestResults($sid, $ref_id, $sum_only);
788 }

References $ref_id.

◆ getTestUserData()

static ilSoapFunctions::getTestUserData ( string  $sid,
int  $active_id 
)
static
Returns
array|soap_fault|SoapFault|null

Definition at line 513 of file inc.soap_functions.php.

514 {
515 include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
516 $sass = new ilSoapTestAdministration();
517 return $sass->getTestUserData($sid, $active_id);
518 }

◆ getTreeChilds()

static ilSoapFunctions::getTreeChilds ( string  $sid,
int  $ref_id,
array  $types,
int  $user_id 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 256 of file inc.soap_functions.php.

257 {
258 include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
259 $soa = new ilSoapObjectAdministration();
260 return $soa->getTreeChilds($sid, $ref_id, $types, $user_id);
261 }

References $ref_id.

◆ getUserIdBySid()

static ilSoapFunctions::getUserIdBySid ( string  $sid)
static
Returns
int|soap_fault|SoapFault|null

Definition at line 896 of file inc.soap_functions.php.

897 {
898 include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
899 $sua = new ilSoapUserAdministration();
900 return $sua->getUserIdBySid($sid);
901 }

◆ getUserIdsOfPosition()

static ilSoapFunctions::getUserIdsOfPosition (   $params)
static
Parameters
...$params
Returns
mixed

Definition at line 1068 of file inc.soap_functions.php.

1069 {
1070 $h = new UserIdsOfPosition();
1071 return $h->execute($params);
1072 }

References $params.

◆ getUserIdsOfPositionAndOrgUnit()

ilSoapFunctions::getUserIdsOfPositionAndOrgUnit (   $params)
Parameters
...$params
Returns
mixed

Definition at line 1078 of file inc.soap_functions.php.

1079 {
1080 $h = new UserIdsOfPositionAndOrgUnit();
1081 return $h->execute($params);
1082 }

References $params.

◆ getUserRoles()

static ilSoapFunctions::getUserRoles ( string  $sid,
int  $user_id 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 336 of file inc.soap_functions.php.

337 {
338 include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
339 $soa = new ilSoapRBACAdministration();
340 return $soa->getUserRoles($sid, $user_id);
341 }

◆ getUsersForContainer()

static ilSoapFunctions::getUsersForContainer ( string  $sid,
int  $ref_id,
bool  $attach_roles,
int  $active 
)
static
Returns
ilObject|mixed|soap_fault|SoapFault|string|null

Definition at line 606 of file inc.soap_functions.php.

607 {
608 include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
609 $sua = new ilSoapUserAdministration();
610 return $sua->getUsersForContainer($sid, $ref_id, $attach_roles, $active);
611 }

References $ref_id.

◆ getUsersForRole()

static ilSoapFunctions::getUsersForRole ( string  $sid,
int  $role_id,
bool  $attach_roles,
int  $active 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 616 of file inc.soap_functions.php.

617 {
618 include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
619 $sua = new ilSoapUserAdministration();
620 return $sua->getUserForRole($sid, $role_id, $attach_roles, $active);
621 }

◆ getUserXML()

static ilSoapFunctions::getUserXML ( string  $sid,
array  $user_ids,
bool  $attach_roles 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 716 of file inc.soap_functions.php.

717 {
718 include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
719 $sua = new ilSoapUserAdministration();
720 return $sua->getUserXML($sid, $user_ids, $attach_roles);
721 }

◆ getXMLTree()

static ilSoapFunctions::getXMLTree ( string  $sid,
int  $ref_id,
array  $types,
?int  $user_id = null 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 266 of file inc.soap_functions.php.

267 {
268 include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
269 $soa = new ilSoapObjectAdministration();
270 return $soa->getXMLTree($sid, $ref_id, $types, $user_id);
271 }

References $ref_id.

◆ grantPermissions()

static ilSoapFunctions::grantPermissions ( string  $sid,
int  $ref_id,
int  $role_id,
array  $permissions 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 316 of file inc.soap_functions.php.

317 {
318 include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
319 $soa = new ilSoapRBACAdministration();
320 return $soa->grantPermissions($sid, $ref_id, $role_id, $permissions);
321 }

References $ref_id.

◆ groupExists()

static ilSoapFunctions::groupExists ( string  $sid,
string  $title 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 396 of file inc.soap_functions.php.

397 {
398 include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';
399 $soa = new ilSoapGroupAdministration();
400 return $soa->groupExists($sid, $title);
401 }

◆ hasNewMail()

static ilSoapFunctions::hasNewMail ( string  $sid)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 636 of file inc.soap_functions.php.

637 {
638 include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
639 $sua = new ilSoapUserAdministration();
640 return $sua->hasNewMail($sid);
641 }

◆ hasSCORMCertificate()

static ilSoapFunctions::hasSCORMCertificate ( string  $sid,
int  $ref_id,
int  $usr_id 
)
static

Definition at line 743 of file inc.soap_functions.php.

744 {
745 include_once './webservice/soap/classes/class.ilSoapSCORMAdministration.php';
746 $sua = new ilSoapSCORMAdministration();
747 return $sua->hasSCORMCertificate($sid, $ref_id, $usr_id);
748 }

References $ref_id.

◆ ilClone()

static ilSoapFunctions::ilClone ( string  $sid,
int  $copy_identifier 
)
static
Returns
bool|int|soap_fault|SoapFault|null

Definition at line 457 of file inc.soap_functions.php.

458 {
459 include_once './webservice/soap/classes/class.ilSoapUtils.php';
460
461 $sou = new ilSoapUtils();
462 $sou->disableSOAPCheck();
463 $sou->ignoreUserAbort();
464 return $sou->ilClone($sid, $copy_identifier);
465 }

Referenced by ilSoapUtils\callNextNode().

+ Here is the caller graph for this function:

◆ ilCloneDependencies()

static ilSoapFunctions::ilCloneDependencies ( string  $sid,
int  $copy_identifier 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 470 of file inc.soap_functions.php.

471 {
472 include_once './webservice/soap/classes/class.ilSoapUtils.php';
473
474 $sou = new ilSoapUtils();
475 $sou->disableSOAPCheck();
476 $sou->ignoreUserAbort();
477 return $sou->ilCloneDependencies($sid, $copy_identifier);
478 }

Referenced by ilSoapUtils\callNextDependency().

+ Here is the caller graph for this function:

◆ importOrgUnitsSimpleXML()

static ilSoapFunctions::importOrgUnitsSimpleXML (   $params)
static
Parameters
...$params
Returns
mixed

Definition at line 1008 of file inc.soap_functions.php.

1009 {
1010 $h = new ImportOrgUnitTree();
1011 return $h->execute($params);
1012 }

References $params.

◆ importUsers()

static ilSoapFunctions::importUsers ( string  $sid,
int  $folder_id,
string  $usr_xml,
int  $conflict_rule,
bool  $send_account_mail 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 596 of file inc.soap_functions.php.

597 {
598 include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
599 $sua = new ilSoapUserAdministration();
600 return $sua->importUsers($sid, $folder_id, $usr_xml, $conflict_rule, $send_account_mail);
601 }

◆ isAssignedToCourse()

static ilSoapFunctions::isAssignedToCourse ( string  $sid,
int  $course_id,
int  $user_id 
)
static
Returns
int|soap_fault|SoapFault|string|null

Definition at line 106 of file inc.soap_functions.php.

107 {
108 include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';
109 $sca = new ilSoapCourseAdministration();
110 return $sca->isAssignedToCourse($sid, $course_id, $user_id);
111 }

◆ isAssignedToGroup()

static ilSoapFunctions::isAssignedToGroup ( string  $sid,
int  $group_id,
int  $user_id 
)
static
Returns
int|soap_fault|SoapFault|null

Definition at line 426 of file inc.soap_functions.php.

427 {
428 include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';
429 $sca = new ilSoapGroupAdministration();
430 return $sca->isAssignedToGroup($sid, $group_id, $user_id);
431 }

◆ login()

static ilSoapFunctions::login ( string  $client,
string  $username,
string  $password 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 46 of file inc.soap_functions.php.

47 {
48 include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
49 $sua = new ilSoapUserAdministration();
50 return $sua->login($client, $username, $password);
51 }
$client
$client
Definition: dummy_client.php:43

References $client.

◆ logout()

static ilSoapFunctions::logout ( string  $sid)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 56 of file inc.soap_functions.php.

57 {
58 include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
59 $sua = new ilSoapUserAdministration();
60 return $sua->logout($sid);
61 }

◆ lookupUser()

static ilSoapFunctions::lookupUser ( string  $sid,
string  $user_name 
)
static
Returns
int|soap_fault|SoapFault|null

Definition at line 66 of file inc.soap_functions.php.

67 {
68 include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
69 $sua = new ilSoapUserAdministration();
70 return $sua->lookupUser($sid, $user_name);
71 }

◆ moveObject()

static ilSoapFunctions::moveObject ( string  $sid,
int  $ref_id,
int  $target_id 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 773 of file inc.soap_functions.php.

774 {
775 include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
776 $soa = new ilSoapObjectAdministration();
777 return $soa->moveObject($sid, $ref_id, $target_id);
778 }

References $ref_id, and $target_id.

◆ readWebLink()

static ilSoapFunctions::readWebLink ( string  $sid,
int  $ref_id 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 906 of file inc.soap_functions.php.

907 {
908 include_once './webservice/soap/classes/class.ilSoapWebLinkAdministration.php';
909 $swa = new ilSoapWebLinkAdministration();
910 return $swa->readWebLink($sid, $ref_id);
911 }

References $ref_id.

◆ removeFromSystemByImportId()

static ilSoapFunctions::removeFromSystemByImportId ( string  $sid,
string  $import_id 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 226 of file inc.soap_functions.php.

227 {
228 include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
229 $soa = new ilSoapObjectAdministration();
230 return $soa->removeFromSystemByImportId($sid, $import_id);
231 }

◆ removeTestResults()

static ilSoapFunctions::removeTestResults ( string  $sid,
int  $ref_id,
array  $a_user_ids 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 793 of file inc.soap_functions.php.

794 {
795 include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
796 $soa = new ilSoapTestAdministration();
797 return $soa->removeTestResults($sid, $ref_id, $a_user_ids);
798 }

References $ref_id.

◆ removeUserFromPositionInOrgUnit()

static ilSoapFunctions::removeUserFromPositionInOrgUnit (   $params)
static
Parameters
...$params
Returns
mixed

Definition at line 1048 of file inc.soap_functions.php.

1049 {
1050 $h = new RemoveUserIdFromPositionInOrgUnit();
1051 return $h->execute($params);
1052 }

References $params.

◆ revokePermissions()

static ilSoapFunctions::revokePermissions ( string  $sid,
int  $ref_id,
int  $role_id 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 306 of file inc.soap_functions.php.

307 {
308 include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
309 $soa = new ilSoapRBACAdministration();
310 return $soa->revokePermissions($sid, $ref_id, $role_id);
311 }

References $ref_id.

◆ saveQuestion()

static ilSoapFunctions::saveQuestion ( string  $sid,
int  $active_id,
int  $question_id,
int  $pass,
array  $solution 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 483 of file inc.soap_functions.php.

484 {
485 include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
486 $sass = new ilSoapTestAdministration();
487 return $sass->saveQuestion($sid, $active_id, $question_id, $pass, $solution);
488 }

◆ saveQuestionSolution()

static ilSoapFunctions::saveQuestionSolution ( string  $sid,
int  $active_id,
int  $question_id,
int  $pass,
int  $solution 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 493 of file inc.soap_functions.php.

494 {
495 include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
496 $sass = new ilSoapTestAdministration();
497 return $sass->saveQuestionSolution($sid, $active_id, $question_id, $pass, $solution);
498 }

◆ saveTempFileAsMediaObject()

static ilSoapFunctions::saveTempFileAsMediaObject ( string  $sid,
string  $name,
string  $tmp_name 
)
static
Returns
ilObjMediaObject|soap_fault|SoapFault|null

Definition at line 553 of file inc.soap_functions.php.

554 {
555 include_once './webservice/soap/classes/class.ilSoapUtils.php';
556
557 $sou = new ilSoapUtils();
558 $sou->disableSOAPCheck();
559 return $sou->saveTempFileAsMediaObject($sid, $name, $tmp_name);
560 }

References $name.

◆ searchObjects()

static ilSoapFunctions::searchObjects ( string  $sid,
array  $types,
string  $key,
string  $combination,
?int  $user_id = null 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 246 of file inc.soap_functions.php.

247 {
248 include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
249 $soa = new ilSoapObjectAdministration();
250 return $soa->searchObjects($sid, $types, $key, $combination, $user_id);
251 }
ILIAS\LTI\ToolProvider\$key
string $key
Consumer key/client ID value.
Definition: System.php:193

References ILIAS\LTI\ToolProvider\$key.

◆ searchRoles()

static ilSoapFunctions::searchRoles ( string  $sid,
string  $key,
string  $combination,
string  $role_type 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 833 of file inc.soap_functions.php.

834 {
835 include_once 'webservice/soap/classes/class.ilSoapRBACAdministration.php';
836 $roa = new ilSoapRBACAdministration();
837 return $roa->searchRoles($sid, $key, $combination, $role_type);
838 }

References ILIAS\LTI\ToolProvider\$key.

◆ searchUser()

static ilSoapFunctions::searchUser ( string  $sid,
array  $a_keyfields,
string  $query_operator,
array  $a_keyvalues,
bool  $attach_roles,
int  $active 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 626 of file inc.soap_functions.php.

627 {
628 include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
629 $sua = new ilSoapUserAdministration();
630 return $sua->searchUser($sid, $a_keyfields, $query_operator, $a_keyvalues, $attach_roles, $active);
631 }

◆ startBackgroundTaskWorker()

static ilSoapFunctions::startBackgroundTaskWorker ( string  $sid)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 763 of file inc.soap_functions.php.

764 {
765 require_once("./Services/BackgroundTasks/classes/class.ilSoapBackgroundTasksAdministration.php");
766 $soa = new ilSoapBackgroundTasksAdministration();
767 return $soa->runAsync($sid);
768 }

◆ updateCourse()

static ilSoapFunctions::updateCourse ( string  $sid,
int  $course_id,
string  $xml 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 136 of file inc.soap_functions.php.

137 {
138 include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';
139 $sca = new ilSoapCourseAdministration();
140 return $sca->updateCourse($sid, $course_id, $xml);
141 }

References $xml.

◆ updateExercise()

static ilSoapFunctions::updateExercise ( string  $sid,
int  $ref_id,
string  $xml 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 656 of file inc.soap_functions.php.

657 {
658 include_once './webservice/soap/classes/class.ilSoapExerciseAdministration.php';
659 $sta = new ilSoapExerciseAdministration();
660 return $sta->updateExercise($sid, $ref_id, $xml);
661 }

References $ref_id, and $xml.

◆ updateFile()

static ilSoapFunctions::updateFile ( string  $sid,
int  $ref_id,
string  $xml 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 686 of file inc.soap_functions.php.

687 {
688 include_once './webservice/soap/classes/class.ilSoapFileAdministration.php';
689 $sta = new ilSoapFileAdministration();
690 return $sta->updateFile($sid, $ref_id, $xml);
691 }

References $ref_id, and $xml.

◆ updateGroup()

static ilSoapFunctions::updateGroup ( string  $sid,
int  $ref_id,
string  $grp_xml 
)
static
Returns
soap_fault|SoapFault|string|null

Definition at line 726 of file inc.soap_functions.php.

727 {
728 include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';
729 $sua = new ilSoapGroupAdministration();
730 return $sua->updateGroup($sid, $ref_id, $grp_xml);
731 }

References $ref_id.

◆ updateObjects()

static ilSoapFunctions::updateObjects ( string  $sid,
string  $obj_xml 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 236 of file inc.soap_functions.php.

237 {
238 include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
239 $soa = new ilSoapObjectAdministration();
240 return $soa->updateObjects($sid, $obj_xml);
241 }

◆ updateWebLink()

static ilSoapFunctions::updateWebLink ( string  $sid,
int  $ref_id,
string  $xml 
)
static
Returns
bool|soap_fault|SoapFault|null

Definition at line 927 of file inc.soap_functions.php.

928 {
929 include_once './webservice/soap/classes/class.ilSoapWebLinkAdministration.php';
930 $swa = new ilSoapWebLinkAdministration();
931 return $swa->updateWebLink($sid, $ref_id, $xml);
932 }

References $ref_id, and $xml.

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