ILIAS  release_9 Revision v9.13-25-g2c18ec4c24f
inc.soap_functions.php
Go to the documentation of this file.
1 <?php
2 
29 
40 {
41  // These functions are wrappers for soap, since it cannot register methods inside classes
42 
46  public static function login(string $client, string $username, string $password)
47  {
48  include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
49  $sua = new ilSoapUserAdministration();
50  return $sua->login($client, $username, $password);
51  }
52 
56  public static function logout(string $sid)
57  {
58  include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
59  $sua = new ilSoapUserAdministration();
60  return $sua->logout($sid);
61  }
62 
66  public static function lookupUser(string $sid, string $user_name)
67  {
68  include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
69  $sua = new ilSoapUserAdministration();
70  return $sua->lookupUser($sid, $user_name);
71  }
72 
76  public static function addCourse(string $sid, int $target_id, string $crs_xml)
77  {
78  include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';
79  $sca = new ilSoapCourseAdministration();
80  return $sca->addCourse($sid, $target_id, $crs_xml);
81  }
82 
86  public static function deleteCourse(string $sid, int $course_id)
87  {
88  include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';
89  $sca = new ilSoapCourseAdministration();
90  return $sca->deleteCourse($sid, $course_id);
91  }
92 
96  public static function assignCourseMember(string $sid, int $course_id, int $user_id, string $type)
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  }
102 
106  public static function isAssignedToCourse(string $sid, int $course_id, int $user_id)
107  {
108  include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';
109  $sca = new ilSoapCourseAdministration();
110  return $sca->isAssignedToCourse($sid, $course_id, $user_id);
111  }
112 
116  public static function excludeCourseMember(string $sid, int $course_id, int $user_id)
117  {
118  include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';
119  $sca = new ilSoapCourseAdministration();
120  return $sca->excludeCourseMember($sid, $course_id, $user_id);
121  }
122 
126  public static function getCourseXML(string $sid, int $course_id)
127  {
128  include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';
129  $sca = new ilSoapCourseAdministration();
130  return $sca->getCourseXML($sid, $course_id);
131  }
132 
136  public static function updateCourse(string $sid, int $course_id, string $xml)
137  {
138  include_once './webservice/soap/classes/class.ilSoapCourseAdministration.php';
139  $sca = new ilSoapCourseAdministration();
140  return $sca->updateCourse($sid, $course_id, $xml);
141  }
142 
146  public static function getObjIdByImportId(string $sid, string $import_id)
147  {
148  include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
149  $soa = new ilSoapObjectAdministration();
150  return $soa->getObjIdByImportId($sid, $import_id);
151  }
152 
156  public static function getRefIdsByImportId(string $sid, string $import_id)
157  {
158  include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
159  $soa = new ilSoapObjectAdministration();
160  return $soa->getRefIdsByImportId($sid, $import_id);
161  }
162 
166  public static function getRefIdsByObjId(string $sid, int $object_id)
167  {
168  include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
169  $soa = new ilSoapObjectAdministration();
170  return $soa->getRefIdsByObjId($sid, $object_id);
171  }
172 
176  public static function getObjectByReference(string $sid, int $a_ref_id, ?int $user_id = null)
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  }
182 
186  public static function getObjectsByTitle(string $sid, string $a_title, ?int $user_id = null)
187  {
188  include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
189  $soa = new ilSoapObjectAdministration();
190  return $soa->getObjectsByTitle($sid, $a_title, $user_id);
191  }
192 
196  public static function addObject(string $sid, int $a_target_id, string $a_xml)
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  }
202 
206  public static function addReference(string $sid, int $a_source_id, int $a_target_id)
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  }
212 
216  public static function deleteObject(string $sid, int $reference_id)
217  {
218  include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
219  $soa = new ilSoapObjectAdministration();
220  return $soa->deleteObject($sid, $reference_id);
221  }
222 
226  public static function removeFromSystemByImportId(string $sid, string $import_id)
227  {
228  include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
229  $soa = new ilSoapObjectAdministration();
230  return $soa->removeFromSystemByImportId($sid, $import_id);
231  }
232 
236  public static function updateObjects(string $sid, string $obj_xml)
237  {
238  include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
239  $soa = new ilSoapObjectAdministration();
240  return $soa->updateObjects($sid, $obj_xml);
241  }
242 
246  public static function searchObjects(string $sid, array $types, string $key, string $combination, ?int $user_id = null)
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  }
252 
256  public static function getTreeChilds(string $sid, int $ref_id, ?array $types = null, ?int $user_id = null)
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  }
262 
266  public static function getXMLTree(string $sid, int $ref_id, ?array $types = null, ?int $user_id = null)
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  }
272 
276  public static function getOperations(string $sid)
277  {
278  include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
279  $soa = new ilSoapRBACAdministration();
280  return $soa->getOperations($sid);
281  }
282 
286  public static function addUserRoleEntry(string $sid, int $user_id, int $role_id)
287  {
288  include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
289  $soa = new ilSoapRBACAdministration();
290  return $soa->addUserRoleEntry($sid, $user_id, $role_id);
291  }
292 
296  public static function deleteUserRoleEntry(string $sid, int $user_id, int $role_id)
297  {
298  include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
299  $soa = new ilSoapRBACAdministration();
300  return $soa->deleteUserRoleEntry($sid, $user_id, $role_id);
301  }
302 
306  public static function revokePermissions(string $sid, int $ref_id, int $role_id)
307  {
308  include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
309  $soa = new ilSoapRBACAdministration();
310  return $soa->revokePermissions($sid, $ref_id, $role_id);
311  }
312 
316  public static function grantPermissions(string $sid, int $ref_id, int $role_id, array $permissions)
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  }
322 
326  public static function getLocalRoles(string $sid, int $ref_id)
327  {
328  include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
329  $soa = new ilSoapRBACAdministration();
330  return $soa->getLocalRoles($sid, $ref_id);
331  }
332 
336  public static function getUserRoles(string $sid, int $user_id)
337  {
338  include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
339  $soa = new ilSoapRBACAdministration();
340  return $soa->getUserRoles($sid, $user_id);
341  }
342 
346  public static function deleteRole(string $sid, int $role_id)
347  {
348  include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
349  $soa = new ilSoapRBACAdministration();
350  return $soa->deleteRole($sid, $role_id);
351  }
352 
356  public static function addRole(string $sid, int $target_id, string $obj_xml)
357  {
358  include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
359  $soa = new ilSoapRBACAdministration();
360  return $soa->addRole($sid, $target_id, $obj_xml);
361  }
362 
366  public static function addRoleFromTemplate(string $sid, int $target_id, string $obj_xml, int $template_id)
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  }
372 
376  public static function getObjectTreeOperations(string $sid, int $ref_id, int $user_id)
377  {
378  include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
379  $soa = new ilSoapRBACAdministration();
380  return $soa->getObjectTreeOperations($sid, $ref_id, $user_id);
381  }
382 
386  public static function addGroup(string $sid, int $target_id, string $group_xml)
387  {
388  include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';
389  $soa = new ilSoapGroupAdministration();
390  return $soa->addGroup($sid, $target_id, $group_xml);
391  }
392 
396  public static function groupExists(string $sid, string $title)
397  {
398  include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';
399  $soa = new ilSoapGroupAdministration();
400  return $soa->groupExists($sid, $title);
401  }
402 
406  public static function getGroup(string $sid, int $ref_id)
407  {
408  include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';
409  $soa = new ilSoapGroupAdministration();
410  return $soa->getGroup($sid, $ref_id);
411  }
412 
416  public static function assignGroupMember(string $sid, int $group_id, int $user_id, string $type)
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  }
422 
426  public static function isAssignedToGroup(string $sid, int $group_id, int $user_id)
427  {
428  include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';
429  $sca = new ilSoapGroupAdministration();
430  return $sca->isAssignedToGroup($sid, $group_id, $user_id);
431  }
432 
436  public static function excludeGroupMember(string $sid, int $group_id, int $user_id)
437  {
438  include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';
439  $sca = new ilSoapGroupAdministration();
440  return $sca->excludeGroupMember($sid, $group_id, $user_id);
441  }
442 
446  public static function ilClone(string $sid, int $copy_identifier)
447  {
448  include_once './webservice/soap/classes/class.ilSoapUtils.php';
449 
450  $sou = new ilSoapUtils();
451  $sou->disableSOAPCheck();
452  $sou->ignoreUserAbort();
453  return $sou->ilClone($sid, $copy_identifier);
454  }
455 
459  public static function ilCloneDependencies(string $sid, int $copy_identifier)
460  {
461  include_once './webservice/soap/classes/class.ilSoapUtils.php';
462 
463  $sou = new ilSoapUtils();
464  $sou->disableSOAPCheck();
465  $sou->ignoreUserAbort();
466  return $sou->ilCloneDependencies($sid, $copy_identifier);
467  }
468 
472  public static function saveQuestion(string $sid, int $active_id, int $question_id, int $pass, array $solution)
473  {
474  include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
475  $sass = new ilSoapTestAdministration();
476  return $sass->saveQuestion($sid, $active_id, $question_id, $pass, $solution);
477  }
478 
482  public static function saveQuestionSolution(string $sid, int $active_id, int $question_id, int $pass, int $solution)
483  {
484  include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
485  $sass = new ilSoapTestAdministration();
486  return $sass->saveQuestionSolution($sid, $active_id, $question_id, $pass, $solution);
487  }
488 
492  public static function getQuestionSolution(string $sid, int $active_id, int $question_id, int $pass)
493  {
494  include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
495  $sass = new ilSoapTestAdministration();
496  return $sass->getQuestionSolution($sid, $active_id, $question_id, $pass);
497  }
498 
502  public static function getTestUserData(string $sid, int $active_id)
503  {
504  include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
505  $sass = new ilSoapTestAdministration();
506  return $sass->getTestUserData($sid, $active_id);
507  }
508 
512  public static function getNrOfQuestionsInPass(string $sid, int $active_id, int $pass)
513  {
514  include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
515  $sass = new ilSoapTestAdministration();
516  return $sass->getNrOfQuestionsInPass($sid, $active_id, $pass);
517  }
518 
522  public static function getPositionOfQuestion(string $sid, int $active_id, int $question_id, int $pass)
523  {
524  include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
525  $sass = new ilSoapTestAdministration();
526  return $sass->getPositionOfQuestion($sid, $active_id, $question_id, $pass);
527  }
528 
532  public static function getPreviousReachedPoints(string $sid, int $active_id, int $question_id, int $pass)
533  {
534  include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
535  $sass = new ilSoapTestAdministration();
536  return $sass->getPreviousReachedPoints($sid, $active_id, $question_id, $pass);
537  }
538 
542  public static function saveTempFileAsMediaObject(string $sid, string $name, string $tmp_name)
543  {
544  include_once './webservice/soap/classes/class.ilSoapUtils.php';
545 
546  $sou = new ilSoapUtils();
547  $sou->disableSOAPCheck();
548  return $sou->saveTempFileAsMediaObject($sid, $name, $tmp_name);
549  }
550 
554  public static function getMobsOfObject(string $sid, string $a_type, int $a_id)
555  {
556  include_once './webservice/soap/classes/class.ilSoapUtils.php';
557  $sou = new ilSoapUtils();
558  $sou->disableSOAPCheck();
559  return $sou->getMobsOfObject($sid, $a_type, $a_id);
560  }
561 
565  public static function getStructureObjects(string $sid, int $ref_id)
566  {
567  include_once './webservice/soap/classes/class.ilSoapStructureObjectAdministration.php';
569  return $sca->getStructureObjects($sid, $ref_id);
570  }
571 
575  public static function getRoles(string $sid, string $role_type, int $id)
576  {
577  include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
578  $soa = new ilSoapRBACAdministration();
579  return $soa->getRoles($sid, $role_type, $id);
580  }
581 
585  public static function importUsers(string $sid, int $folder_id, string $usr_xml, int $conflict_rule, bool $send_account_mail)
586  {
587  include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
588  $sua = new ilSoapUserAdministration();
589  return $sua->importUsers($sid, $folder_id, $usr_xml, $conflict_rule, $send_account_mail);
590  }
591 
595  public static function getUsersForContainer(string $sid, int $ref_id, bool $attach_roles, int $active)
596  {
597  include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
598  $sua = new ilSoapUserAdministration();
599  return $sua->getUsersForContainer($sid, $ref_id, $attach_roles, $active);
600  }
601 
605  public static function getUsersForRole(string $sid, int $role_id, bool $attach_roles, int $active)
606  {
607  include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
608  $sua = new ilSoapUserAdministration();
609  return $sua->getUserForRole($sid, $role_id, $attach_roles, $active);
610  }
611 
615  public static function searchUser(string $sid, array $a_keyfields, string $query_operator, array $a_keyvalues, bool $attach_roles, int $active)
616  {
617  include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
618  $sua = new ilSoapUserAdministration();
619  return $sua->searchUser($sid, $a_keyfields, $query_operator, $a_keyvalues, $attach_roles, $active);
620  }
621 
625  public static function hasNewMail(string $sid)
626  {
627  include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
628  $sua = new ilSoapUserAdministration();
629  return $sua->hasNewMail($sid);
630  }
631 
635  public static function getExerciseXML(string $sid, int $ref_id, int $attachFileContentsMode)
636  {
637  include_once './webservice/soap/classes/class.ilSoapExerciseAdministration.php';
638  $sta = new ilSoapExerciseAdministration();
639  return $sta->getExerciseXML($sid, $ref_id, $attachFileContentsMode);
640  }
641 
645  public static function updateExercise(string $sid, int $ref_id, string $xml)
646  {
647  include_once './webservice/soap/classes/class.ilSoapExerciseAdministration.php';
648  $sta = new ilSoapExerciseAdministration();
649  return $sta->updateExercise($sid, $ref_id, $xml);
650  }
651 
655  public static function addExercise(string $sid, int $ref_id, string $xml)
656  {
657  include_once './webservice/soap/classes/class.ilSoapExerciseAdministration.php';
658  $sta = new ilSoapExerciseAdministration();
659  return $sta->addExercise($sid, $ref_id, $xml);
660  }
661 
665  public static function getFileXML(string $sid, int $ref_id, int $attachFileContentsMode)
666  {
667  include_once './webservice/soap/classes/class.ilSoapFileAdministration.php';
668  $sta = new ilSoapFileAdministration();
669  return $sta->getFileXML($sid, $ref_id, $attachFileContentsMode);
670  }
671 
675  public static function updateFile(string $sid, int $ref_id, string $xml)
676  {
677  include_once './webservice/soap/classes/class.ilSoapFileAdministration.php';
678  $sta = new ilSoapFileAdministration();
679  return $sta->updateFile($sid, $ref_id, $xml);
680  }
681 
685  public static function addFile(string $sid, int $ref_id, string $xml)
686  {
687  include_once './webservice/soap/classes/class.ilSoapFileAdministration.php';
688  $sta = new ilSoapFileAdministration();
689  return $sta->addFile($sid, $ref_id, $xml);
690  }
691 
695  public static function getObjIdsByRefIds(string $sid, array $ref_ids)
696  {
697  include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
698  $soa = new ilSoapObjectAdministration();
699  return $soa->getObjIdsByRefIds($sid, $ref_ids);
700  }
701 
705  public static function getUserXML(string $sid, array $user_ids, bool $attach_roles)
706  {
707  include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
708  $sua = new ilSoapUserAdministration();
709  return $sua->getUserXML($sid, $user_ids, $attach_roles);
710  }
711 
715  public static function updateGroup(string $sid, int $ref_id, string $grp_xml)
716  {
717  include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';
718  $sua = new ilSoapGroupAdministration();
719  return $sua->updateGroup($sid, $ref_id, $grp_xml);
720  }
721 
725  public static function getIMSManifestXML(string $sid, int $ref_id)
726  {
727  include_once './webservice/soap/classes/class.ilSoapSCORMAdministration.php';
728  $sua = new ilSoapSCORMAdministration();
729  return $sua->getIMSManifestXML($sid, $ref_id);
730  }
731 
732  public static function hasSCORMCertificate(string $sid, int $ref_id, int $usr_id)
733  {
734  include_once './webservice/soap/classes/class.ilSoapSCORMAdministration.php';
735  $sua = new ilSoapSCORMAdministration();
736  return $sua->hasSCORMCertificate($sid, $ref_id, $usr_id);
737  }
738 
742  public static function copyObject(string $sid, string $copy_settings_xml)
743  {
744  include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
745  $soa = new ilSoapObjectAdministration();
746  return $soa->copyObject($sid, $copy_settings_xml);
747  }
748 
752  public static function startBackgroundTaskWorker(string $sid)
753  {
754  require_once("./Services/BackgroundTasks/classes/class.ilSoapBackgroundTasksAdministration.php");
756  return $soa->runAsync($sid);
757  }
758 
762  public static function moveObject(string $sid, int $ref_id, int $target_id)
763  {
764  include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
765  $soa = new ilSoapObjectAdministration();
766  return $soa->moveObject($sid, $ref_id, $target_id);
767  }
768 
772  public static function getTestResults(string $sid, int $ref_id, bool $sum_only)
773  {
774  include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
775  $soa = new ilSoapTestAdministration();
776  return $soa->getTestResults($sid, $ref_id, $sum_only);
777  }
778 
782  public static function removeTestResults(string $sid, int $ref_id, array $a_user_ids)
783  {
784  include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
785  $soa = new ilSoapTestAdministration();
786  return $soa->removeTestResults($sid, $ref_id, $a_user_ids);
787  }
788 
792  public static function getCoursesForUser(string $sid, string $parameters)
793  {
794  include_once 'webservice/soap/classes/class.ilSoapCourseAdministration.php';
795  $soc = new ilSoapCourseAdministration();
796  return $soc->getCoursesForUser($sid, $parameters);
797  }
798 
802  public static function getGroupsForUser(string $sid, string $parameters)
803  {
804  include_once 'webservice/soap/classes/class.ilSoapGroupAdministration.php';
805  $soc = new ilSoapGroupAdministration();
806  return $soc->getGroupsForUser($sid, $parameters);
807  }
808 
812  public static function getPathForRefId(string $sid, int $ref_id)
813  {
814  include_once 'webservice/soap/classes/class.ilSoapObjectAdministration.php';
815  $soa = new ilSoapObjectAdministration();
816  return $soa->getPathForRefId($sid, $ref_id);
817  }
818 
822  public static function searchRoles(string $sid, string $key, string $combination, string $role_type)
823  {
824  include_once 'webservice/soap/classes/class.ilSoapRBACAdministration.php';
825  $roa = new ilSoapRBACAdministration();
826  return $roa->searchRoles($sid, $key, $combination, $role_type);
827  }
828 
829  public static function getInstallationInfoXML(): string
830  {
831  include_once 'webservice/soap/classes/class.ilSoapAdministration.php';
832  $roa = new ilSoapAdministration();
833  return $roa->getInstallationInfoXML();
834  }
835 
839  public static function getClientInfoXML(string $clientid)
840  {
841  include_once 'webservice/soap/classes/class.ilSoapAdministration.php';
842  $roa = new ilSoapAdministration();
843  return $roa->getClientInfoXML($clientid);
844  }
845 
849  public static function buildHTTPPath(): string
850  {
851  if (($_SERVER["HTTPS"] ?? '') === "on") {
852  $protocol = 'https://';
853  } else {
854  $protocol = 'http://';
855  }
856  $host = $_SERVER['HTTP_HOST'] ?? '';
857 
858  $path = dirname($_SERVER['REQUEST_URI'] ?? '');
859 
860  //dirname cuts the last directory from a directory path e.g content/classes return content
861  include_once 'Services/FileServices/classes/class.ilFileUtils.php';
863 
864  $dirs = explode('/', $module);
865  $uri = $path;
866  foreach ($dirs as $dir) {
867  $uri = dirname($uri);
868  }
869  return ilFileUtils::removeTrailingPathSeparators($protocol . $host . $uri);
870  }
871 
875  public static function getSCORMCompletionStatus(string $sid, int $usr_id, int $a_ref_id)
876  {
877  include_once './webservice/soap/classes/class.ilSoapSCORMAdministration.php';
878  $sua = new ilSoapSCORMAdministration();
879  return $sua->getSCORMCompletionStatus($sid, $usr_id, $a_ref_id);
880  }
881 
885  public static function getUserIdBySid(string $sid)
886  {
887  include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
888  $sua = new ilSoapUserAdministration();
889  return $sua->getUserIdBySid($sid);
890  }
891 
895  public static function readWebLink(string $sid, int $ref_id)
896  {
897  include_once './webservice/soap/classes/class.ilSoapWebLinkAdministration.php';
898  $swa = new ilSoapWebLinkAdministration();
899  return $swa->readWebLink($sid, $ref_id);
900  }
901 
905  public static function createWebLink(string $sid, int $ref_id, string $xml)
906  {
907  include_once './webservice/soap/classes/class.ilSoapWebLinkAdministration.php';
908 
909  $swa = new ilSoapWebLinkAdministration();
910  return $swa->createWebLink($sid, $ref_id, $xml);
911  }
912 
916  public static function updateWebLink(string $sid, int $ref_id, string $xml)
917  {
918  include_once './webservice/soap/classes/class.ilSoapWebLinkAdministration.php';
919  $swa = new ilSoapWebLinkAdministration();
920  return $swa->updateWebLink($sid, $ref_id, $xml);
921  }
922 
923  public static function deleteExpiredDualOptInUserObjects(string $sid, int $usr_id): bool
924  {
925  include_once './webservice/soap/classes/class.ilSoapUtils.php';
926 
927  $sou = new ilSoapUtils();
928  $sou->disableSOAPCheck();
929  $sou->ignoreUserAbort();
930  return $sou->deleteExpiredDualOptInUserObjects($sid, $usr_id);
931  }
932 
936  public static function deleteProgress(string $sid, array $ref_ids, array $usr_ids, array $type_filter, array $progress_filter)
937  {
938  include_once './webservice/soap/classes/class.ilSoapLearningProgressAdministration.php';
940  return $sla->deleteProgress($sid, $ref_ids, $usr_ids, $type_filter, $progress_filter);
941  }
942 
946  public static function getLearningProgressChanges(string $sid, string $timestamp, bool $include_ref_ids, array $type_filter)
947  {
948  include_once './webservice/soap/classes/class.ilSoapLearningProgressAdministration.php';
950  return $s->getLearningProgressChanges($sid, $timestamp, $include_ref_ids, $type_filter);
951  }
952 
956  public static function getProgressInfo(string $sid, int $ref_id, array $progress_filter)
957  {
958  include_once './webservice/soap/classes/class.ilSoapLearningProgressAdministration.php';
960  return $sla->getProgressInfo($sid, $ref_id, $progress_filter);
961  }
962 
966  public static function exportDataCollectionContent(string $sid, int $data_collection_id, ?int $table_id = null, string $format = "xls", ?string $filepath = null)
967  {
968  include_once './webservice/soap/classes/class.ilSoapDataCollectionAdministration.php';
970  return $dcl->exportDataCollectionContent($sid, $data_collection_id, $table_id, $format, $filepath);
971  }
972 
977  public static function addUserToPositionInOrgUnit(...$params)
978  {
979  $h = new AddUserIdToPositionInOrgUnit();
980  return $h->execute($params);
981  }
982 
987  public static function getEmployeePositionId(...$params)
988  {
989  $h = new EmployeePositionId();
990  return $h->execute($params);
991  }
992 
997  public static function importOrgUnitsSimpleXML(...$params)
998  {
999  $h = new ImportOrgUnitTree();
1000  return $h->execute($params);
1001  }
1002 
1007  public static function getOrgUnitsSimpleXML(...$params)
1008  {
1009  $h = new OrgUnitTree();
1010  return $h->execute($params);
1011  }
1012 
1017  public static function getPositionIds(...$params)
1018  {
1019  $h = new PositionIds();
1020  return $h->execute($params);
1021  }
1022 
1027  public static function getPositionTitle(...$params)
1028  {
1029  $h = new PositionTitle();
1030  return $h->execute($params);
1031  }
1032 
1037  public static function removeUserFromPositionInOrgUnit(...$params)
1038  {
1040  return $h->execute($params);
1041  }
1042 
1047  public static function getSuperiorPositionId(...$params)
1048  {
1049  $h = new SuperiorPositionId();
1050  return $h->execute($params);
1051  }
1052 
1057  public static function getUserIdsOfPosition(...$params)
1058  {
1059  $h = new UserIdsOfPosition();
1060  return $h->execute($params);
1061  }
1062 
1068  {
1069  $h = new UserIdsOfPositionAndOrgUnit();
1070  return $h->execute($params);
1071  }
1072 
1079  public function __call($name, $arguments)
1080  {
1081  // SoapHookPlugins need the client-ID submitted
1082  // no initialized ILIAS => no request wrapper available.
1083  if (!isset($_GET['client_id'])) {
1084  throw new SoapFault('SOAP-ENV:Server', "Function '$name' does not exist");
1085  }
1086  // Note: We need to bootstrap ILIAS in order to get $ilPluginAdmin and load the soap plugins.
1087  // We MUST use a context that does not handle authentication at this point (session is checked by SOAP).
1089  require_once 'Services/Init/classes/class.ilInitialisation.php';
1092  global $DIC;
1093  $soapHook = new ilSoapHook($DIC['component.factory']);
1094  // Method name may be invoked with namespace e.g. 'myMethod' vs 'ns:myMethod'
1095  if (strpos($name, ':') !== false) {
1096  [$_, $name] = explode(':', $name);
1097  }
1098  $method = $soapHook->getMethodByName($name);
1099  if ($method) {
1100  try {
1101  return $method->execute($arguments);
1102  } catch (ilSoapPluginException $e) {
1103  throw new SoapFault('SOAP-ENV:Server', $e->getMessage());
1104  }
1105  }
1106  throw new SoapFault('SOAP-ENV:Server', "Function '$name' does not exist");
1107  }
1108 }
static getLocalRoles(string $sid, int $ref_id)
static getExerciseXML(string $sid, int $ref_id, int $attachFileContentsMode)
static getGroupsForUser(string $sid, string $parameters)
static saveTempFileAsMediaObject(string $sid, string $name, string $tmp_name)
static deleteCourse(string $sid, int $course_id)
static searchRoles(string $sid, string $key, string $combination, string $role_type)
static addObject(string $sid, int $a_target_id, string $a_xml)
static searchUser(string $sid, array $a_keyfields, string $query_operator, array $a_keyvalues, bool $attach_roles, int $active)
static getPathForRefId(string $sid, int $ref_id)
$_GET["client_id"]
Definition: webdav.php:30
static getIMSManifestXML(string $sid, int $ref_id)
static getUserIdsOfPosition(... $params)
static getFileXML(string $sid, int $ref_id, int $attachFileContentsMode)
static hasSCORMCertificate(string $sid, int $ref_id, int $usr_id)
static assignCourseMember(string $sid, int $course_id, int $user_id, string $type)
static getUserRoles(string $sid, int $user_id)
static getObjIdsByRefIds(string $sid, array $ref_ids)
Soap data-collection administration methods.
static getClientInfoXML(string $clientid)
static getInstallationInfoXML()
This class handles all DB changes necessary for fraunhofer.
static exportDataCollectionContent(string $sid, int $data_collection_id, ?int $table_id=null, string $format="xls", ?string $filepath=null)
static getOperations(string $sid)
static ilClone(string $sid, int $copy_identifier)
static grantPermissions(string $sid, int $ref_id, int $role_id, array $permissions)
if(! $DIC->user() ->getId()||!ilLTIConsumerAccess::hasCustomProviderCreationAccess()) $params
Definition: ltiregstart.php:33
static updateExercise(string $sid, int $ref_id, string $xml)
static getNrOfQuestionsInPass(string $sid, int $active_id, int $pass)
static getSuperiorPositionId(... $params)
static getTreeChilds(string $sid, int $ref_id, ?array $types=null, ?int $user_id=null)
static startBackgroundTaskWorker(string $sid)
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
static addReference(string $sid, int $a_source_id, int $a_target_id)
static hasNewMail(string $sid)
static revokePermissions(string $sid, int $ref_id, int $role_id)
static getEmployeePositionId(... $params)
static getCourseXML(string $sid, int $course_id)
const CONTEXT_SOAP_NO_AUTH
static addRole(string $sid, int $target_id, string $obj_xml)
static lookupUser(string $sid, string $user_name)
static assignGroupMember(string $sid, int $group_id, int $user_id, string $type)
static getUserIdBySid(string $sid)
static getRoles(string $sid, string $role_type, int $id)
static getObjectByReference(string $sid, int $a_ref_id, ?int $user_id=null)
static getCoursesForUser(string $sid, string $parameters)
static excludeGroupMember(string $sid, int $group_id, int $user_id)
static removeFromSystemByImportId(string $sid, string $import_id)
static getPositionIds(... $params)
static removeTestResults(string $sid, int $ref_id, array $a_user_ids)
static isAssignedToCourse(string $sid, int $course_id, int $user_id)
$path
Definition: ltiservices.php:32
static removeTrailingPathSeparators(string $path)
static getOrgUnitsSimpleXML(... $params)
global $DIC
Definition: feed.php:28
static updateCourse(string $sid, int $course_id, string $xml)
$client
static getUserXML(string $sid, array $user_ids, bool $attach_roles)
Soap file administration methods.
static initILIAS()
ilias initialisation
static getLearningProgressChanges(string $sid, string $timestamp, bool $include_ref_ids, array $type_filter)
static removeUserFromPositionInOrgUnit(... $params)
$ref_id
Definition: ltiauth.php:67
static getObjIdByImportId(string $sid, string $import_id)
static addFile(string $sid, int $ref_id, string $xml)
static excludeCourseMember(string $sid, int $course_id, int $user_id)
static ilCloneDependencies(string $sid, int $copy_identifier)
static deleteUserRoleEntry(string $sid, int $user_id, int $role_id)
static getPositionTitle(... $params)
static updateFile(string $sid, int $ref_id, string $xml)
static logout(string $sid)
Soap exercise administration methods.
Soap methods for adminstrating web links.
static getQuestionSolution(string $sid, int $active_id, int $question_id, int $pass)
Class ilSoapHook.
$_SERVER['HTTP_HOST']
Definition: raiseError.php:10
static getTestUserData(string $sid, int $active_id)
static getObjectsByTitle(string $sid, string $a_title, ?int $user_id=null)
static deleteProgress(string $sid, array $ref_ids, array $usr_ids, array $type_filter, array $progress_filter)
static saveQuestionSolution(string $sid, int $active_id, int $question_id, int $pass, int $solution)
string $key
Consumer key/client ID value.
Definition: System.php:193
static getObjectTreeOperations(string $sid, int $ref_id, int $user_id)
static getPreviousReachedPoints(string $sid, int $active_id, int $question_id, int $pass)
static getSCORMCompletionStatus(string $sid, int $usr_id, int $a_ref_id)
static addRoleFromTemplate(string $sid, int $target_id, string $obj_xml, int $template_id)
static createWebLink(string $sid, int $ref_id, string $xml)
static getUsersForContainer(string $sid, int $ref_id, bool $attach_roles, int $active)
static getPositionOfQuestion(string $sid, int $active_id, int $question_id, int $pass)
static addExercise(string $sid, int $ref_id, string $xml)
static saveQuestion(string $sid, int $active_id, int $question_id, int $pass, array $solution)
Soap rbac administration methods.
foreach($mandatory_scripts as $file) $timestamp
Definition: buildRTE.php:70
static isAssignedToGroup(string $sid, int $group_id, int $user_id)
static getStructureObjects(string $sid, int $ref_id)
static deleteObject(string $sid, int $reference_id)
static getGroup(string $sid, int $ref_id)
__call($name, $arguments)
static init(string $a_type)
Init context by type.
static updateGroup(string $sid, int $ref_id, string $grp_xml)
static addCourse(string $sid, int $target_id, string $crs_xml)
static getRefIdsByImportId(string $sid, string $import_id)
$id
plugin.php for ilComponentBuildPluginInfoObjectiveTest::testAddPlugins
Definition: plugin.php:23
static addUserRoleEntry(string $sid, int $user_id, int $role_id)
static getProgressInfo(string $sid, int $ref_id, array $progress_filter)
static getXMLTree(string $sid, int $ref_id, ?array $types=null, ?int $user_id=null)
static deleteExpiredDualOptInUserObjects(string $sid, int $usr_id)
const ILIAS_MODULE
Definition: server.php:15
static updateObjects(string $sid, string $obj_xml)
static getRefIdsByObjId(string $sid, int $object_id)
static moveObject(string $sid, int $ref_id, int $target_id)
static importOrgUnitsSimpleXML(... $params)
static login(string $client, string $username, string $password)
static groupExists(string $sid, string $title)
const CONTEXT_SOAP
static deleteRole(string $sid, int $role_id)
static getMobsOfObject(string $sid, string $a_type, int $a_id)
static updateWebLink(string $sid, int $ref_id, string $xml)
static addGroup(string $sid, int $target_id, string $group_xml)
static importUsers(string $sid, int $folder_id, string $usr_xml, int $conflict_rule, bool $send_account_mail)
static getTestResults(string $sid, int $ref_id, bool $sum_only)
getUserIdsOfPositionAndOrgUnit(... $params)
static copyObject(string $sid, string $copy_settings_xml)
static readWebLink(string $sid, int $ref_id)
static searchObjects(string $sid, array $types, string $key, string $combination, ?int $user_id=null)
static getUsersForRole(string $sid, int $role_id, bool $attach_roles, int $active)
static addUserToPositionInOrgUnit(... $params)