class vB_Api_Route extends vB_Api

vB_Api_Route

Traits

Properties

protected bool $disabled Indicates whether the API was disabled from vB_Api
protected $disableWhiteList
protected array $disableFalseReturnOnly Contains white listed methods which return a false response when API is disabled in special scenarios like forum closed, password expiry, ip ban and others. from vB_Api
protected string $controller API Controller from vB_Api
protected vB_Database $db Database object. from vB_Api
protected $whitelistPrefix
protected $whitelistRoute

Methods

__sleep()

No description

__wakeup()

No description

static 
getApiClassName($controller)

No description

from vB_Api
static 
getApiClassNameInternal($controller)

No description

from vB_Api
static 
getApiClass($controller, $errorCheck = true)

No description

from vB_Api
static vB_Api
instanceInternal(string $controller, bool $refresh_cache = false)

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

from vB_Api
static vB_Api
instance(string $controller, bool $refresh_cache = false)

Returns an instance of the API object which translates exceptions to an array Use this method for API clients.

from vB_Api
static 
clearCache()

Clears all previously loaded API objects.

from vB_Api
The
callNamed()

Call the given api function by name with a named arguments list.

from vB_Api
static string
map_vb4_input_to_vb5(string $method, array $request)

Returns vb5 api method name.

from vB_Api
static 
map_vb5_output_to_vb4(string $method, array $data)

Alters the output array in any way necessary to interface correctly with vb4.

from vB_Api
static 
map_vb5_errors_to_vb4(string $method, array $data)

Alters the error array in any way necessary to interface correctly with vb4.

from vB_Api
__construct()

No description

checkApiState($method)

This method checks whether the API method is enabled.

from vB_Api
bool
isWhiteListed(string $method)

Checks if method is white listed when API is disabled.

from vB_Api
bool
isDisableFalseReturnOnly(string $method)

Checks if method returns false response only when API is disabled.

from vB_Api
toSeoFriendly(string $str)

Replaces special characters in a given string with dashes to make the string SEO friendly

from vB_Api
none
checkHasAdminPermission(string $adminPermission)

Determines if the calling user has the given admin permission, and if not throws an exception

from vB_Api
boolean
hasAdminPermission(string $adminPermission)

Determines if the calling user has the given admin permission

from vB_Api
checkIsLoggedIn()

Determines if the calling user has the given admin permission, and if not throws an exception

from vB_Api
setController(string $controller)

Set controller

from vB_Api
inDebugMode()

No description

from vB_Api
GetSpecialRoutes()

No description

array
fetchAll()

Returns the array of routes for the application

vB_Frontend_Route
getRoute($pathInfo, $queryString, $anchor = '')

Returns a matching route if available for $pathInfo

getRouteByIdent($ident)

No description

handleRouteExceptions(Exception $ex)

No description

int
getChannelConversationRoute(int $channelId)

Returns the route id for the generic conversation route

string
getAbsoluteNodeUrl(int $nodeid, array $data = array(), array $extra = array())

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

string
getNodeUrl(int $nodeid, array $data = array(), array $extra = array())

Get URL of a node

string
getUrl(mixed $route, array $data = array(), array $extra = array(), array $anchor = '')

Returns one URL

array
getUrls(array $URLInfoList)

get the urls in one batch

string
getHash(mixed $route, array $data, array $extra)

get a unique hash

mixed
createRoute(string $class, array $data)

Saves a new route

preloadRoutes(mixed $routeIds)

Preloads a list of routes to reduce database traffic

mixed
fetchLegacyPostUrl(int $postId)

Returns the URL for the legacy postid

mixed
fetchLegacyThreadUrl(int $threadId)

Returns the URL for the legacy threadid

Details

in vB_Trait_NoSerialize at line 15
__sleep()

in vB_Trait_NoSerialize at line 20
__wakeup()

in vB_Api at line 63
static getApiClassName($controller)

Parameters

$controller

in vB_Api at line 69
static protected getApiClassNameInternal($controller)

Parameters

$controller

in vB_Api at line 97
static protected getApiClass($controller, $errorCheck = true)

Parameters

$controller
$errorCheck

in vB_Api at line 177
static vB_Api instanceInternal(string $controller, bool $refresh_cache = false)

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

Parameters

string $controller -- name of the API controller to load
bool $refresh_cache -- true if we want to force the cache to update with a new api object primarily intended for testing

Return Value

vB_Api

in vB_Api at line 203
static vB_Api instance(string $controller, bool $refresh_cache = false)

Returns an instance of the API object which translates exceptions to an array Use this method for API clients.

Parameters

string $controller -- name of the API controller to load
bool $refresh_cache -- true if we want to force the cache to update with a new api object primarily intended for testing

Return Value

vB_Api

in vB_Api at line 237
static clearCache()

Clears all previously loaded API objects.

Intended for use in tests where the loading pattern can cause issues with objects that cache thier own data.

in vB_Api at line 259
The callNamed()

Call the given api function by name with a named arguments list.

Used primarily to translate REST requests into API calls.

Return Value

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.

in vB_Api at line 313
static string map_vb4_input_to_vb5(string $method, array $request)

Returns vb5 api method name.

May alter request array.

Parameters

string $method -- vb4 method name
array $request -- $_REQUEST array for this api request

Return Value

string

in vB_Api at line 497
static map_vb5_output_to_vb4(string $method, array $data)

Alters the output array in any way necessary to interface correctly with vb4.

Parameters

string $method -- vb4 method name
array $data -- output array from vb5

in vB_Api at line 545
static map_vb5_errors_to_vb4(string $method, array $data)

Alters the error array in any way necessary to interface correctly with vb4.

Parameters

string $method -- vb4 method name
array $data -- error array from vb5

at line 29
protected __construct()

in vB_Api at line 631
checkApiState($method)

This method checks whether the API method is enabled.

For extensions check make sure $controller property is already set.

Parameters

$method

in vB_Api at line 657
protected bool isWhiteListed(string $method)

Checks if method is white listed when API is disabled.

Parameters

string $method API method to check.

Return Value

bool Indicates whether method is or is not a white list.

in vB_Api at line 685
protected bool isDisableFalseReturnOnly(string $method)

Checks if method returns false response only when API is disabled.

Parameters

string $method API method to check.

Return Value

bool Indicates whether method returns false response only.

in vB_Api at line 712
protected toSeoFriendly(string $str)

Replaces special characters in a given string with dashes to make the string SEO friendly

Parameters

string $str The string to be converted

in vB_Api at line 734
protected none checkHasAdminPermission(string $adminPermission)

Determines if the calling user has the given admin permission, and if not throws an exception

Checks for: * A valid CP Session * The passed adminpermission.

Parameters

string $adminPermission The admin permission to check

Return Value

none

Exceptions

inlinemodauth_required -- The current session is not a mod/admin session
nopermission_loggedin -- The user does not have the given permission
no_permission -- The user is not logged in at all.

in vB_Api at line 753
protected boolean hasAdminPermission(string $adminPermission)

Determines if the calling user has the given admin permission

Useful if you need to know if the calling user but do not care why they do not have that permission. Generally useful if there is a behavior difference between admins and non admins, but the call can be processed for either.

Parameters

string $adminPermission The admin permission to check

Return Value

boolean true if checks pass, false otherwise

in vB_Api at line 807
protected checkIsLoggedIn()

Determines if the calling user has the given admin permission, and if not throws an exception

in vB_Api at line 821
protected setController(string $controller)

Set controller

Parameters

string $controller Controller name

in vB_Api at line 831
protected inDebugMode()

at line 38
GetSpecialRoutes()

at line 54
array fetchAll()

Returns the array of routes for the application

Return Value

array The routes

at line 92
vB_Frontend_Route getRoute($pathInfo, $queryString, $anchor = '')

Returns a matching route if available for $pathInfo

Parameters

$pathInfo
$queryString
$anchor

Return Value

vB_Frontend_Route

at line 369
getRouteByIdent($ident)

Parameters

$ident

at line 395
protected handleRouteExceptions(Exception $ex)

Parameters

Exception $ex

at line 430
int getChannelConversationRoute(int $channelId)

Returns the route id for the generic conversation route

Parameters

int $channelId

Return Value

int

at line 456
string getAbsoluteNodeUrl(int $nodeid, array $data = array(), array $extra = array())

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

Parameters

int $nodeid Node ID
array $data Additional route data for the node
array $extra Extra data for the route

Return Value

string Node's URL

at line 473
string getNodeUrl(int $nodeid, array $data = array(), array $extra = array())

Get URL of a node

Parameters

int $nodeid Node ID
array $data Additional route data for the node
array $extra Extra data for the route

Return Value

string Node's URL

at line 491
string getUrl(mixed $route, array $data = array(), array $extra = array(), array $anchor = '')

Returns one URL

Parameters

mixed $route
array $data
array $extra
array $anchor

Return Value

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

at line 501
array getUrls(array $URLInfoList)

get the urls in one batch

Parameters

array $URLInfoList has to contain the route, data and extra

Return Value

array URLs built based on the input

at line 512
string getHash(mixed $route, array $data, array $extra)

get a unique hash

Parameters

mixed $route
array $data
array $extra

Return Value

string

at line 525
mixed createRoute(string $class, array $data)

Saves a new route

Parameters

string $class Route class name
array $data Route data

Return Value

mixed The routeid will be returned

at line 536
preloadRoutes(mixed $routeIds)

Preloads a list of routes to reduce database traffic

Parameters

mixed $routeIds array of route ids- can be integers or strings.

at line 546
mixed fetchLegacyPostUrl(int $postId)

Returns the URL for the legacy postid

Parameters

int $postId

Return Value

mixed

at line 568
mixed fetchLegacyThreadUrl(int $threadId)

Returns the URL for the legacy threadid

Parameters

int $threadId

Return Value

mixed