vBulletin v6.0.4

vB_Api_Vb4_inlinemod extends vB_Api
in package

vB_Api_Vb4_inlinemod

Tags
access

public

Table of Contents

Methods

__serialize()  : array<string|int, mixed>
__sleep()  : array<string|int, mixed>
__unserialize()  : void
__wakeup()  : void
approveattachments()  : mixed
approveposts()  : mixed
approvethread()  : 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.
close()  : mixed
docopyposts()  : mixed
dodeleteposts()  : mixed
dodeletespam()  : mixed
dodeletethreads()  : mixed
domoveposts()  : mixed
domovethreads()  : mixed
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.
open()  : mixed
spamthread()  : mixed
stick()  : mixed
unapproveattachments()  : mixed
unapproveposts()  : mixed
unapprovethread()  : mixed
undeleteposts()  : mixed
undeletethread()  : mixed
unstick()  : mixed

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>

approveattachments()

public approveattachments(mixed $plist) : mixed
Parameters
$plist : mixed

approveposts()

public approveposts(mixed $plist) : mixed
Parameters
$plist : mixed

approvethread()

public approvethread(mixed $tlist) : mixed
Parameters
$tlist : 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.

close()

public close(mixed $tlist) : mixed
Parameters
$tlist : mixed

docopyposts()

public docopyposts(mixed $postids, mixed $destforumid, mixed $title) : mixed
Parameters
$postids : mixed
$destforumid : mixed
$title : mixed

dodeleteposts()

public dodeleteposts(mixed $postids, mixed $deletetype[, mixed $deletereason = null ]) : mixed
Parameters
$postids : mixed
$deletetype : mixed
$deletereason : mixed = null

dodeletespam()

public dodeletespam(mixed $threadids, mixed $deletetype) : mixed
Parameters
$threadids : mixed
$deletetype : mixed

dodeletethreads()

public dodeletethreads(mixed $threadids, mixed $deletetype[, mixed $deletereason = null ]) : mixed
Parameters
$threadids : mixed
$deletetype : mixed
$deletereason : mixed = null

domoveposts()

public domoveposts(mixed $postids, mixed $destforumid[, mixed $title = "" ]) : mixed
Parameters
$postids : mixed
$destforumid : mixed
$title : mixed = ""

domovethreads()

public domovethreads(mixed $threadids, mixed $destforumid) : mixed
Parameters
$threadids : mixed
$destforumid : mixed

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

open()

public open(mixed $tlist) : mixed
Parameters
$tlist : mixed

spamthread()

public spamthread(mixed $tlist) : mixed
Parameters
$tlist : mixed

stick()

public stick(mixed $tlist) : mixed
Parameters
$tlist : mixed

unapproveattachments()

public unapproveattachments(mixed $plist) : mixed
Parameters
$plist : mixed

unapproveposts()

public unapproveposts(mixed $plist) : mixed
Parameters
$plist : mixed

unapprovethread()

public unapprovethread(mixed $tlist) : mixed
Parameters
$tlist : mixed

undeleteposts()

public undeleteposts(mixed $plist) : mixed
Parameters
$plist : mixed

undeletethread()

public undeletethread(mixed $tlist) : mixed
Parameters
$tlist : mixed

unstick()

public unstick(mixed $tlist) : mixed
Parameters
$tlist : mixed

        
On this page

Search results