ILIAS  trunk Revision v11.0_alpha-1866-gfa368f7776e
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
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 41 of file class.ilNusoapUserAdministrationAdapter.php.

Constructor & Destructor Documentation

◆ __construct()

ilNusoapUserAdministrationAdapter::__construct ( bool  $a_use_wsdl = true)

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

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

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

Member Function Documentation

◆ enableWSDL()

ilNusoapUserAdministrationAdapter::enableWSDL ( ilSetting  $setting)
private

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

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

Referenced by __construct().

70  : void
71  {
72  $this->server->configureWSDL(SERVICE_NAME, SERVICE_NAMESPACE);
73  $internal_path = $setting->get('soap_internal_wsdl_path', '');
74  if ($internal_path) {
75  $this->server->addInternalPort(SERVICE_NAME, $internal_path);
76  }
77  }
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:43
+ 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 1516 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().

1516  : void
1517  {
1518  // Note: We need a context that does not handle authentication at this point, because this is
1519  // handled by an actual SOAP request which always contains the session ID and client
1523 
1524  global $DIC;
1525 
1526  $component_factory = $DIC['component.factory'];
1527  $soapHook = new ilSoapHook($component_factory);
1528  foreach ($soapHook->getWsdlTypes() as $type) {
1529  $this->server->wsdl->addComplexType(
1530  $type->getName(),
1531  $type->getTypeClass(),
1532  $type->getPhpType(),
1533  $type->getCompositor(),
1534  $type->getRestrictionBase(),
1535  $type->getElements(),
1536  $type->getAttributes(),
1537  $type->getArrayType()
1538  );
1539  }
1540  foreach ($soapHook->getSoapMethods() as $method) {
1541  $this->server->register(
1542  $method->getName(),
1543  $method->getInputParams(),
1544  $method->getOutputParams(),
1545  $method->getServiceNamespace(),
1546  $method->getServiceNamespace() . '#' . $method->getName(),
1547  $method->getServiceStyle(),
1548  $method->getServiceUse(),
1549  $method->getDocumentation()
1550  );
1551  }
1552  }
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:43
static initILIAS()
ilias initialisation
Class ilSoapHook.
global $DIC
Definition: shib_login.php:22
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 63 of file class.ilNusoapUserAdministrationAdapter.php.

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

63  : void
64  {
65  $postdata = file_get_contents("php://input");
66  $this->server->service($postdata);
67  exit();
68  }
server()
description: > This example shows how a Progress Bar can be rendered and updated by the server...
Definition: server.php:43
exit
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
+ Here is the call graph for this function:

Field Documentation

◆ $server

soap_server ilNusoapUserAdministrationAdapter::$server

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


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