service/core/SugarRestService.php

Show:

inherited

Constants
- sugarEntry
Functions
Classes
- \SugarRestService

Table of Contents

Constants

 
                sugarEntry
                = true

\SugarRestService
jump to top

Package: SugarCRM

Base class for rest services

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

Parent(s): \SugarWebService

Properties


                 $excludeFunctions= 'array()'

inheritedInherited from: \SugarWebService::$$excludeFunctions

Default valuearray()Details

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


                 $implementationClass= ''SugarRestServiceImpl''

Default value'SugarRestServiceImpl'Details

Type: n/a


                 $registeredFunc= 'array()'

Default valuearray()Details

Type: n/a


                 $restURL= '""'

Default value""Details

Type: n/a


                 $server= 'null'

inheritedInherited from: \SugarWebService::$$server

Default valuenullDetails

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

Methods

__construct(
          String $url
          )
        
        :
          void

Constructor.

Parameters

Name	Type	Description
$url	String	REST url

_getTypeName(
          string $name
          )
        
        :
          string

Get Sugar REST class name for input/return type

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string

error(
          \SoapError $errorObject
          )
        
        :
          void

This function sets the fault object on the REST

Parameters

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

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

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

Enter description here...

Parameters

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

registerClass(
          String $registryClass
          )
        
        :
          void

Sets the name of the registry class

Parameters

Name	Type	Description
$registryClass	String

Details

Access: public

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

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

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(
           $className
          )
        
        :
          void

This function registers implementation class name and creates an instance of rest implementation class it will be made on this class object

Parameters

Name	Type	Description
$className

Details

Access: public

registerType(
           $name,  $typeClass,  $phpType,  $compositor,  $restrictionBase,  $elements,  $attrs,  $arrayType
          )
        
        :
          void

Its a no op method

Parameters

Name	Type	Description
$name
$typeClass
$phpType
$compositor
$restrictionBase
$elements
$attrs
$arrayType

Details

Access: public

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

Details

Access: public

service/core/SugarRestService.php

Constants

\SugarRestServicejump to top

Properties

Methods

\SugarRestService
jump to top