vBulletin v6.0.4

vB_Api_Hv extends vB_Api
in package

vB_Api_Hv vBulletin Human Verification API

Tags
access

public

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.
fetchHvImage()  : array<string|int, mixed>
Fetch Human Verification Image Data
fetchHvQuestion()  : string|bool
Fetch Human Verification Question Data
fetchHvType()  : string
Fetch Current Hv Type Possible Values: - Image - Question - Recaptcha - Disabled
fetchRequireHvcheck()  : bool
Returns whether or not the user requires a human verification test to complete the specified action
generateToken()  : array<string|int, mixed>
Generate a HV token
getApiClassName()  : mixed
getRecaptchaLanguage()  : array<string|int, mixed>
The recaptcha languages codes don't map perfectly to what vBulletin has. This translates from the user lang code to what recaptcha expects.
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.
verifyToken()  : bool
Verify a HV token and its answer

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>

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.

fetchHvImage()

Fetch Human Verification Image Data

public fetchHvImage([ $hash = '' ]) : array<string|int, mixed>
Parameters
$hash : = ''
Return values
array<string|int, mixed> —

'type' => Image type 'data' => Image binary data

fetchHvQuestion()

Fetch Human Verification Question Data

public fetchHvQuestion([ $hash = '' ]) : string|bool
Parameters
$hash : = ''
Return values
string|bool —

Question or false if we failed to generate a question on init

fetchHvType()

Fetch Current Hv Type Possible Values: - Image - Question - Recaptcha - Disabled

public fetchHvType() : string
Return values
string —

Hv Type

fetchRequireHvcheck()

Returns whether or not the user requires a human verification test to complete the specified action

public fetchRequireHvcheck(string $action) : bool
Parameters
$action : string

The name of the action to check. Possible values: register, post, search, contactus, lostpw

Return values
bool —

Whether a hv check is required

generateToken()

Generate a HV token

public generateToken() : array<string|int, mixed>
Return values
array<string|int, mixed> —

It contains one item: hash - Token hash In unit tests, it may also include a second item answer - The correct answer

getApiClassName()

public static getApiClassName(mixed $controller) : mixed
Parameters
$controller : mixed

getRecaptchaLanguage()

The recaptcha languages codes don't map perfectly to what vBulletin has. This translates from the user lang code to what recaptcha expects.

public getRecaptchaLanguage() : array<string|int, mixed>
Return values
array<string|int, mixed> —

'langcode' => the recaptch language code

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

verifyToken()

Verify a HV token and its answer

public verifyToken(mixed $input, string $action[, bool $return = false ]) : bool
Parameters
$input : mixed

HV answer user input ('input') and other data (for example, 'hash')

$action : string

The name of the action to check. register, lostpw etc.

$return : bool = false

Whether to return a bool value instead of throwing an Exception.

Tags
throws
vB_Exception_Api
Return values
bool —

Whether the input answer/hash is correct


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results