vB_Api_Vb4_register
extends vB_Api
in package
vB_Api_Vb4_register
Tags
Table of Contents
Methods
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- addmember() : mixed
- call() : mixed
- 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.
- checkdate() : mixed
- clearCache() : mixed
- Clears all previously loaded API objects.
- fbconnect() : mixed
- Connect logged in user to facebook account
- fbdisconnect() : mixed
- Disconnect fb account from the logged in user
- getApiClassName() : mixed
- 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.
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
addmember()
public
addmember(mixed $agree, mixed $username, mixed $email, mixed $emailconfirm[, mixed $fbname = null ][, mixed $fbuserid = null ][, mixed $month = null ][, mixed $day = null ][, mixed $year = null ][, mixed $password = null ][, mixed $password_md5 = null ][, mixed $passwordconfirm = null ][, mixed $passwordconfirm_md5 = null ][, mixed $userfield = null ][, mixed $privacyconsent = null ][, mixed $parentemail = null ]) : mixed
Parameters
- $agree : mixed
- $username : mixed
- $email : mixed
- $emailconfirm : mixed
- $fbname : mixed = null
- $fbuserid : mixed = null
- $month : mixed = null
- $day : mixed = null
- $year : mixed = null
- $password : mixed = null
- $password_md5 : mixed = null
- $passwordconfirm : mixed = null
- $passwordconfirm_md5 : mixed = null
- $userfield : mixed = null
- $privacyconsent : mixed = null
- $parentemail : mixed = null
call()
public
call() : 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.
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
checkdate()
public
checkdate(mixed $year, mixed $month, mixed $day) : mixed
Parameters
- $year : mixed
- $month : mixed
- $day : 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.
fbconnect()
Connect logged in user to facebook account
public
fbconnect(mixed $link[, mixed $fbuserid = null ][, mixed $fbname = null ][, mixed $signed_request = null ]) : mixed
Parameters
- $link : mixed
- $fbuserid : mixed = null
- $fbname : mixed = null
- $signed_request : mixed = null
Tags
fbdisconnect()
Disconnect fb account from the logged in user
public
fbdisconnect(mixed $confirm) : mixed
Parameters
- $confirm : mixed
Tags
getApiClassName()
public
static getApiClassName(mixed $controller) : mixed
Parameters
- $controller : 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