vBulletin v6.0.4

vB_Api_Options extends vB_Api
in package

vB_Api_Options

Tags
access

public

Table of Contents

Methods

__serialize()  : array<string|int, mixed>
__sleep()  : array<string|int, mixed>
__unserialize()  : void
__wakeup()  : void
addGroupSettings()  : array<string|int, mixed>
Insert group settings
callNamed()  : The
Call the given api function by name with a named arguments list.
changeSearchType()  : array<string|int, 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()  : array<string|int, mixed>
This function updates group settings.
updateSetting()  : array<string|int, mixed>
This function updates specified settings
updateValue()  : mixed
This updates a value in datastore settings
validateSettings()  : array<string|int, mixed>
This function changes the search type for settings

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>

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 = null ]) : array<string|int, mixed>
Parameters
$implementation : string
$options : string = null

Unused.

Return values
array<string|int, mixed> —

response

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.

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

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

getCountryCodes()

public getCountryCodes() : 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

getLocationList()

public getLocationList() : mixed

getRegionCodes()

public getRegionCodes(mixed $countrycode) : mixed
Parameters
$countrycode : 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

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

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

saveLocation()

public saveLocation(mixed $data) : mixed
Parameters
$data : mixed

updateAttachPath()

This updates the attachpath value in datastore settings

public updateAttachPath(mixed $value) : mixed 
@param	mixed	the settings value
Parameters
$value : mixed

updateAttachSetting()

This updates the attachpath value in datastore settings

public updateAttachSetting(mixed $value) : mixed 
@param	mixed	the settings value
Parameters
$value : mixed

updateGroupSettings()

This function updates group settings.

public updateGroupSettings(array<string|int, mixed> $group, mixed $username[, mixed $oldproduct = '' ][, mixed $adminperm = false ]) : array<string|int, mixed>
Parameters
$group : array<string|int, mixed>

Group values

$username : mixed
$oldproduct : mixed = ''
$adminperm : mixed = false
Return values
array<string|int, mixed> —

$response

updateSetting()

This function updates specified settings

public updateSetting(array<string|int, mixed> $values) : array<string|int, 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
array<string|int, mixed> —

$response

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

validateSettings()

This function changes the search type for settings

public validateSettings(string $varname, array<string|int, mixed> $setting) : array<string|int, mixed>
Parameters
$varname : string
$setting : array<string|int, mixed>
Return values
array<string|int, mixed> —

response


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results