ILIAS  release_10 Revision v10.1-43-ga1241a92c2f
ilNusoapUserAdministrationAdapter Class Reference
+ Collaboration diagram for ilNusoapUserAdministrationAdapter:

Public Member Functions

 __construct (bool $a_use_wsdl=true)
 
 start ()
 

Data Fields

soap_server $server
 

Protected Member Functions

 handleSoapPlugins ()
 Register any methods and types of SOAP plugins to the SOAP server. More...
 

Private Member Functions

 enableWSDL (ilSetting $setting)
 

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilNusoapUserAdministrationAdapter::__construct ( bool  $a_use_wsdl = true)

Definition at line 46 of file class.ilNusoapUserAdministrationAdapter.php.

References $DIC, enableWSDL(), and ILIAS\UI\examples\Progress\Bar\server().

47  {
48  define('SERVICE_NAME', 'ILIASSoapWebservice');
49  define('SERVICE_NAMESPACE', 'urn:ilUserAdministration');
50  define('SERVICE_STYLE', 'rpc');
51  define('SERVICE_USE', 'encoded');
52  $this->server = new soap_server();
53  $this->server->decode_utf8 = false;
54  $this->server->class = "ilSoapFunctions";
55 
56  if ($a_use_wsdl) {
57  global $DIC;
58  $this->enableWSDL($DIC->settings());
59  }
60 
61  $this->registerMethods();
62  }
Backward compatibility.
Definition: nusoap.php:4613
server()
description: > This example shows how a Progress Bar can be rendered and updated by the server...
Definition: server.php:27
global $DIC
Definition: shib_login.php:25
+ Here is the call graph for this function:

Member Function Documentation

◆ enableWSDL()

ilNusoapUserAdministrationAdapter::enableWSDL ( ilSetting  $setting)
private

Definition at line 71 of file class.ilNusoapUserAdministrationAdapter.php.

References $_GET, Vendor\Package\$f, ilSetting\get(), handleSoapPlugins(), and ILIAS\UI\examples\Progress\Bar\server().

Referenced by __construct().

71  : void
72  {
73  $this->server->configureWSDL(SERVICE_NAME, SERVICE_NAMESPACE);
74  $internal_path = $setting->get('soap_internal_wsdl_path', '');
75  if ($internal_path) {
76  $this->server->addInternalPort(SERVICE_NAME, $internal_path);
77  }
78  }
get(string $a_keyword, ?string $a_default_value=null)
get setting
server()
description: > This example shows how a Progress Bar can be rendered and updated by the server...
Definition: server.php:27
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ handleSoapPlugins()

ilNusoapUserAdministrationAdapter::handleSoapPlugins ( )
protected

Register any methods and types of SOAP plugins to the SOAP server.

Definition at line 1515 of file class.ilNusoapUserAdministrationAdapter.php.

References $DIC, ilContext\CONTEXT_SOAP, ilContext\CONTEXT_SOAP_NO_AUTH, ilContext\init(), ilInitialisation\initILIAS(), and ILIAS\UI\examples\Progress\Bar\server().

Referenced by enableWSDL().

1515  : void
1516  {
1517  // Note: We need a context that does not handle authentication at this point, because this is
1518  // handled by an actual SOAP request which always contains the session ID and client
1522 
1523  global $DIC;
1524 
1525  $component_factory = $DIC['component.factory'];
1526  $soapHook = new ilSoapHook($component_factory);
1527  foreach ($soapHook->getWsdlTypes() as $type) {
1528  $this->server->wsdl->addComplexType(
1529  $type->getName(),
1530  $type->getTypeClass(),
1531  $type->getPhpType(),
1532  $type->getCompositor(),
1533  $type->getRestrictionBase(),
1534  $type->getElements(),
1535  $type->getAttributes(),
1536  $type->getArrayType()
1537  );
1538  }
1539  foreach ($soapHook->getSoapMethods() as $method) {
1540  $this->server->register(
1541  $method->getName(),
1542  $method->getInputParams(),
1543  $method->getOutputParams(),
1544  $method->getServiceNamespace(),
1545  $method->getServiceNamespace() . '#' . $method->getName(),
1546  $method->getServiceStyle(),
1547  $method->getServiceUse(),
1548  $method->getDocumentation()
1549  );
1550  }
1551  }
const CONTEXT_SOAP_NO_AUTH
server()
description: > This example shows how a Progress Bar can be rendered and updated by the server...
Definition: server.php:27
static initILIAS()
ilias initialisation
Class ilSoapHook.
global $DIC
Definition: shib_login.php:25
static init(string $a_type)
Init context by type.
const CONTEXT_SOAP
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ start()

ilNusoapUserAdministrationAdapter::start ( )

Definition at line 64 of file class.ilNusoapUserAdministrationAdapter.php.

References exit, and ILIAS\UI\examples\Progress\Bar\server().

64  : void
65  {
66  $postdata = file_get_contents("php://input");
67  $this->server->service($postdata);
68  exit();
69  }
server()
description: > This example shows how a Progress Bar can be rendered and updated by the server...
Definition: server.php:27
+ Here is the call graph for this function:

Field Documentation

◆ $server

soap_server ilNusoapUserAdministrationAdapter::$server

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


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