ILIAS  release_8 Revision v8.24
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, int $user_id)
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, ?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
447 public static function distributeMails(string $sid, string $mail_xml)
448 {
449 include_once './webservice/soap/classes/class.ilSoapUtils.php';
450 $sou = new ilSoapUtils();
451 return $sou->distributeMails($sid, $mail_xml);
452 }
453
457 public static function ilClone(string $sid, int $copy_identifier)
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 }
466
470 public static function ilCloneDependencies(string $sid, int $copy_identifier)
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 }
479
483 public static function saveQuestion(string $sid, int $active_id, int $question_id, int $pass, array $solution)
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 }
489
493 public static function saveQuestionSolution(string $sid, int $active_id, int $question_id, int $pass, int $solution)
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 }
499
503 public static function getQuestionSolution(string $sid, int $active_id, int $question_id, int $pass)
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 }
509
513 public static function getTestUserData(string $sid, int $active_id)
514 {
515 include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
516 $sass = new ilSoapTestAdministration();
517 return $sass->getTestUserData($sid, $active_id);
518 }
519
523 public static function getNrOfQuestionsInPass(string $sid, int $active_id, int $pass)
524 {
525 include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
526 $sass = new ilSoapTestAdministration();
527 return $sass->getNrOfQuestionsInPass($sid, $active_id, $pass);
528 }
529
533 public static function getPositionOfQuestion(string $sid, int $active_id, int $question_id, int $pass)
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 }
539
543 public static function getPreviousReachedPoints(string $sid, int $active_id, int $question_id, int $pass)
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 }
549
553 public static function saveTempFileAsMediaObject(string $sid, string $name, string $tmp_name)
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 }
561
565 public static function getMobsOfObject(string $sid, string $a_type, int $a_id)
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 }
572
576 public static function getStructureObjects(string $sid, int $ref_id)
577 {
578 include_once './webservice/soap/classes/class.ilSoapStructureObjectAdministration.php';
580 return $sca->getStructureObjects($sid, $ref_id);
581 }
582
586 public static function getRoles(string $sid, string $role_type, int $id)
587 {
588 include_once './webservice/soap/classes/class.ilSoapRBACAdministration.php';
589 $soa = new ilSoapRBACAdministration();
590 return $soa->getRoles($sid, $role_type, $id);
591 }
592
596 public static function importUsers(string $sid, int $folder_id, string $usr_xml, int $conflict_rule, bool $send_account_mail)
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 }
602
606 public static function getUsersForContainer(string $sid, int $ref_id, bool $attach_roles, int $active)
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 }
612
616 public static function getUsersForRole(string $sid, int $role_id, bool $attach_roles, int $active)
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 }
622
626 public static function searchUser(string $sid, array $a_keyfields, string $query_operator, array $a_keyvalues, bool $attach_roles, int $active)
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 }
632
636 public static function hasNewMail(string $sid)
637 {
638 include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
639 $sua = new ilSoapUserAdministration();
640 return $sua->hasNewMail($sid);
641 }
642
646 public static function getExerciseXML(string $sid, int $ref_id, int $attachFileContentsMode)
647 {
648 include_once './webservice/soap/classes/class.ilSoapExerciseAdministration.php';
649 $sta = new ilSoapExerciseAdministration();
650 return $sta->getExerciseXML($sid, $ref_id, $attachFileContentsMode);
651 }
652
656 public static function updateExercise(string $sid, int $ref_id, string $xml)
657 {
658 include_once './webservice/soap/classes/class.ilSoapExerciseAdministration.php';
659 $sta = new ilSoapExerciseAdministration();
660 return $sta->updateExercise($sid, $ref_id, $xml);
661 }
662
666 public static function addExercise(string $sid, int $ref_id, string $xml)
667 {
668 include_once './webservice/soap/classes/class.ilSoapExerciseAdministration.php';
669 $sta = new ilSoapExerciseAdministration();
670 return $sta->addExercise($sid, $ref_id, $xml);
671 }
672
676 public static function getFileXML(string $sid, int $ref_id, int $attachFileContentsMode)
677 {
678 include_once './webservice/soap/classes/class.ilSoapFileAdministration.php';
679 $sta = new ilSoapFileAdministration();
680 return $sta->getFileXML($sid, $ref_id, $attachFileContentsMode);
681 }
682
686 public static function updateFile(string $sid, int $ref_id, string $xml)
687 {
688 include_once './webservice/soap/classes/class.ilSoapFileAdministration.php';
689 $sta = new ilSoapFileAdministration();
690 return $sta->updateFile($sid, $ref_id, $xml);
691 }
692
696 public static function addFile(string $sid, int $ref_id, string $xml)
697 {
698 include_once './webservice/soap/classes/class.ilSoapFileAdministration.php';
699 $sta = new ilSoapFileAdministration();
700 return $sta->addFile($sid, $ref_id, $xml);
701 }
702
706 public static function getObjIdsByRefIds(string $sid, array $ref_ids)
707 {
708 include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
709 $soa = new ilSoapObjectAdministration();
710 return $soa->getObjIdsByRefIds($sid, $ref_ids);
711 }
712
716 public static function getUserXML(string $sid, array $user_ids, bool $attach_roles)
717 {
718 include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
719 $sua = new ilSoapUserAdministration();
720 return $sua->getUserXML($sid, $user_ids, $attach_roles);
721 }
722
726 public static function updateGroup(string $sid, int $ref_id, string $grp_xml)
727 {
728 include_once './webservice/soap/classes/class.ilSoapGroupAdministration.php';
729 $sua = new ilSoapGroupAdministration();
730 return $sua->updateGroup($sid, $ref_id, $grp_xml);
731 }
732
736 public static function getIMSManifestXML(string $sid, int $ref_id)
737 {
738 include_once './webservice/soap/classes/class.ilSoapSCORMAdministration.php';
739 $sua = new ilSoapSCORMAdministration();
740 return $sua->getIMSManifestXML($sid, $ref_id);
741 }
742
743 public static function hasSCORMCertificate(string $sid, int $ref_id, int $usr_id)
744 {
745 include_once './webservice/soap/classes/class.ilSoapSCORMAdministration.php';
746 $sua = new ilSoapSCORMAdministration();
747 return $sua->hasSCORMCertificate($sid, $ref_id, $usr_id);
748 }
749
753 public static function copyObject(string $sid, string $copy_settings_xml)
754 {
755 include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
756 $soa = new ilSoapObjectAdministration();
757 return $soa->copyObject($sid, $copy_settings_xml);
758 }
759
763 public static function startBackgroundTaskWorker(string $sid)
764 {
765 require_once("./Services/BackgroundTasks/classes/class.ilSoapBackgroundTasksAdministration.php");
767 return $soa->runAsync($sid);
768 }
769
773 public static function moveObject(string $sid, int $ref_id, int $target_id)
774 {
775 include_once './webservice/soap/classes/class.ilSoapObjectAdministration.php';
776 $soa = new ilSoapObjectAdministration();
777 return $soa->moveObject($sid, $ref_id, $target_id);
778 }
779
783 public static function getTestResults(string $sid, int $ref_id, bool $sum_only)
784 {
785 include_once './webservice/soap/classes/class.ilSoapTestAdministration.php';
786 $soa = new ilSoapTestAdministration();
787 return $soa->getTestResults($sid, $ref_id, $sum_only);
788 }
789
793 public static function removeTestResults(string $sid, int $ref_id, array $a_user_ids)
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 }
799
803 public static function getCoursesForUser(string $sid, string $parameters)
804 {
805 include_once 'webservice/soap/classes/class.ilSoapCourseAdministration.php';
806 $soc = new ilSoapCourseAdministration();
807 return $soc->getCoursesForUser($sid, $parameters);
808 }
809
813 public static function getGroupsForUser(string $sid, string $parameters)
814 {
815 include_once 'webservice/soap/classes/class.ilSoapGroupAdministration.php';
816 $soc = new ilSoapGroupAdministration();
817 return $soc->getGroupsForUser($sid, $parameters);
818 }
819
823 public static function getPathForRefId(string $sid, int $ref_id)
824 {
825 include_once 'webservice/soap/classes/class.ilSoapObjectAdministration.php';
826 $soa = new ilSoapObjectAdministration();
827 return $soa->getPathForRefId($sid, $ref_id);
828 }
829
833 public static function searchRoles(string $sid, string $key, string $combination, string $role_type)
834 {
835 include_once 'webservice/soap/classes/class.ilSoapRBACAdministration.php';
836 $roa = new ilSoapRBACAdministration();
837 return $roa->searchRoles($sid, $key, $combination, $role_type);
838 }
839
840 public static function getInstallationInfoXML(): string
841 {
842 include_once 'webservice/soap/classes/class.ilSoapAdministration.php';
843 $roa = new ilSoapAdministration();
844 return $roa->getInstallationInfoXML();
845 }
846
850 public static function getClientInfoXML(string $clientid)
851 {
852 include_once 'webservice/soap/classes/class.ilSoapAdministration.php';
853 $roa = new ilSoapAdministration();
854 return $roa->getClientInfoXML($clientid);
855 }
856
860 public static function buildHTTPPath(): 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';
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 }
882
886 public static function getSCORMCompletionStatus(string $sid, int $usr_id, int $a_ref_id)
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 }
892
896 public static function getUserIdBySid(string $sid)
897 {
898 include_once './webservice/soap/classes/class.ilSoapUserAdministration.php';
899 $sua = new ilSoapUserAdministration();
900 return $sua->getUserIdBySid($sid);
901 }
902
906 public static function readWebLink(string $sid, int $ref_id)
907 {
908 include_once './webservice/soap/classes/class.ilSoapWebLinkAdministration.php';
909 $swa = new ilSoapWebLinkAdministration();
910 return $swa->readWebLink($sid, $ref_id);
911 }
912
916 public static function createWebLink(string $sid, int $ref_id, string $xml)
917 {
918 include_once './webservice/soap/classes/class.ilSoapWebLinkAdministration.php';
919
920 $swa = new ilSoapWebLinkAdministration();
921 return $swa->createWebLink($sid, $ref_id, $xml);
922 }
923
927 public static function updateWebLink(string $sid, int $ref_id, string $xml)
928 {
929 include_once './webservice/soap/classes/class.ilSoapWebLinkAdministration.php';
930 $swa = new ilSoapWebLinkAdministration();
931 return $swa->updateWebLink($sid, $ref_id, $xml);
932 }
933
934 public static function deleteExpiredDualOptInUserObjects(string $sid, int $usr_id): 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 }
943
947 public static function deleteProgress(string $sid, array $ref_ids, array $usr_ids, array $type_filter, array $progress_filter)
948 {
949 include_once './webservice/soap/classes/class.ilSoapLearningProgressAdministration.php';
951 return $sla->deleteProgress($sid, $ref_ids, $usr_ids, $type_filter, $progress_filter);
952 }
953
957 public static function getLearningProgressChanges(string $sid, string $timestamp, bool $include_ref_ids, array $type_filter)
958 {
959 include_once './webservice/soap/classes/class.ilSoapLearningProgressAdministration.php';
961 return $s->getLearningProgressChanges($sid, $timestamp, $include_ref_ids, $type_filter);
962 }
963
967 public static function getProgressInfo(string $sid, int $ref_id, array $progress_filter)
968 {
969 include_once './webservice/soap/classes/class.ilSoapLearningProgressAdministration.php';
971 return $sla->getProgressInfo($sid, $ref_id, $progress_filter);
972 }
973
977 public static function exportDataCollectionContent(string $sid, int $data_collection_id, ?int $table_id = null, string $format = "xls", ?string $filepath = null)
978 {
979 include_once './webservice/soap/classes/class.ilSoapDataCollectionAdministration.php';
981 return $dcl->exportDataCollectionContent($sid, $data_collection_id, $table_id, $format, $filepath);
982 }
983
988 public static function addUserToPositionInOrgUnit(...$params)
989 {
991 return $h->execute($params);
992 }
993
998 public static function getEmployeePositionId(...$params)
999 {
1000 $h = new EmployeePositionId();
1001 return $h->execute($params);
1002 }
1003
1008 public static function importOrgUnitsSimpleXML(...$params)
1009 {
1010 $h = new ImportOrgUnitTree();
1011 return $h->execute($params);
1012 }
1013
1018 public static function getOrgUnitsSimpleXML(...$params)
1019 {
1020 $h = new OrgUnitTree();
1021 return $h->execute($params);
1022 }
1023
1028 public static function getPositionIds(...$params)
1029 {
1030 $h = new PositionIds();
1031 return $h->execute($params);
1032 }
1033
1038 public static function getPositionTitle(...$params)
1039 {
1040 $h = new PositionTitle();
1041 return $h->execute($params);
1042 }
1043
1048 public static function removeUserFromPositionInOrgUnit(...$params)
1049 {
1051 return $h->execute($params);
1052 }
1053
1058 public static function getSuperiorPositionId(...$params)
1059 {
1060 $h = new SuperiorPositionId();
1061 return $h->execute($params);
1062 }
1063
1068 public static function getUserIdsOfPosition(...$params)
1069 {
1070 $h = new UserIdsOfPosition();
1071 return $h->execute($params);
1072 }
1073
1079 {
1080 $h = new UserIdsOfPositionAndOrgUnit();
1081 return $h->execute($params);
1082 }
1083
1090 public function __call($name, $arguments)
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).
1100 require_once 'Services/Init/classes/class.ilInitialisation.php';
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 }
1119}
$id
plugin.php for ilComponentBuildPluginInfoObjectiveTest::testAddPlugins
Definition: plugin.php:23
foreach($mandatory_scripts as $file) $timestamp
Definition: buildRTE.php:70
const CONTEXT_SOAP_NO_AUTH
static init(string $a_type)
Init context by type.
const CONTEXT_SOAP
static removeTrailingPathSeparators(string $path)
static initILIAS()
ilias initialisation
soap server Base class for all SOAP registered methods.
Soap data-collection administration methods.
Soap exercise administration methods.
Soap file administration methods.
static addFile(string $sid, int $ref_id, string $xml)
static deleteRole(string $sid, int $role_id)
static getTestUserData(string $sid, int $active_id)
static getObjectsByTitle(string $sid, string $a_title, ?int $user_id=null)
static addUserToPositionInOrgUnit(... $params)
static getObjectByReference(string $sid, int $a_ref_id, ?int $user_id=null)
static getLearningProgressChanges(string $sid, string $timestamp, bool $include_ref_ids, array $type_filter)
static getUserRoles(string $sid, int $user_id)
static deleteObject(string $sid, int $reference_id)
static login(string $client, string $username, string $password)
static getCourseXML(string $sid, int $course_id)
static getUserIdBySid(string $sid)
static removeUserFromPositionInOrgUnit(... $params)
static getUsersForRole(string $sid, int $role_id, bool $attach_roles, int $active)
static getEmployeePositionId(... $params)
static getObjIdByImportId(string $sid, string $import_id)
getUserIdsOfPositionAndOrgUnit(... $params)
static readWebLink(string $sid, int $ref_id)
static getNrOfQuestionsInPass(string $sid, int $active_id, int $pass)
static getOperations(string $sid)
static deleteCourse(string $sid, int $course_id)
static updateObjects(string $sid, string $obj_xml)
static isAssignedToCourse(string $sid, int $course_id, int $user_id)
static getUserIdsOfPosition(... $params)
static exportDataCollectionContent(string $sid, int $data_collection_id, ?int $table_id=null, string $format="xls", ?string $filepath=null)
static updateFile(string $sid, int $ref_id, string $xml)
static updateExercise(string $sid, int $ref_id, string $xml)
static excludeCourseMember(string $sid, int $course_id, int $user_id)
static getPositionIds(... $params)
static getFileXML(string $sid, int $ref_id, int $attachFileContentsMode)
static ilCloneDependencies(string $sid, int $copy_identifier)
static getObjectTreeOperations(string $sid, int $ref_id, int $user_id)
static excludeGroupMember(string $sid, int $group_id, int $user_id)
static createWebLink(string $sid, int $ref_id, string $xml)
static getRefIdsByObjId(string $sid, int $object_id)
static getSuperiorPositionId(... $params)
static hasSCORMCertificate(string $sid, int $ref_id, int $usr_id)
static revokePermissions(string $sid, int $ref_id, int $role_id)
static getQuestionSolution(string $sid, int $active_id, int $question_id, int $pass)
static grantPermissions(string $sid, int $ref_id, int $role_id, array $permissions)
static getProgressInfo(string $sid, int $ref_id, array $progress_filter)
static addUserRoleEntry(string $sid, int $user_id, int $role_id)
static getRefIdsByImportId(string $sid, string $import_id)
static updateGroup(string $sid, int $ref_id, string $grp_xml)
static getSCORMCompletionStatus(string $sid, int $usr_id, int $a_ref_id)
static hasNewMail(string $sid)
static importOrgUnitsSimpleXML(... $params)
static getRoles(string $sid, string $role_type, int $id)
static searchRoles(string $sid, string $key, string $combination, string $role_type)
static addExercise(string $sid, int $ref_id, string $xml)
static addRole(string $sid, int $target_id, string $obj_xml)
static getPathForRefId(string $sid, int $ref_id)
static removeTestResults(string $sid, int $ref_id, array $a_user_ids)
static importUsers(string $sid, int $folder_id, string $usr_xml, int $conflict_rule, bool $send_account_mail)
static startBackgroundTaskWorker(string $sid)
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)
__call($name, $arguments)
static addGroup(string $sid, int $target_id, string $group_xml)
static isAssignedToGroup(string $sid, int $group_id, int $user_id)
static addRoleFromTemplate(string $sid, int $target_id, string $obj_xml, int $template_id)
static saveTempFileAsMediaObject(string $sid, string $name, string $tmp_name)
static getLocalRoles(string $sid, int $ref_id)
static getPositionTitle(... $params)
static getMobsOfObject(string $sid, string $a_type, int $a_id)
static addReference(string $sid, int $a_source_id, int $a_target_id)
static removeFromSystemByImportId(string $sid, string $import_id)
static getPositionOfQuestion(string $sid, int $active_id, int $question_id, int $pass)
static moveObject(string $sid, int $ref_id, int $target_id)
static getUsersForContainer(string $sid, int $ref_id, bool $attach_roles, int $active)
static getClientInfoXML(string $clientid)
static groupExists(string $sid, string $title)
static assignCourseMember(string $sid, int $course_id, int $user_id, string $type)
static getIMSManifestXML(string $sid, int $ref_id)
static getPreviousReachedPoints(string $sid, int $active_id, int $question_id, int $pass)
static deleteUserRoleEntry(string $sid, int $user_id, int $role_id)
static getXMLTree(string $sid, int $ref_id, array $types, ?int $user_id=null)
static getInstallationInfoXML()
static ilClone(string $sid, int $copy_identifier)
static getOrgUnitsSimpleXML(... $params)
static copyObject(string $sid, string $copy_settings_xml)
static getGroup(string $sid, int $ref_id)
static getStructureObjects(string $sid, int $ref_id)
static getCoursesForUser(string $sid, string $parameters)
static searchUser(string $sid, array $a_keyfields, string $query_operator, array $a_keyvalues, bool $attach_roles, int $active)
static getGroupsForUser(string $sid, string $parameters)
static deleteExpiredDualOptInUserObjects(string $sid, int $usr_id)
static getUserXML(string $sid, array $user_ids, bool $attach_roles)
static logout(string $sid)
static getExerciseXML(string $sid, int $ref_id, int $attachFileContentsMode)
static getObjIdsByRefIds(string $sid, array $ref_ids)
static getTestResults(string $sid, int $ref_id, bool $sum_only)
static getTreeChilds(string $sid, int $ref_id, array $types, int $user_id)
static distributeMails(string $sid, string $mail_xml)
static lookupUser(string $sid, string $user_name)
static searchObjects(string $sid, array $types, string $key, string $combination, ?int $user_id=null)
static updateWebLink(string $sid, int $ref_id, string $xml)
static saveQuestion(string $sid, int $active_id, int $question_id, int $pass, array $solution)
static updateCourse(string $sid, int $course_id, string $xml)
static addCourse(string $sid, int $target_id, string $crs_xml)
static assignGroupMember(string $sid, int $group_id, int $user_id, string $type)
static addObject(string $sid, int $a_target_id, string $a_xml)
Class ilSoapHook.
This class handles all DB changes necessary for fraunhofer.
Class ilSoapPluginException.
Soap rbac administration methods.
Soap utitliy functions.
Soap methods for adminstrating web links.
$client
global $DIC
Definition: feed.php:28
$target_id
Definition: goto.php:52
$ref_id
Definition: ltiauth.php:67
if(! $DIC->user() ->getId()||!ilLTIConsumerAccess::hasCustomProviderCreationAccess()) $params
Definition: ltiregstart.php:33
$path
Definition: ltiservices.php:32
if($format !==null) $name
Definition: metadata.php:247
$format
Definition: metadata.php:235
$xml
Definition: metadata.php:351
string $key
Consumer key/client ID value.
Definition: System.php:193
$type
$_SERVER['HTTP_HOST']
Definition: raiseError.php:10
$_GET['client_id']
Definition: saml1-acs.php:21
const ILIAS_MODULE
Definition: server.php:14