vBulletin v6.1.0

vB_Api_Vb4_activity extends vB_Api
in package

vB_Api_Vb4_activity

Tags
access

public

Table of Contents

Constants

FILTER_LASTDAY  = 'today'
FILTER_LASTMONTH  = 'month'
FILTER_LASTWEEK  = 'week'
FILTER_SHOW_BLOG  = 'blog'
FILTER_SHOW_CMS  = 'cms'
FILTER_SHOW_FORUM  = 'forum'
FILTER_SHOW_PHOTOS  = 'photos'
FILTER_SHOW_SOCIALGROUP  = 'socialgroup'
FILTER_SORTBY_POPULAR  = 'popular'
FILTER_SORTBY_RECENT  = 'recent'

Methods

__serialize()  : array<string|int, mixed>
__sleep()  : array<string|int, mixed>
__unserialize()  : void
__wakeup()  : void
call()  : array<string|int, mixed>
Default activity call.
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.
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.

Constants

FILTER_LASTDAY

public mixed FILTER_LASTDAY = 'today'

FILTER_LASTMONTH

public mixed FILTER_LASTMONTH = 'month'

FILTER_LASTWEEK

public mixed FILTER_LASTWEEK = 'week'

FILTER_SHOW_BLOG

public mixed FILTER_SHOW_BLOG = 'blog'

FILTER_SHOW_CMS

public mixed FILTER_SHOW_CMS = 'cms'

FILTER_SHOW_FORUM

public mixed FILTER_SHOW_FORUM = 'forum'

FILTER_SHOW_PHOTOS

public mixed FILTER_SHOW_PHOTOS = 'photos'

FILTER_SHOW_SOCIALGROUP

public mixed FILTER_SHOW_SOCIALGROUP = 'socialgroup'

FILTER_SORTBY_POPULAR

public mixed FILTER_SORTBY_POPULAR = 'popular'

FILTER_SORTBY_RECENT

public mixed FILTER_SORTBY_RECENT = 'recent'

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>

call()

Default activity call.

public call([int $userid = 0 ][, int $mindateline = 0 ][, int $maxdateline = 0 ][, int $minscore = 0 ][, mixed $minid = '' ][, string $maxid = '' ][, string $sortby = '' ][, string $time = '' ][, string $show = '' ][, mixed $pagenumber = 0 ]) : array<string|int, mixed>
Parameters
$userid : int = 0

[userid]

$mindateline : int = 0

[The dateline of the min record currently shown]

$maxdateline : int = 0

[The dateline of the max record currently shown]

$minscore : int = 0

[]

$minid : mixed = ''

[CSV of the ids of the items with mindateline]

$maxid : string = ''

[CSV of the ids of the items with maxdateline]

$sortby : string = ''

[Sorting the results. Possible values see constant with FILTER_SORT_BY_*]

$time : string = ''

[Filtering the results. Possible values see constant with FILTER_*]

$show : string = ''

[Filtering the results by section. Possible values see constant with FILTER_SHOW_*]

$pagenumber : mixed = 0
Return values
array<string|int, mixed> —

[Result structure]

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.

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


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results