\WebServiceController
Controller designed to wrap around calls to defined services
To call a service, use jsonservice/servicename/methodname
- Author: marcus@silverstripe.com.au
- License: BSD License http://silverstripe.org/bsd-license/
Synopsis
class WebServiceController
extends Controller
{
- // members
- protected array $converters = ;
- protected string $format = 'json';
- private static array $dependencies = ;
- public WebserviceAuthenticator $webserviceAuthenticator;
- public Injector $injector;
- // methods
- public void init()
- public void handleRequest()
- public mixed handleService()
- protected array getRequestArgs()
- protected void checkMethods()
- public void convertResponse()
- public static void set_allow_public()
- protected void ajaxResponse()
Hierarchy
Extends
- Controller
Members
private
- $dependencies
protected
- $converters
—
array
List of object -> json converter classes - $format
public
- $injector — Injector
- $webserviceAuthenticator — WebserviceAuthenticator
Methods
protected
- ajaxResponse()
- checkMethods() — Check the allowed methods for access rights
- getRequestArgs() — Process a request URL + body to get all parameters for a request
public
- convertResponse() — Converts the given object to something appropriate for a response
- handleRequest()
- handleService() — Calls to webservices are routed through here and converted from url params to method calls.
- init()
- set_allow_public() — Indicate whether public users can access web services in general