vB_Api_Options
extends vB_Api
in package
vB_Api_Options
Tags
Table of Contents
- $controller : string
- API Controller
- $db : vB_Database
- Database object.
- $disabled : bool
- Indicates whether the API was disabled
- $disableFalseReturnOnly : array<string|int, mixed>
- 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.
- $disableWhiteList : array<string|int, mixed>
- Contains white listed methods which act as normal when API is disabled no matter of special scenarios like forum closed, password expiry, ip ban and others.
- $instances : mixed
- $instancesRaw : array<string|int, mixed>
- We want API subclasses to access the instances only through getters
- $library : mixed
- $vb4_input_mappings : mixed
- $wrappers : mixed
- __serialize() : mixed
- __sleep() : mixed
- __unserialize() : mixed
- __wakeup() : mixed
- addGroupSettings() : array<string|int, mixed>
- Insert group settings
- callNamed() : The
- Call the given api function by name with a named arguments list.
- changeSearchType() : mixed
- This function changes the search type for settings
- checkApiState() : mixed
- This method checks whether the API method is enabled.
- clearCache() : mixed
- Clears all previously loaded API objects.
- deleteGroupSettings() : mixed
- Delete group of settings
- deleteLocation() : mixed
- fetch() : array<string|int, mixed>
- This function returns the options data from the specified option groups, in a multi dimensional array having the group name as key and the options as values.
- fetchStatic() : array<string|int, mixed>
- Returns the requested vBulletin options as specified by the $options parameter.
- fetchValues() : array<string|int, mixed>
- Fetch option values
- getApiClassName() : mixed
- getCountryCodes() : mixed
- getGroupSettingsXML() : array<string|int, mixed>
- This function gets a product or set vbulletin as default and prints the XML file for it's options.
- getLocation() : mixed
- getLocationList() : mixed
- getRegionCodes() : mixed
- getSettingsXML() : array<string|int, mixed>
- This function gets the settings for given product or vbulletin if not specified
- importSettingsXML() : array<string|int, mixed>
- This function gets the settings for given product or vbulletin if not specified
- insertSetting() : array<string|int, mixed>
- This function inserts a Settings value
- 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
- isLocationOptionSet() : mixed
- killSetting() : array<string|int, mixed>
- This function deletes specified settings
- 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.
- saveLocation() : mixed
- updateAttachPath() : mixed
- This updates the attachpath value in datastore settings
- updateAttachSetting() : mixed
- This updates the attachpath value in datastore settings
- updateGroupSettings() : mixed
- This function updates group settings.
- updateSetting() : mixed
- This function updates specified settings
- updateValue() : mixed
- This updates a value in datastore settings
- validateSettings() : mixed
- This function changes the search type for settings
- __construct() : mixed
- checkHasAdminPermission() : none
- Determines if the calling user has the given admin permission, and if not throws an exception
- checkHasPermission() : none
- Determines if the calling user has the given bitfield permission, and if not, throws a 'no_permission' exception.
- checkIsLoggedIn() : mixed
- Determines if the calling user has the given admin permission, and if not throws an exception
- getApiClass() : mixed
- getApiClassNameInternal() : mixed
- hasAdminPermission() : bool
- Determines if the calling user has the given admin permission
- inDebugMode() : mixed
- isDisableFalseReturnOnly() : bool
- Checks if method returns false response only when API is disabled.
- isWhiteListed() : bool
- Checks if method is white listed when API is disabled.
- setController() : mixed
- Set controller
- cms_vb4_to_vb5_method_mapping() : mixed
- default_vb4_to_vb5_method_mapping() : mixed
- hasAdminPermissionInternal() : mixed
- Internal function to power the previous cover functions
- remove_nulls() : mixed
- wrapLoggerIfNeeded() : mixed
- Wrap the api object with the log wrapper class if needed.
Properties
$controller
API Controller
protected
string
$controller
$db
Database object.
protected
vB_Database
$db
$disabled
Indicates whether the API was disabled
protected
bool
$disabled
= alse
$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.
protected
array<string|int, mixed>
$disableFalseReturnOnly
= array()
$disableWhiteList
Contains white listed methods which act as normal when API is disabled no matter of special scenarios like forum closed, password expiry, ip ban and others.
protected
array<string|int, mixed>
$disableWhiteList
= array('fetch', 'fetchValues')
$instances
private
static mixed
$instances
$instancesRaw
We want API subclasses to access the instances only through getters
private
static array<string|int, mixed>
$instancesRaw
$library
private
mixed
$library
$vb4_input_mappings
private
static mixed
$vb4_input_mappings
= array(
'blog.post_comment' => array('method' => 'vb4_blog.post_comment'),
'blog.post_postcomment' => array('method' => 'vb4_blog.post_postcomment'),
'blog.post_updateblog' => array('method' => 'vb4_blog.post_updateblog'),
'blog.post_newblog' => array('method' => 'vb4_blog.post_newblog'),
'blog.post_editblog' => array('method' => 'vb4_blog.post_editblog'),
'blog_list' => array('method' => 'vb4_blog.bloglist'),
'api_init' => array('method' => 'api.init'),
'api_cmssectionlist' => array('method' => 'Vb4_Cms.sectionlist'),
'api_cmscategorylist' => array('method' => 'Vb4_Cms.categorylist'),
/*
// These can no longer be mapped directly to vB_Api_User::login/logout
// due to additional processing of devicetoken that may be required
// for mapi calls.
'login_login' => array(
'method' => 'user.login',
'request_mappings' => array(
'vb_login_username' => 'username',
'vb_login_password' => 'password',
'vb_login_md5password' => 'md5password',
'vb_login_md5password_utf' => 'md5passwordutf'
)
),
'login_logout' => array(
'method' => 'user.logout'
),
*/
'get_vbfromfacebook' => array('method' => 'vb4_facebook.getVbfromfacebook'),
)
$wrappers
private
static mixed
$wrappers
Methods
__serialize()
public
__serialize() : mixed
Return values
mixed —__sleep()
public
__sleep() : mixed
Return values
mixed —__unserialize()
public
__unserialize(mixed $serialized) : mixed
Parameters
- $serialized : mixed
Return values
mixed —__wakeup()
public
__wakeup() : mixed
Return values
mixed —addGroupSettings()
Insert group settings
public
addGroupSettings(array<string|int, mixed> $group) : array<string|int, mixed>
Parameters
- $group : array<string|int, mixed>
-
( [grouptitle] , [title] , [product] , [displayorder] , [volatile] )
Return values
array<string|int, mixed> —response
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.
changeSearchType()
This function changes the search type for settings
public
changeSearchType(string $implementation, string $options) : mixed
Parameters
- $implementation : string
- $options : string
Return values
mixed —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
Return values
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.
Return values
mixed —deleteGroupSettings()
Delete group of settings
public
deleteGroupSettings(string $groupTitle) : mixed
Parameters
- $groupTitle : string
Return values
mixed —response
deleteLocation()
public
deleteLocation(mixed $locationid) : mixed
Parameters
- $locationid : mixed
Return values
mixed —fetch()
This function returns the options data from the specified option groups, in a multi dimensional array having the group name as key and the options as values.
public
fetch([array<string|int, mixed> $options = null ]) : array<string|int, mixed>
This function is misnamed and/or placed in the wrong API class. It acually returns any of the DATASTORE items, ONE of which is the vBulletin Options array.
Parameters
- $options : array<string|int, mixed> = null
-
The array of the DATASTORE items that you want to return. If empty, it will return all allowed items. Currently allowed entries are -- options (or publicoptions either will return the publicoptions values with the key 'options' -- miscoptions all other values will be ignored.
Return values
array<string|int, mixed> —fetchStatic()
Returns the requested vBulletin options as specified by the $options parameter.
public
static fetchStatic([mixed $options = null ]) : array<string|int, mixed>
Only returns public options. If a private option is requested, the returned value for it will be null.
Parameters
- $options : mixed = null
Return values
array<string|int, mixed> —Array of $option name => $value
fetchValues()
Fetch option values
public
fetchValues(array<string|int, mixed> $options) : array<string|int, mixed>
Parameters
- $options : array<string|int, mixed>
-
An array of option names to be fetched
Return values
array<string|int, mixed> —Options' values
getApiClassName()
public
static getApiClassName(mixed $controller) : mixed
Parameters
- $controller : mixed
Return values
mixed —getCountryCodes()
public
getCountryCodes() : mixed
Return values
mixed —getGroupSettingsXML()
This function gets a product or set vbulletin as default and prints the XML file for it's options.
public
getGroupSettingsXML(bool $ignore_blacklist[, string $product = 'vbulletin' ]) : array<string|int, mixed>
.
Parameters
- $ignore_blacklist : bool
-
-- ignore the settings with blacklist =1
- $product : string = 'vbulletin'
Return values
array<string|int, mixed> —response
getLocation()
public
getLocation(mixed $locationid) : mixed
Parameters
- $locationid : mixed
Return values
mixed —getLocationList()
public
getLocationList() : mixed
Return values
mixed —getRegionCodes()
public
getRegionCodes(mixed $countrycode) : mixed
Parameters
- $countrycode : mixed
Return values
mixed —getSettingsXML()
This function gets the settings for given product or vbulletin if not specified
public
getSettingsXML([string $product = 'vbulletin' ]) : array<string|int, mixed>
Parameters
- $product : string = 'vbulletin'
Return values
array<string|int, mixed> —importSettingsXML()
This function gets the settings for given product or vbulletin if not specified
public
importSettingsXML(string $settingsFile, string $serverFile, string $restore, bool $blacklist) : array<string|int, mixed>
Parameters
- $settingsFile : string
-
url
- $serverFile : string
-
url
- $restore : string
- $blacklist : bool
Return values
array<string|int, mixed> —insertSetting()
This function inserts a Settings value
public
insertSetting(array<string|int, mixed> $setting) : array<string|int, mixed>
Parameters
- $setting : array<string|int, mixed>
-
( varname, defaultvalue, product, volatile, title, description, username )
Return values
array<string|int, mixed> —$response
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 —isLocationOptionSet()
public
isLocationOptionSet(mixed $optionname) : mixed
Parameters
- $optionname : mixed
Return values
mixed —killSetting()
This function deletes specified settings
public
killSetting(mixed $varname) : array<string|int, mixed>
Parameters
- $varname : mixed
Return values
array<string|int, mixed> —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
Return values
mixed —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
Return values
mixed —saveLocation()
public
saveLocation(mixed $data) : mixed
Parameters
- $data : mixed
Return values
mixed —updateAttachPath()
This updates the attachpath value in datastore settings
public
updateAttachPath(mixed $value) : mixed
@param mixed the settings value
Parameters
- $value : mixed
Return values
mixed —updateAttachSetting()
This updates the attachpath value in datastore settings
public
updateAttachSetting(mixed $value) : mixed
@param mixed the settings value
Parameters
- $value : mixed
Return values
mixed —updateGroupSettings()
This function updates group settings.
public
updateGroupSettings(array<string|int, mixed> $group, mixed $username[, mixed $oldproduct = '' ][, mixed $adminperm = false ]) : mixed
Parameters
- $group : array<string|int, mixed>
-
Group values
- $username : mixed
- $oldproduct : mixed = ''
- $adminperm : mixed = false
Return values
mixed —updateSetting()
This function updates specified settings
public
updateSetting(array<string|int, mixed> $values) : mixed
Parameters
- $values : array<string|int, mixed>
-
'varname' => $vbulletin->GPC['varname'], 'grouptitle' => $vbulletin->GPC['grouptitle'], 'optioncode' => $vbulletin->GPC['optioncode'], 'defaultvalue' => $vbulletin->GPC['defaultvalue'], 'displayorder' => $vbulletin->GPC['displayorder'], 'volatile' => $vbulletin->GPC['volatile'], 'datatype' => $vbulletin->GPC['datatype'], 'validationcode' => $vbulletin->GPC['validationcode'], 'product' => $vbulletin->GPC['product'], 'blacklist' => $vbulletin->GPC['blacklist'], 'title' => $vbulletin->GPC['title'], 'username' => $vbulletin->userinfo['username'], 'description' => $vbulletin->GPC['description']
Return values
mixed —updateValue()
This updates a value in datastore settings
public
updateValue(mixed $varname, mixed $value[, mixed $rebuild = true ]) : mixed
Parameters
- $varname : mixed
- $value : mixed
- $rebuild : mixed = true
Return values
mixed —validateSettings()
This function changes the search type for settings
public
validateSettings(string $varname, array<string|int, mixed> $setting) : mixed
Parameters
- $varname : string
- $setting : array<string|int, mixed>
Return values
mixed —__construct()
protected
__construct() : mixed
Return values
mixed —checkHasAdminPermission()
Determines if the calling user has the given admin permission, and if not throws an exception
protected
checkHasAdminPermission(string|array<string|int, mixed> $adminPermission) : none
Checks for:
- A valid CP Session
- The passed adminpermission.
Parameters
- $adminPermission : string|array<string|int, mixed>
-
The admin permission to check. If an array then the check passes if the user has any of the permissions given.
Tags
Return values
none —checkHasPermission()
Determines if the calling user has the given bitfield permission, and if not, throws a 'no_permission' exception.
protected
checkHasPermission(string $group, string $permission) : none
Parameters
- $group : string
-
The permission group where the permission is located
- $permission : string
-
The permission to check
Tags
Return values
none —checkIsLoggedIn()
Determines if the calling user has the given admin permission, and if not throws an exception
protected
checkIsLoggedIn() : mixed
Return values
mixed —getApiClass()
protected
static getApiClass(mixed $controller[, mixed $errorCheck = true ]) : mixed
Parameters
- $controller : mixed
- $errorCheck : mixed = true
Return values
mixed —getApiClassNameInternal()
protected
static getApiClassNameInternal(mixed $controller) : mixed
Parameters
- $controller : mixed
Return values
mixed —hasAdminPermission()
Determines if the calling user has the given admin permission
protected
hasAdminPermission(string|array<string|int, mixed> $adminPermission) : bool
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
- $adminPermission : string|array<string|int, mixed>
-
The admin permission to check. If an array then the check passes if the user has any of the permissions given.
Return values
bool —true if checks pass, false otherwise
inDebugMode()
protected
inDebugMode() : mixed
Return values
mixed —isDisableFalseReturnOnly()
Checks if method returns false response only when API is disabled.
protected
isDisableFalseReturnOnly(mixed $method) : bool
Parameters
- $method : mixed
Return values
bool —Indicates whether method returns false response only.
isWhiteListed()
Checks if method is white listed when API is disabled.
protected
isWhiteListed(mixed $method) : bool
Parameters
- $method : mixed
Return values
bool —Indicates whether method is or is not a white list.
setController()
Set controller
protected
setController(mixed $controller) : mixed
Parameters
- $controller : mixed
Return values
mixed —cms_vb4_to_vb5_method_mapping()
private
static cms_vb4_to_vb5_method_mapping(mixed $method, mixed &$request) : mixed
Parameters
- $method : mixed
- $request : mixed
Return values
mixed —default_vb4_to_vb5_method_mapping()
private
static default_vb4_to_vb5_method_mapping(mixed $method) : mixed
Parameters
- $method : mixed
Return values
mixed —hasAdminPermissionInternal()
Internal function to power the previous cover functions
private
hasAdminPermissionInternal(mixed $adminPermission) : mixed
@param string|array $adminPermission The admin permission to check. If an array
then the check passes if the user has any of the permissions given.
Parameters
- $adminPermission : mixed
Return values
mixed —remove_nulls()
private
static remove_nulls(mixed &$data) : mixed
Parameters
- $data : mixed
Return values
mixed —wrapLoggerIfNeeded()
Wrap the api object with the log wrapper class if needed.
private
static wrapLoggerIfNeeded(mixed $controller, mixed $api_object) : mixed
Parameters
- $controller : mixed
- $api_object : mixed