service/v2/SugarSoapService2.php

Show:

inherited

Constants
- sugarEntry
Functions
Classes
- \SugarSoapService2

Table of Contents

Constants

 
                sugarEntry
                = true

\SugarSoapService2
jump to top

Package:

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()'

inheritedInherited from: \SugarWebService::$$excludeFunctions \SugarSoapService::$$excludeFunctions \NusoapSoap::$$excludeFunctions

Default valuearray()Details

Type: n/a
Inherited_from: \SugarWebService::$$excludeFunctions
Inherited_from: \SugarSoapService::$$excludeFunctions
Inherited_from: \NusoapSoap::$$excludeFunctions


                 $implementationClass= ''SugarWebServiceImpl''

inheritedInherited from: \SugarSoapService::$$implementationClass \NusoapSoap::$$implementationClass

Default value'SugarWebServiceImpl'Details

Type: n/a
Inherited_from: \SugarSoapService::$$implementationClass
Inherited_from: \NusoapSoap::$$implementationClass


                 $namespace= ''http://www.sugarcrm.com/sugarcrm''

inheritedInherited from: \SugarSoapService::$$namespace \NusoapSoap::$$namespace

Default value'http://www.sugarcrm.com/sugarcrm'Details

Type: n/a
Inherited_from: \SugarSoapService::$$namespace
Inherited_from: \NusoapSoap::$$namespace


                 $registryClass= '""'

inheritedInherited from: \SugarSoapService::$$registryClass \NusoapSoap::$$registryClass

Default value""Details

Type: n/a
Inherited_from: \SugarSoapService::$$registryClass
Inherited_from: \NusoapSoap::$$registryClass


                 $server= 'null'

inheritedInherited from: \SugarWebService::$$server \SugarSoapService::$$server \NusoapSoap::$$server

Default valuenullDetails

Type: n/a
Inherited_from: \SugarWebService::$$server
Inherited_from: \SugarSoapService::$$server
Inherited_from: \NusoapSoap::$$server


                 $soapURL= '""'

inheritedInherited from: \SugarSoapService::$$soapURL \NusoapSoap::$$soapURL

Default value""Details

Type: n/a
Inherited_from: \SugarSoapService::$$soapURL
Inherited_from: \NusoapSoap::$$soapURL


                 $soap_version= ''1.1''

inheritedInherited from: \SugarSoapService::$$soap_version \NusoapSoap::$$soap_version

Default value'1.1'Details

Type: n/a
Inherited_from: \SugarSoapService::$$soap_version
Inherited_from: \NusoapSoap::$$soap_version

Methods

__construct(
          String $url
          )
        
        :
          void

inherited

This is the constructor. It creates an instance of NUSOAP server.

Inherited from: \NusoapSoap::__construct()

Parameters

Name	Type	Description
$url	String	This is the soap URL

Details

Access: public

error(
          \SoapError $errorObject
          )
        
        :
          void

inherited

This function sets the fault object on the NUSOAP

Inherited from: \NusoapSoap::error()

Parameters

Name	Type	Description
$errorObject	\SoapError	This is an object of type SoapError

Details

Access: public

getNameSpace(
          
          )
        
        :
          String

inherited

This method returns the namespace

Inherited from: \SugarSoapService::getNameSpace()\NusoapSoap::getNameSpace()

Returns

Type	Description
String	- namespace

Details

Access: public

getRegisteredClass(
          
          )
        
        :
          String

inherited

This mehtod returns registry class

Inherited from: \SugarSoapService::getRegisteredClass()\NusoapSoap::getRegisteredClass()

Returns

Type	Description
String	- registryClass

Details

Access: public

getRegisteredImplClass(
          
          )
        
        :
          String

inherited

This mehtod returns registered implementation class

Inherited from: \SugarSoapService::getRegisteredImplClass()\NusoapSoap::getRegisteredImplClass()

Returns

Type	Description
String	- implementationClass

Details

Access: public

getServer(
          
          )
        
        :
          String

inherited

This mehtod returns server

Inherited from: \SugarSoapService::getServer()\NusoapSoap::getServer()

Returns

Type	Description
String	-server

Details

Access: public

getSoapURL(
          
          )
        
        :
          String

inherited

This method returns the soapURL

Inherited from: \SugarSoapService::getSoapURL()\NusoapSoap::getSoapURL()

Returns

Type	Description
String	- soapURL

Details

Access: public

getSoapVersion(
          
          )
        
        :
          void

inherited

Inherited from: \SugarSoapService::getSoapVersion()\NusoapSoap::getSoapVersion()

register(
          array $excludeFunctions
              =
              array()
          )
        
        :
          void

This method registers all the functions which you want to be available for SOAP.

Parameters

Name	Type	Description
$excludeFunctions	array	All the functions you don't want to register

registerClass(
          String $registryClass
          )
        
        :
          void

inherited

Sets the name of the registry class

Inherited from: \NusoapSoap::registerClass()

Parameters

Name	Type	Description
$registryClass	String

Details

Access: public

registerFunction(
          String $function, Array $input, Array $output
          )
        
        :
          void

inherited

This method registers all the functions you want to expose as services with NUSOAP

Inherited from: \NusoapSoap::registerFunction()

Parameters

Name	Type	Description
$function	String	name of the function
$input	Array	assoc array of input values: key = param name, value = param type
$output	Array	assoc array of output values: key = param name, value = param type

Details

Access: public

registerImplClass(
          String $implementationClass
          )
        
        :
          void

inherited

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()

Parameters

Name	Type	Description
$implementationClass	String

Details

Access: public

registerType(
          String $name, String $typeClass, String $phpType, String $compositor, String $restrictionBase, Array $elements, Array $attrs
              =
              array(), String $arrayType
              =
              ''
          )
        
        :
          void

inherited

This method registers all the complex type with NUSOAP server so that proper WSDL can be generated

Inherited from: \NusoapSoap::registerType()

Parameters

Name	Type	Description
$name	String	name of complex type
$typeClass	String	(complexType\|simpleType\|attribute)
$phpType	String	array or struct
$compositor	String	(all\|sequence\|choice)
$restrictionBase	String	SOAP-ENC:Array or empty
$elements	Array	array ( name => array(name=>'',type=>'') )
$attrs	Array	array(array('ref'=>'SOAP-ENC:arrayType','wsdl:arrayType'=>'xsd:string[]'))
$arrayType	String	arrayType: namespace:name (xsd:string)

Details

Access: public

inherited

It passes request data to NUSOAP server and sends response back to client

Inherited from: \NusoapSoap::serve()

Details

Access: public

setObservers(
          
          )
        
        :
          void

inherited

This method sets the soap server object on all the observers

Inherited from: \SugarSoapService::setObservers()\NusoapSoap::setObservers()

Details

Access: public

shutdown(
          
          )
        
        :
          void

inherited

Fallback function to catch unexpected failure in SOAP

Inherited from: \NusoapSoap::shutdown()

service/v2/SugarSoapService2.php

Constants

\SugarSoapService2jump to top

Properties

Methods

\SugarSoapService2
jump to top