vBulletin v6.0.4

vB_Api_Wol extends vB_Api
in package

vB_Api_Wol Who is online API

Table of Contents

Methods

__serialize()  : array<string|int, mixed>
__sleep()  : array<string|int, mixed>
__unserialize()  : void
__wakeup()  : void
buildSpiderList()  : 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.
clearCache()  : mixed
Clears all previously loaded API objects.
fetchAll()  : array<string|int, mixed>
Fetch who is online records
fetchCounts()  : array<string|int, mixed>
Fetch online user counts
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.
refreshUsers()  : mixed
register()  : array<string|int, mixed>
Register an online action Example: vB_Api::instanceInternal('Wol')->register('viewing_x', [['nodeid', $nodeid]]);

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>

buildSpiderList()

public static buildSpiderList() : 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

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.

fetchAll()

Fetch who is online records

public fetchAll([string $pagekey = '' ][, string $who = '' ][, int $pagenumber = 1 ][, int $perpage = 200 ][, string $sortfield = 'time' ][, string $sortorder = 'desc' ][, mixed $resolveIp = false ]) : array<string|int, mixed>
Parameters
$pagekey : string = ''

Fetch users who are only on the page with this pagekey

$who : string = ''

Show 'members', 'guests', 'spiders' or all ('')

$pagenumber : int = 1
$perpage : int = 200
$sortfield : string = 'time'
$sortorder : string = 'desc'
$resolveIp : mixed = false
Return values
array<string|int, mixed> —

Who is online information

fetchCounts()

Fetch online user counts

public fetchCounts([string $pagekey = '' ]) : array<string|int, mixed>
Parameters
$pagekey : string = ''

Fetch users who are only on the page with this pagekey

Return values
array<string|int, mixed> —

total int -- all users members int -- members only guests int => guests only recordusers int -- most users ever maxonlinedate int -- Date the most ever user occurred as timestamp recorddate string -- date as string (deprecated) recordtime string -- time as string (deprecated)

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_Api

instanceInternal()

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_Api

map_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
string

map_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

refreshUsers()

public refreshUsers([mixed $pagekey = '' ][, mixed $who = '' ][, mixed $pagenumber = 1 ][, mixed $perpage = 0 ][, mixed $sortfield = 'time' ][, mixed $sortorder = 'desc' ][, mixed $resolveIp = false ][, mixed $pageRouteId = null ]) : mixed
Parameters
$pagekey : mixed = ''
$who : mixed = ''
$pagenumber : mixed = 1
$perpage : mixed = 0
$sortfield : mixed = 'time'
$sortorder : mixed = 'desc'
$resolveIp : mixed = false
$pageRouteId : mixed = null

register()

Register an online action Example: vB_Api::instanceInternal('Wol')->register('viewing_x', [['nodeid', $nodeid]]);

public register(string $action[, array<string|int, mixed> $params = [] ][, string $pagekey = '' ][, mixed $location = '' ][, int $nodeid = 0 ]) : array<string|int, mixed>
Parameters
$action : string
$params : array<string|int, mixed> = []

Parameters of the action It's an array of parameters that will be used in the phrase The key of a parameter is the index-1 of a phrase brace var The value of a parameter may be a string which will directly replace brance var Other types of id may be added later

$pagekey : string = ''

Pagekey of the page where the user is

$location : mixed = ''
$nodeid : int = 0

Node ID of the node being viewed

Return values
array<string|int, mixed> —

-- standard success array.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results