vBulletin v6.0.4

vB_Api_Language extends vB_Api
in package

vB_Api_Language

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.
delete()  : standard
Delete a language
export()  : string
Export language as xml
fetchAll()  : array<string|int, mixed>
Fetches either the entire languages array, or a single language If only languageid and title are required, use 'languagecache' in datastore instead.
fetchLanguageSelector()  : array<string|int, mixed>
Simplified version of the fetchAll function,
getApiClassName()  : mixed
getLanguageTitles()  : array<string|int, mixed>
Simplified version of the fetchAll function,
import()  : void
Import a language
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.
rebuild()  : array<string|int, mixed>
Rebuld languages
save()  : int
Insert or update language
setDefault()  : array<string|int, mixed>
Set language as default language

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.

delete()

Delete a language

public delete(int $languageid) : standard
Parameters
$languageid : int

Language ID to be deleted

Return values
standard

success array

export()

Export language as xml

public export(int $languageid[, string $product = 'vbulletin' ][, bool $just_phrases = false ][, bool $custom = false ][, string $charset = 'ISO-8859-1' ]) : string
Parameters
$languageid : int

Language ID to be exported

$product : string = 'vbulletin'

Product ID. Language of which product to be exported.

$just_phrases : bool = false

Whether to Just fetch phrases

$custom : bool = false

Whether to Include Custom Phrases

$charset : string = 'ISO-8859-1'

Export charset

Return values
string

XML data

fetchAll()

Fetches either the entire languages array, or a single language If only languageid and title are required, use 'languagecache' in datastore instead.

public fetchAll([mixed $languageid = 0 ][, mixed $baseonly = false ]) : array<string|int, mixed>
Parameters
$languageid : mixed = 0
$baseonly : mixed = false
Return values
array<string|int, mixed>

fetchLanguageSelector()

Simplified version of the fetchAll function,

public fetchLanguageSelector() : array<string|int, mixed>

Returns languages that are user selectable unless the user has the "canadminlanguages" admin permission in which case we show all languages.

Tags
deprecated

use getLanguageTitles

Return values
array<string|int, mixed>

languages that are user selectable.

getApiClassName()

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

getLanguageTitles()

Simplified version of the fetchAll function,

public getLanguageTitles([mixed $getall = true ]) : array<string|int, mixed>

Returns languages that are user selectable unless the user has the "canadminlanguages" admin permission in which case we show all languages.

Parameters
$getall : mixed = true
Return values
array<string|int, mixed>

languages that are user selectable.

import()

Import a language

public import(string $xml[, int $languageid = 0 ][, string $title = '' ][, bool $anyversion = false ][, mixed $userselect = true ][, mixed $output = true ][, mixed $readcharset = false ]) : void
Parameters
$xml : string

Language xml data

$languageid : int = 0

Language ID to be overwrite. 0 means creating new language

$title : string = ''

Title for Imported Language. Empty means to use the language title specified in the language xml

$anyversion : bool = false

Whether to Ignore Language Version

$userselect : mixed = true
$output : mixed = true
$readcharset : mixed = false

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

rebuild()

Rebuld languages

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

-- standard success array

save()

Insert or update language

public save(array<string|int, mixed> $data[, int $languageid = 0 ]) : int
Parameters
$data : array<string|int, mixed>

Language options to be inserted or updated

$languageid : int = 0

If not 0, the language with the ID will be updated

Return values
int

New language ID or the updated language ID

setDefault()

Set language as default language

public setDefault(int $languageid) : array<string|int, mixed>
Parameters
$languageid : int

Language ID to be set as default

Return values
array<string|int, mixed>

-- standard success array


        
On this page

Search results