vBulletin v6.0.4

vB_Api_Route extends vB_Api
in package

vB_Api_Route

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.
fetchLegacyPostUrl()  : mixed
Returns the URL for the legacy postid
fetchLegacyThreadUrl()  : mixed
Returns the URL for the legacy threadid
getAbsoluteNodeUrl()  : string
Get fullURL of a node. It appends frontendurl to the relative node route.
getApiClassName()  : mixed
getChannelConversationRoute()  : int
Returns the route id for the generic conversation route
getHash()  : string
get a unique hash
getNodeUrl()  : string
Get URL of a node
getRoute()  : vB_Frontend_Route
Returns a matching route if available for $pathInfo
getRouteByIdent()  : mixed
getUrl()  : string
Returns one URL
getUrls()  : array<string|int, mixed>
get the urls in one batch
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.
preloadRoutes()  : mixed
Preloads a list of routes to reduce database traffic
setAsHomeRoute()  : mixed
Sets a route as the home page route. Note, this is currently only for use in the "Quick Setup" Sitebuilder Panel's home page switching tool (to switch between the 3 default homepages).

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.

fetchLegacyPostUrl()

Returns the URL for the legacy postid

public fetchLegacyPostUrl(int $postId) : mixed
Parameters
$postId : int

fetchLegacyThreadUrl()

Returns the URL for the legacy threadid

public fetchLegacyThreadUrl(int $threadId) : mixed
Parameters
$threadId : int

getAbsoluteNodeUrl()

Get fullURL of a node. It appends frontendurl to the relative node route.

public getAbsoluteNodeUrl(int $nodeid[, array<string|int, mixed> $data = array() ][, array<string|int, mixed> $extra = array() ]) : string
Parameters
$nodeid : int

Node ID

$data : array<string|int, mixed> = array()

Additional route data for the node

$extra : array<string|int, mixed> = array()

Extra data for the route

Return values
string —

Node's URL

getApiClassName()

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

getChannelConversationRoute()

Returns the route id for the generic conversation route

public getChannelConversationRoute(int $channelId) : int
Parameters
$channelId : int
Return values
int

getHash()

get a unique hash

public getHash(mixed $route, array<string|int, mixed> $data, array<string|int, mixed> $extra) : string
Parameters
$route : mixed
$data : array<string|int, mixed>
$extra : array<string|int, mixed>
Return values
string

getNodeUrl()

Get URL of a node

public getNodeUrl(int $nodeid[, array<string|int, mixed> $data = array() ][, array<string|int, mixed> $extra = array() ]) : string
Parameters
$nodeid : int

Node ID

$data : array<string|int, mixed> = array()

Additional route data for the node

$extra : array<string|int, mixed> = array()

Extra data for the route

Return values
string —

Node's URL

getRoute()

Returns a matching route if available for $pathInfo

public getRoute(string $pathInfo, string $queryString[, mixed $anchor = '' ]) : vB_Frontend_Route
Parameters
$pathInfo : string
$queryString : string
$anchor : mixed = ''
Return values
vB_Frontend_Route

getRouteByIdent()

public getRouteByIdent(mixed $ident) : mixed
Parameters
$ident : mixed

getUrl()

Returns one URL

public getUrl(mixed $route[, array<string|int, mixed> $data = array() ][, array<string|int, mixed> $extra = array() ][, array<string|int, mixed> $anchor = '' ]) : string
Parameters
$route : mixed
$data : array<string|int, mixed> = array()
$extra : array<string|int, mixed> = array()
$anchor : array<string|int, mixed> = ''
Return values
string —

Always in UTF-8. If vB_String::getCharset() is not utf-8, it's percent encoded.

getUrls()

get the urls in one batch

public getUrls(array<string|int, mixed> $URLInfoList) : array<string|int, mixed>
Parameters
$URLInfoList : array<string|int, mixed>

has to contain the route, data and extra

Return values
array<string|int, mixed> —

URLs built based on the input

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

preloadRoutes()

Preloads a list of routes to reduce database traffic

public preloadRoutes(mixed $routeIds) : mixed
Parameters
$routeIds : mixed

setAsHomeRoute()

Sets a route as the home page route. Note, this is currently only for use in the "Quick Setup" Sitebuilder Panel's home page switching tool (to switch between the 3 default homepages).

public setAsHomeRoute(mixed $routeid) : mixed
Parameters
$routeid : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results