Interface ilSoapMethod. More...
Inheritance diagram for ilSoapMethod:
Collaboration diagram for ilSoapMethod:
Public Member Functions | |
| getName () | |
| Get the name of the method. More... | |
| getInputParams () | |
| Get the input parameters. More... | |
| getOutputParams () | |
| Get the output parameters in the same format as the input parameters. More... | |
| getServiceNamespace () | |
| Get the namespace of the service where this method belongs to. More... | |
| getServiceStyle () | |
| Get the service style, e.g. More... | |
| getServiceUse () | |
| Get the service use, e.g. More... | |
| getDocumentation () | |
| Get the documentation of this method. More... | |
| execute (array $params) | |
| Execute the business logic for this SOAP method (when a SOAP request hits the endpoint defined by the name). More... | |
Detailed Description
Interface ilSoapMethod.
Describes a soap method which can be added to the ILIAS SOAP webservice by a plugin of the SoapHook plugin slot
Definition at line 9 of file ilSoapMethod.php.
Member Function Documentation
◆ execute()
| ilSoapMethod::execute | ( | array | $params | ) |
Execute the business logic for this SOAP method (when a SOAP request hits the endpoint defined by the name).
Note: This Method must return the data in the format specified by getOutputParams().
- Parameters
-
array $params Key/Value pair of parameters defined by getInputParams()
- Returns
- mixed
Implemented in ILIAS\OrgUnit\Webservices\SOAP\Base.
◆ getDocumentation()
| ilSoapMethod::getDocumentation | ( | ) |
Get the documentation of this method.
- Returns
- string
Implemented in ILIAS\OrgUnit\Webservices\SOAP\ImportOrgUnitTree, ILIAS\OrgUnit\Webservices\SOAP\RemoveUserIdFromPositionInOrgUnit, ILIAS\OrgUnit\Webservices\SOAP\AddUserIdToPositionInOrgUnit, ILIAS\OrgUnit\Webservices\SOAP\PositionTitle, ILIAS\OrgUnit\Webservices\SOAP\OrgUnitTree, ILIAS\OrgUnit\Webservices\SOAP\UserIdsOfPositionAndOrgUnit, ILIAS\OrgUnit\Webservices\SOAP\SuperiorPositionId, ILIAS\OrgUnit\Webservices\SOAP\UserIdsOfPosition, ILIAS\OrgUnit\Webservices\SOAP\EmployeePositionId, and ILIAS\OrgUnit\Webservices\SOAP\PositionIds.
◆ getInputParams()
| ilSoapMethod::getInputParams | ( | ) |
Get the input parameters.
Array keys must correspond to parameter names and values must correspond to a valid SOAP data-type
- Returns
- array
- See also
- ilNusoapUserAdministrationAdapter::registerMethods() for examples
Implemented in ILIAS\OrgUnit\Webservices\SOAP\Base.
Referenced by ilAbstractSoapMethod\checkParameters().
Here is the caller graph for this function:
◆ getName()
| ilSoapMethod::getName | ( | ) |
Get the name of the method.
Used as endpoint for SOAP requests. Note that this name must be unique in combination with the service namespace.
- Returns
- string
Implemented in ILIAS\OrgUnit\Webservices\SOAP\ImportOrgUnitTree, ILIAS\OrgUnit\Webservices\SOAP\RemoveUserIdFromPositionInOrgUnit, ILIAS\OrgUnit\Webservices\SOAP\AddUserIdToPositionInOrgUnit, ILIAS\OrgUnit\Webservices\SOAP\PositionTitle, ILIAS\OrgUnit\Webservices\SOAP\OrgUnitTree, ILIAS\OrgUnit\Webservices\SOAP\UserIdsOfPositionAndOrgUnit, ILIAS\OrgUnit\Webservices\SOAP\UserIdsOfPosition, ILIAS\OrgUnit\Webservices\SOAP\EmployeePositionId, ILIAS\OrgUnit\Webservices\SOAP\PositionIds, and ILIAS\OrgUnit\Webservices\SOAP\SuperiorPositionId.
Referenced by ilSoapHook\getMethodByName().
Here is the caller graph for this function:
◆ getOutputParams()
| ilSoapMethod::getOutputParams | ( | ) |
Get the output parameters in the same format as the input parameters.
- Returns
- array
Implemented in ILIAS\OrgUnit\Webservices\SOAP\ImportOrgUnitTree, ILIAS\OrgUnit\Webservices\SOAP\RemoveUserIdFromPositionInOrgUnit, ILIAS\OrgUnit\Webservices\SOAP\AddUserIdToPositionInOrgUnit, ILIAS\OrgUnit\Webservices\SOAP\PositionTitle, ILIAS\OrgUnit\Webservices\SOAP\OrgUnitTree, ILIAS\OrgUnit\Webservices\SOAP\UserIdsOfPositionAndOrgUnit, ILIAS\OrgUnit\Webservices\SOAP\SuperiorPositionId, ILIAS\OrgUnit\Webservices\SOAP\UserIdsOfPosition, ILIAS\OrgUnit\Webservices\SOAP\EmployeePositionId, and ILIAS\OrgUnit\Webservices\SOAP\PositionIds.
◆ getServiceNamespace()
| ilSoapMethod::getServiceNamespace | ( | ) |
Get the namespace of the service where this method belongs to.
- Returns
- string
Implemented in ILIAS\OrgUnit\Webservices\SOAP\Base.
◆ getServiceStyle()
| ilSoapMethod::getServiceStyle | ( | ) |
Get the service style, e.g.
'rpc'
- Returns
- string
Implemented in ILIAS\OrgUnit\Webservices\SOAP\Base, and ilAbstractSoapMethod.
◆ getServiceUse()
| ilSoapMethod::getServiceUse | ( | ) |
Get the service use, e.g.
'encoded'
- Returns
- string
Implemented in ILIAS\OrgUnit\Webservices\SOAP\Base, and ilAbstractSoapMethod.
The documentation for this interface was generated from the following file:
- components/ILIAS/WebServices/SOAP/classes/ilSoapMethod.php
