service/core/SugarSoapService.php

Show:

inherited

Constants
- sugarEntry
Functions
Classes
- \SugarSoapService

Table of Contents

Constants

 
                sugarEntry
                = true

\SugarSoapService
jump to top

Package: SugarCRM

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): \SugarWebService
Children: \PHP5Soap; \NusoapSoap

Properties


                 $excludeFunctions= 'array()'

inheritedInherited from: \SugarWebService::$$excludeFunctions

Default valuearray()Details

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


                 $implementationClass= ''SugarWebServiceImpl''

Default value'SugarWebServiceImpl'Details

Type: n/a


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

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

Type: n/a


                 $registryClass= '""'

Default value""Details

Type: n/a


                 $server= 'null'

inheritedInherited from: \SugarWebService::$$server

Default valuenullDetails

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


                 $soapURL= '""'

Default value""Details

Type: n/a


                 $soap_version= ''1.1''

Default value'1.1'Details

Type: n/a

Methods

__construct(
          
          )
        
        :
          void

Constructor

error(
           $errorObject
          )
        
        :
          void

abstractinherited

Inherited from: \SugarWebService::error()

Parameters

Name	Type	Description
$errorObject

getNameSpace(
          
          )
        
        :
          String

This method returns the namespace

Returns

Type	Description
String	- namespace

Details

Access: public

getRegisteredClass(
          
          )
        
        :
          String

This mehtod returns registry class

Returns

Type	Description
String	- registryClass

Details

Access: public

getRegisteredImplClass(
          
          )
        
        :
          String

This mehtod returns registered implementation class

Returns

Type	Description
String	- implementationClass

Details

Access: public

getServer(
          
          )
        
        :
          String

This mehtod returns server

Returns

Type	Description
String	-server

Details

Access: public

getSoapURL(
          
          )
        
        :
          String

This method returns the soapURL

Returns

Type	Description
String	- soapURL

Details

Access: public

getSoapVersion(
          
          )
        
        :
          void

register(
           $excludeFunctions
              =
              array()
          )
        
        :
          void

abstractinherited

Inherited from: \SugarWebService::register()

Parameters

Name	Type	Description
$excludeFunctions

registerClass(
           $class
          )
        
        :
          void

abstractinherited

Inherited from: \SugarWebService::registerClass()

Parameters

Name	Type	Description
$class

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

abstract

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

Details

Access: public

registerImplClass(
           $class
          )
        
        :
          void

abstractinherited

Inherited from: \SugarWebService::registerImplClass()

Parameters

Name	Type	Description
$class

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

abstract

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)

Details

Access: public

abstractinherited

Inherited from: \SugarWebService::serve()

setObservers(
          
          )
        
        :
          void

This method sets the soap server object on all the observers

Details

Access: public

service/core/SugarSoapService.php

Constants

\SugarSoapServicejump to top

Properties

Methods

\SugarSoapService
jump to top