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