service/core/NusoapSoap.php
inherited
Constants
Functions
Classes
Constants
\NusoapSoap
This is an abstract class for the soap implementation for using NUSOAP. This class is responsible for making all NUSOAP call by passing the client's request to NUSOAP server and seding response back to client
All type of web services should provide proper implementation of all the abstract methods
- Parent(s)
- \SugarSoapService < \SugarWebService
- Children
- \SugarSoapService2
- Api
Properties
$excludeFunctions= 'array()'
array()Details- Type
- n/a
- Inherited_from
- \SugarWebService::$$excludeFunctions
- Inherited_from
- \SugarSoapService::$$excludeFunctions
$implementationClass= ''SugarWebServiceImpl''
'SugarWebServiceImpl'Details- Type
- n/a
- Inherited_from
- \SugarSoapService::$$implementationClass
$namespace= ''http://www.sugarcrm.com/sugarcrm''
'http://www.sugarcrm.com/sugarcrm'Details- Type
- n/a
- Inherited_from
- \SugarSoapService::$$namespace
$registryClass= '""'
""Details- Type
- n/a
- Inherited_from
- \SugarSoapService::$$registryClass
$server= 'null'
nullDetails- Type
- n/a
- Inherited_from
- \SugarWebService::$$server
- Inherited_from
- \SugarSoapService::$$server
$soapURL= '""'
""Details- Type
- n/a
- Inherited_from
- \SugarSoapService::$$soapURL
$soap_version= ''1.1''
'1.1'Details- Type
- n/a
- Inherited_from
- \SugarSoapService::$$soap_version
Methods
__construct(
String $url
)
:
voidThis is the constructor. It creates an instance of NUSOAP server.
| Name | Type | Description |
|---|---|---|
| $url | String |
|
- Access
- public
error(
\SoapError $errorObject
)
:
voidThis function sets the fault object on the NUSOAP
| Name | Type | Description |
|---|---|---|
| $errorObject | \SoapError |
|
- Access
- public
getNameSpace(
)
:
String
| Type | Description |
|---|---|
| String | - namespace |
- Access
- public
getRegisteredClass(
)
:
String
| Type | Description |
|---|---|
| String | - registryClass |
- Access
- public
getRegisteredImplClass(
)
:
StringThis mehtod returns registered implementation class
Inherited from: \SugarSoapService::getRegisteredImplClass()| Type | Description |
|---|---|
| String | - implementationClass |
- Access
- public
getServer(
)
:
String
| Type | Description |
|---|---|
| String | -server |
- Access
- public
getSoapURL(
)
:
String
| Type | Description |
|---|---|
| String | - soapURL |
- Access
- public
register(
$excludeFunctions
=
array()
)
:
void
| Name | Type | Description |
|---|---|---|
| $excludeFunctions |
registerClass(
String $registryClass
)
:
voidSets the name of the registry class
| Name | Type | Description |
|---|---|---|
| $registryClass | String |
- Access
- public
registerFunction(
String $function, Array $input, Array $output
)
:
voidThis method registers all the functions you want to expose as services with NUSOAP
| Name | Type | Description |
|---|---|---|
| $function | String |
|
| $input | Array |
|
| $output | Array |
|
- Access
- public
registerImplClass(
String $implementationClass
)
:
voidThis function registers implementation class name with NUSOAP so when NUSOAP makes a call to a funciton, it will be made on this class object
| Name | Type | Description |
|---|---|---|
| $implementationClass | String |
- Access
- public
registerType(
String $name, String $typeClass, String $phpType, String $compositor, String $restrictionBase, Array $elements, Array $attrs
=
array(), String $arrayType
=
''
)
:
voidThis method registers all the complex type with NUSOAP server so that proper WSDL can be generated
| Name | Type | Description |
|---|---|---|
| $name | String |
|
| $typeClass | String |
|
| $phpType | String |
|
| $compositor | String |
|
| $restrictionBase | String |
|
| $elements | Array |
|
| $attrs | Array |
|
| $arrayType | String |
|
- Access
- public
serve(
)
:
voidIt passes request data to NUSOAP server and sends response back to client
- Access
- public
setObservers(
)
:
voidThis method sets the soap server object on all the observers
Inherited from: \SugarSoapService::setObservers()- Access
- public
shutdown(
)
:
voidFallback function to catch unexpected failure in SOAP