ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
OrgUnitTree.php
Go to the documentation of this file.
1 <?php
20 
22 
27 class OrgUnitTree extends Base
28 {
29  public const ORGU_REF_ID = 'orgu_ref_id';
30  public const ORG_UNIT_TREE = 'OrgUnitTree';
31 
32  protected function run(array $params): string
33  {
34  $orgu_ref_id = $params[self::ORGU_REF_ID];
35 
36  $orgu_exporter = new ilOrgUnitExporter();
37 
38  return $orgu_exporter->simpleExport($orgu_ref_id)->xmlDumpMem(true);
39  }
40 
41  public function getName(): string
42  {
43  return "getOrgUnitsSimpleXML";
44  }
45 
46  protected function getAdditionalInputParams(): array
47  {
48  return array(
49  self::ORGU_REF_ID => Base::TYPE_INT,
50  );
51  }
52 
53  public function getOutputParams(): array
54  {
55  return array(self::ORG_UNIT_TREE => Base::TYPE_STRING);
56  }
57 
58  public function getDocumentation(): string
59  {
60  return "Returns the ILIAS Organisational Units (SimpleXML)";
61  }
62 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
if(! $DIC->user() ->getId()||!ilLTIConsumerAccess::hasCustomProviderCreationAccess()) $params
Definition: ltiregstart.php:33
getDocumentation()
Get the documentation of this method.
Definition: OrgUnitTree.php:58
getName()
Get the name of the method.
Definition: OrgUnitTree.php:41
getOutputParams()
Get the output parameters in the same format as the input parameters.
Definition: OrgUnitTree.php:53