service/core/PHP5Soap.php

Show:

inherited

Classes
- \PHP5Soap

Table of Contents

\PHP5Soap
jump to top

Package:

This ia an abstract class for the soapservice. All the global fun

All type of web services should provide proper implementation of all the abstract methods

Parent(s): \SugarSoapService < \SugarWebService

Properties


                 $excludeFunctions= 'array()'

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

Default valuearray()Details

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


                 $implementationClass= ''SugarWebServiceImpl''

inheritedInherited from: \SugarSoapService::$$implementationClass

Default value'SugarWebServiceImpl'Details

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


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

inheritedInherited from: \SugarSoapService::$$namespace

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

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


                 $nusoap_server= 'null'

Default valuenullDetails

Type: n/a


                 $registryClass= '""'

inheritedInherited from: \SugarSoapService::$$registryClass

Default value""Details

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


                 $server= 'null'

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

Default valuenullDetails

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


                 $soapURL= '""'

inheritedInherited from: \SugarSoapService::$$soapURL

Default value""Details

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


                 $soap_version= ''1.1''

inheritedInherited from: \SugarSoapService::$$soap_version

Default value'1.1'Details

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

Methods

__construct(
           $url
          )
        
        :
          void

Constructor

Parameters

Name	Type	Description
$url

error(
           $errorObject
          )
        
        :
          void

Parameters

Name	Type	Description
$errorObject

generateNuSoap(
          
          )
        
        :
          void

generateSoapServer(
          
          )
        
        :
          void

getNameSpace(
          
          )
        
        :
          String

This method returns the namespace

Returns

Type	Description
String	- namespace

getRegisteredClass(
          
          )
        
        :
          String

inherited

This mehtod returns registry class

Inherited from: \SugarSoapService::getRegisteredClass()

Returns

Type	Description
String	- registryClass

Details

Access: public

getRegisteredImplClass(
          
          )
        
        :
          String

inherited

This mehtod returns registered implementation class

Inherited from: \SugarSoapService::getRegisteredImplClass()

Returns

Type	Description
String	- implementationClass

Details

Access: public

getServer(
          
          )
        
        :
          String

inherited

This mehtod returns server

Inherited from: \SugarSoapService::getServer()

Returns

Type	Description
String	-server

Details

Access: public

getSoapURL(
          
          )
        
        :
          String

inherited

This method returns the soapURL

Inherited from: \SugarSoapService::getSoapURL()

Returns

Type	Description
String	- soapURL

Details

Access: public

getSoapVersion(
          
          )
        
        :
          void

inherited

Inherited from: \SugarSoapService::getSoapVersion()

getWSDLPath(
           $generateWSDL
          )
        
        :
          void

Parameters

Name	Type	Description
$generateWSDL

register(
           $excludeFunctions
              =
              array()
          )
        
        :
          void

abstractinherited

Inherited from: \SugarWebService::register()\SugarSoapService::register()

Parameters

Name	Type	Description
$excludeFunctions

registerClass(
           $registryClass
          )
        
        :
          void

Parameters

Name	Type	Description
$registryClass

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

This is an abstract method. The implementation method should registers all the functions you want to expose as services.

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

registerImplClass(
           $implementationClass
          )
        
        :
          void

Parameters

Name	Type	Description
$implementationClass

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

This is an abstract method. This implementation method should register all the complex type

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)

Serves the Soap Request

setObservers(
          
          )
        
        :
          void

This method sets the soap server object on all the observers

setSoapVersion(
          \$version $version
              =
              '1.1'
          )
        
        :

This function allows specifying what version of PHP soap to use PHP soap supports version 1.1 and 1.2.

Parameters

Name	Type	Description
$version	\$version	String[optional]

service/core/PHP5Soap.php

\PHP5Soapjump to top

Properties

Methods

\PHP5Soap
jump to top