vBulletin v6.1.0

vB_Api_Style extends vB_Api
in package

vBApi

vB_Api_Style

Methods

__serialize() : array<string|int, mixed>
__sleep() : array<string|int, mixed>
__unserialize() : void
__wakeup() : void
buildAllStyles() : mixed: Builds all data from the template table into the fields in the style table
callNamed() : The: Call the given api function by name with a named arguments list.
canDeleteStyle() : mixed: Can this style be deleted
checkApiState() : mixed: This method checks whether the API method is enabled.
checkCanImportStyleXML() : array<string|int, mixed>: This is used mostly by the adminCP style importer. This checks if the current user has enough permissions to import the specified XML data.
clearCache() : mixed: Clears all previously loaded API objects.
deleteStyle() : mixed: Delete style
fetchStyles() : array<string|int, mixed>: Fetch All styles
fetchStyleVars() : mixed: Get Style Vars
getApiClassName() : mixed
getCssStyleDirectory() : array<string|int, mixed>: Gets the directory for the css on the filestystem
getCssStyleUrlPath() : array<string|int, mixed>: Gets the directory for the css on the filestystem as a url relative to the site root.
getScheduledStyle() : array<string|int, mixed>
getSpriteUrl() : mixed: Gets the url for the sprite file taking into account if we have rendered it to a static file and if there is a CDN url configured.
getThemeInfo() : array<string|int, mixed>: Returns an array of theme information if the user has permission.
getValidStyleFromPreference() : mixed: Get the style from the list of preferences -- will check that the desired styles exist and are available for the user to
insertStyle() : array<string|int, mixed>: Insert style
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.
setDefaultStyle() : array<string|int, mixed>: Sets the site default style
updateStyle() : mixed: Update style
useCssFiles() : array<string|int, mixed>: Determines if the css for the style should be loaded from a static file cache or from the database

__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>

__wakeup()


    public
                    __wakeup() : void

buildAllStyles()

Builds all data from the template table into the fields in the style table


    public
                    buildAllStyles([bool $renumber = 0 ][, mixed $install = 0 ][, mixed $resetcache = false ]) : mixed

Parameters

$renumber : bool = 0: -- no longer used, feature has been removed.
$install : mixed = 0
$resetcache : mixed = false

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.

canDeleteStyle()

Can this style be deleted


    public
                    canDeleteStyle(int $dostyleid) : mixed

This will either return an standard success array or will throw and exception This exists for contexts where we want to confirm the delete before actually doing it, but don't want to throw and error after the delete is confirmed.

Parameters

$dostyleid : int: Style ID to be deleted.

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

checkCanImportStyleXML()

This is used mostly by the adminCP style importer. This checks if the current user has enough permissions to import the specified XML data.


    public
                    checkCanImportStyleXML(string $xmlString) : array<string|int, mixed>

Caller using this function must ensure that the $xmlString data matches what's in an uploaded XML file, if they are separately specified.

Parameters

$xmlString : string: XML data

Return values

array<string|int, mixed> —

Array containing the bool 'canimport' & string 'reason'.

canimport : true if user has enough perms
reason : Phrase label for the reason why the current user cannot import the XML. (Blank if canimport is true)

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.

deleteStyle()

Delete style


    public
                    deleteStyle(int $dostyleid[, mixed $skipRebuild = false ]) : mixed

Parameters

$dostyleid : int: Style ID to be deleted.
$skipRebuild : mixed = false

fetchStyles()

Fetch All styles


    public
                    fetchStyles([bool $withdepthmark = false ][, bool $userselectonly = false ][, mixed $nocache = false ][, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>

Parameters

$withdepthmark : bool = false: If true, style title will be prepended with depth mark
$userselectonly : bool = false: If true, this method returns only styles that allows user to select
$nocache : mixed = false
$options : array<string|int, mixed> = []: -- currently only understands "themes"-includes themes

Return values

array<string|int, mixed> —

All styles' information

fetchStyleVars()

Get Style Vars


    public
                    fetchStyleVars(array<string|int, mixed> $stylePreference) : mixed

Parameters

$stylePreference : array<string|int, mixed>: -- various styles in the order we should check them

getApiClassName()


    public
            static        getApiClassName(mixed $controller) : mixed

Parameters

$controller : mixed

getCssStyleDirectory()

Gets the directory for the css on the filestystem


    public
                    getCssStyleDirectory(int $styleid, string $textdir) : array<string|int, mixed>

Parameters

$styleid : int
$textdir : string: -- either 'ltr' or 'rtl' (unknown values treated as 'rtl')

Return values

array<string|int, mixed> —

-- ['directory' => string] the full directory path without a trailing slash

getCssStyleUrlPath()

Gets the directory for the css on the filestystem as a url relative to the site root.


    public
                    getCssStyleUrlPath(int $styleid, string $textdir) : array<string|int, mixed>

Parameters

$styleid : int
$textdir : string: -- either 'ltr' or 'rtl' (unknown values treated as 'rtl')

Return values

array<string|int, mixed> —

-- ['directory' => string] the full directory path without a trailing slash

getScheduledStyle()


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

Return values

array<string|int, mixed> —

[ 'currentstyle' => [ 'found' => bool, 'styleid' => int, 'overridechannelcustom' => bool, 'overrideusercustom' => bool, 'title' => string 'expires' => int, ], ]

getSpriteUrl()

Gets the url for the sprite file taking into account if we have rendered it to a static file and if there is a CDN url configured.


    public
                    getSpriteUrl(mixed $filename, int $styleid, string $textdir) : mixed

@param string $filename

Parameters

$filename : mixed
$styleid : int
$textdir : string: -- either 'ltr' or 'rtl' (unknown values treated as 'rtl')

getThemeInfo()

Returns an array of theme information if the user has permission.


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

The theme parent style is skipped.

Return values

array<string|int, mixed> —

array where each element contains an array of theme information, eg: [ "themes" => [ 0 => [ "styleid" => {theme1's styleid} "title" => {theme1's title}, "iconurl" => {URL to theme1's icon}, "previewurl" => {URL to theme1's preview image (empty if there is no preview image)}, ], 1 => [ "styleid" => {theme2's styleid} "title" => {theme2's title}, "iconurl" => {URL to theme2's icon}, "previewurl" => {URL to theme2's preview image (empty if there is no preview image)}, ], [...] ] ]

getValidStyleFromPreference()

Get the style from the list of preferences -- will check that the desired styles exist and are available for the user to


    public
                    getValidStyleFromPreference(array<string|int, mixed> $stylePreference) : mixed

Parameters

$stylePreference : array<string|int, mixed>: -- various styles in the order we should check them

insertStyle()

Insert style


    public
                    insertStyle(string $title, int $parentid, bool $userselect, int $displayorder[, string $guid = '' ][, binary $icon = '' ][, binary $previewImage = '' ][, mixed $styleattributes = vB_Library_Style::ATTR_DEFAULT ][, mixed $dateline = null ]) : array<string|int, mixed>

Parameters

$title : string: Style title
$parentid : int: New parent style ID for the style.
$userselect : bool: Whether user is able to choose the style.
$displayorder : int: Display order.
$guid : string = '': Theme GUID
$icon : binary = '': Theme icon
$previewImage : binary = '': Theme preview image
$styleattributes : mixed = vB_Library_Style::ATTR_DEFAULT
$dateline : mixed = null

Return values

array<string|int, mixed> —

['styleid' => newstyleid]

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

setDefaultStyle()

Sets the site default style


    public
                    setDefaultStyle(mixed $styleid) : array<string|int, mixed>

Parameters

$styleid : mixed

Return values

array<string|int, mixed> —

Array containing the bool 'success' element

updateStyle()

Update style


    public
                    updateStyle(int $dostyleid, string $title, int $parentid, bool $userselect, int $displayorder[, string $guid = '' ][, binary $icon = '' ][, bool $iconRemove = false ][, binary $previewImage = '' ][, bool $previewImageRemove = false ]) : mixed

Parameters

$dostyleid : int: Style ID to be updated.
$title : string: Style title.
$parentid : int: New parent style ID for the style.
$userselect : bool: Whether user is able to choose the style.
$displayorder : int: Display order of the style.
$guid : string = '': Theme GUID
$icon : binary = '': Theme icon
$iconRemove : bool = false: Whether to remove the current icon (if there is one, and we're not uploading a new one)
$previewImage : binary = '': Theme preview image
$previewImageRemove : bool = false: Whether to remove the current preview image (if there is one, and we're not uploading a new one)

useCssFiles()

Determines if the css for the style should be loaded from a static file cache or from the database


    public
                    useCssFiles(mixed $styleid) : array<string|int, mixed>

@param int $styleid

Parameters

$styleid : mixed

Return values

array<string|int, mixed> —

-- ['usefiles' => boolean]

vB_Api_Style extends vB_Api in package vBApi

Tags

Table of Contents

Methods

Methods

__serialize()

Return values

__sleep()

Return values

__unserialize()

Parameters

__wakeup()

buildAllStyles()

Parameters

callNamed()

Return values

canDeleteStyle()

Parameters

Tags

checkApiState()

Parameters

checkCanImportStyleXML()

Parameters

Return values

clearCache()

deleteStyle()

Parameters

fetchStyles()

Parameters

Return values

fetchStyleVars()

Parameters

getApiClassName()

Parameters

getCssStyleDirectory()

Parameters

Return values

getCssStyleUrlPath()

Parameters

Return values

getScheduledStyle()

Return values

getSpriteUrl()

Parameters

Tags

getThemeInfo()

Return values

getValidStyleFromPreference()

Parameters

insertStyle()

Parameters

Return values

instance()

Parameters

Return values

instanceInternal()

Parameters

Return values

map_vb4_input_to_vb5()

Parameters

Return values

map_vb5_errors_to_vb4()

Parameters

map_vb5_output_to_vb4()

Parameters

setDefaultStyle()

Parameters

Return values

updateStyle()

Parameters

useCssFiles()

Parameters

Return values

vB_Api_Style extends vB_Api
in package

vBApi