vB_Api_External
extends vB_Api
in package
vB_Api_External
Tags
Table of Contents
Constants
Methods
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- buildExternalRoute() : mixed
- Builds an external data provider route depending on the type and extra data specified.
- callNamed() : The
- Call the given api function by name with a named arguments list.
- checkApiState() : mixed
- This method checks whether the API method is enabled.
- clearCache() : mixed
- Clears all previously loaded API objects.
- createExternalOutput() : string
- Creates an external output from site depending on the type specified.
- getApiClassName() : mixed
- getCacheData() : string
- Gets useful information for external cache logic, such as cachetime and cachehash.
- getHeadersFromLastOutput() : mixed
- Get a list of valid headers values from last output data regarding on the data and external type specified. (vB_External_Export::$headers).
- instance() : vB_Api
- Returns an instance of the API object which translates exceptions to an array Use this method for API clients.
- instanceInternal() : vB_Api
- Returns an instance of the API object which doesn't handle exceptions This should only be used in other API objects, not for clients of the API
- map_vb4_input_to_vb5() : string
- Returns vb5 api method name.
- map_vb5_errors_to_vb4() : mixed
- Alters the error array in any way necessary to interface correctly with vb4.
- map_vb5_output_to_vb4() : mixed
- Alters the output array in any way necessary to interface correctly with vb4.
Constants
TYPE_JS
public
mixed
TYPE_JS
= 'js'
TYPE_RSS
public
mixed
TYPE_RSS
= 'rss'
TYPE_RSS1
public
mixed
TYPE_RSS1
= 'rss1'
TYPE_RSS2
public
mixed
TYPE_RSS2
= 'rss2'
TYPE_XML
public
mixed
TYPE_XML
= 'xml'
Methods
__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>__sleep()
public
__sleep() : array<string|int, mixed>
Return values
array<string|int, mixed>__unserialize()
public
__unserialize(array<string|int, mixed> $serialized) : void
Parameters
- $serialized : array<string|int, mixed>
__wakeup()
public
__wakeup() : void
buildExternalRoute()
Builds an external data provider route depending on the type and extra data specified.
public
buildExternalRoute(mixed $type[, mixed $data = array() ]) : mixed
@param string External data provider type
Supported: self::TYPE_JS, self::TYPE_XML, self::TYPE_RSS, self::TYPE_RSS1, self::TYPE_RSS2
Parameters
- $type : mixed
- $data : mixed = array()
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.
checkApiState()
This method checks whether the API method is enabled.
public
checkApiState(mixed $method) : mixed
For extensions check make sure $controller property is already set.
Parameters
- $method : mixed
clearCache()
Clears all previously loaded API objects.
public
static clearCache() : mixed
Intended for use in tests where the loading pattern can cause issues with objects that cache thier own data.
createExternalOutput()
Creates an external output from site depending on the type specified.
public
createExternalOutput(mixed $type[, mixed $options = array() ]) : string
Output will be formatted regarding the options being passed.
Parameters
- $type : mixed
- $options : mixed = array()
Return values
string —External output.
getApiClassName()
public
static getApiClassName(mixed $controller) : mixed
Parameters
- $controller : mixed
getCacheData()
Gets useful information for external cache logic, such as cachetime and cachehash.
public
getCacheData(mixed $type[, mixed $options = [] ]) : string
Parameters
- $type : mixed
- $options : mixed = []
Return values
string —Cache hash.
getHeadersFromLastOutput()
Get a list of valid headers values from last output data regarding on the data and external type specified. (vB_External_Export::$headers).
public
getHeadersFromLastOutput(mixed $type, mixed $data) : mixed
Notice this has to be called after createExternalOutput() gets called so needed data gets in place.
Parameters
- $type : mixed
- $data : mixed
instance()
Returns an instance of the API object which translates exceptions to an array Use this method for API clients.
public
static instance(string $controller[, bool $refresh_cache = false ]) : vB_Api
Parameters
- $controller : string
-
-- name of the API controller to load
- $refresh_cache : bool = false
-
-- true if we want to force the cache to update with a new api object primarily intended for testing
Return values
vB_ApiinstanceInternal()
Returns an instance of the API object which doesn't handle exceptions This should only be used in other API objects, not for clients of the API
public
static instanceInternal(string $controller[, bool $refresh_cache = false ]) : vB_Api
Parameters
- $controller : string
-
-- name of the API controller to load
- $refresh_cache : bool = false
-
-- true if we want to force the cache to update with a new api object primarily intended for testing
Return values
vB_Apimap_vb4_input_to_vb5()
Returns vb5 api method name.
public
static map_vb4_input_to_vb5(string $method, array<string|int, mixed> &$request) : string
May alter request array.
Parameters
- $method : string
-
-- vb4 method name
- $request : array<string|int, mixed>
-
-- $_REQUEST array for this api request
Return values
stringmap_vb5_errors_to_vb4()
Alters the error array in any way necessary to interface correctly with vb4.
public
static map_vb5_errors_to_vb4(string $method, array<string|int, mixed> &$data) : mixed
Parameters
- $method : string
-
-- vb4 method name
- $data : array<string|int, mixed>
-
-- error array from vb5
map_vb5_output_to_vb4()
Alters the output array in any way necessary to interface correctly with vb4.
public
static map_vb5_output_to_vb4(string $method, array<string|int, mixed> &$data) : mixed
Parameters
- $method : string
-
-- vb4 method name
- $data : array<string|int, mixed>
-
-- output array from vb5