vB_Api_Userrank
extends vB_Api
in package
vB_Api_Userrank
Tags
Table of Contents
Methods
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- 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.
- delete() : array<string|int, mixed>
- Delete an user rank
- fetchAll() : array<string|int, mixed>
- Fetch All user ranks
- fetchById() : array<string|int, mixed>
- Fetch Userrank By RankID
- 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.
- save() : int
- Insert a new user rank or update existing user rank
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
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.
delete()
Delete an user rank
public
delete(int $rankid) : array<string|int, mixed>
Parameters
- $rankid : int
-
The ID of user rank to be deleted
Return values
array<string|int, mixed> —-- standard success array
fetchAll()
Fetch All user ranks
public
fetchAll() : array<string|int, mixed>
Return values
array<string|int, mixed> —Array of user ranks
fetchById()
Fetch Userrank By RankID
public
fetchById(int $rankid) : array<string|int, mixed>
Parameters
- $rankid : int
-
Rank ID
Return values
array<string|int, mixed> —User rank information
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
save()
Insert a new user rank or update existing user rank
public
save(array<string|int, mixed> $data[, int $rankid = 0 ]) : int
Parameters
- $data : array<string|int, mixed>
-
User rank data to be inserted or updated 'grouping' => Grouping tag 'priority' => Priority for grouped user ranks 'ranklevel' => Number of times to repeat rank 'usergroupid' => Usergroup 'minposts' => Minimum Posts 'startedtopics' => Minimum Topics 'registrationtime' => Minimum time since registration, in seconds 'reputation' => Minimum Reputation Level 'totallikes' => Minimum Likes from other users 'stack' => Stack Rank. Boolean. 'display' => Display Type. 0 - Always, 1 - If Displaygroup = This Group 'rankimg' => User Rank File Path 'rankhtml' => User Rank HTML Text
- $rankid : int = 0
-
If not 0, it's the ID of the user rank to be updated
Return values
int —New rank's ID or updated rank's ID