vB_Api_Wrapper
in package
Uses
vB_Trait_NoSerialize
vB_Api_Wrapper This class is just a wrapper for API classes so that exceptions can be handled and translated for the client.
Tags
Table of Contents
- $api : mixed
- $controller : mixed
- __call() : mixed
- __construct() : mixed
- __serialize() : mixed
- __sleep() : mixed
- __unserialize() : mixed
- __wakeup() : mixed
- callNamed() : The
- Call the given api function by name with a named arguments list.
- validateCall() : mixed
- This method prevents catchable fatal errors when calling the API with missing arguments
Properties
$api
protected
mixed
$api
$controller
protected
mixed
$controller
Methods
__call()
public
__call(mixed $method, mixed $arguments) : mixed
Parameters
- $method : mixed
- $arguments : mixed
Return values
mixed —__construct()
public
__construct(mixed $controller, mixed $api) : mixed
Parameters
- $controller : mixed
- $api : mixed
Return values
mixed —__serialize()
public
__serialize() : mixed
Return values
mixed —__sleep()
public
__sleep() : mixed
Return values
mixed —__unserialize()
public
__unserialize(mixed $serialized) : mixed
Parameters
- $serialized : mixed
Return values
mixed —__wakeup()
public
__wakeup() : mixed
Return values
mixed —callNamed()
Call the given api function by name with a named arguments list.
public
callNamed() : The
Used primarily to translate REST requests into API calls.
Return values
The —return of the method or an error if the method doesn't exist, or is static, a constructor or destructor, or otherwise shouldn't be callable as and API method. It is also an error if the value of a paramater is not provided and that parameter doesn't have a default value.
validateCall()
This method prevents catchable fatal errors when calling the API with missing arguments
protected
validateCall(mixed $controller, string $method, array<string|int, mixed> $arguments) : mixed
Parameters
- $controller : mixed
- $method : string
- $arguments : array<string|int, mixed>