vBulletin 5.6.5 API

vB_Api_Bbcode extends vB_Api

in package

• vBApi

vB_Api_Bbcode

Tags

access

public

Table of Contents

ALLOW_BBCODE_ALIGN  = 16

ALLOW_BBCODE_BASIC  = 1

ALLOW_BBCODE_CODE  = 128

ALLOW_BBCODE_COLOR  = 2

ALLOW_BBCODE_CUSTOM  = 4096

ALLOW_BBCODE_FONT  = 8

ALLOW_BBCODE_HTML  = 512

ALLOW_BBCODE_IMG  = 1024

ALLOW_BBCODE_LIST  = 32

ALLOW_BBCODE_PHP  = 256

ALLOW_BBCODE_QUOTE  = 2048

ALLOW_BBCODE_SIZE  = 4

ALLOW_BBCODE_URL  = 64

ALLOW_BBCODE_USER  = 16384

EDITOR_INDENT  = 40

$controller  : string

API Controller

$customTags  : array<string|int, mixed>

Contains an array of user specified custom BB code tags.

$db  : vB_Database

Database object.

$disabled  : bool

Indicates whether the API was disabled

$disableFalseReturnOnly  : array<string|int, mixed>

{@inheritDoc} Methods include: getSignatureInfo

$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

$vb4_input_mappings  : mixed

$wrappers  : mixed

__serialize()  : mixed

__sleep()  : mixed

__unserialize()  : mixed

__wakeup()  : mixed

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.

convertUrlToBbcode()  : string

Converts URLs into bbcode with [URL]

convertWysiwygTextToBbcode()  : string

Converts text from an editor into text ready to be saved with bbcode converted

extractVideo()  : mixed

Extracts the video and photo content from text.

fetchSmilies()  : array<string|int, mixed>

Returns an array of smilie information.

fetchTagList()  : array<string|int, mixed>

Returns the list of default BB code tags

getApiClassName()  : mixed

getSignatureInfo()  : array<string|int, mixed>

Fetches and parses to html a user's signature

hasBbcode()  : bool

Determines if the text contains bbcode.

initInfo()  : array<string|int, mixed>

Returns an array of bbcode parsing information. {@see vB_Api_Bbcode::fetchTagList}

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.

parseSignature()  : string

Fetches and parses to html a user's signature

parseSignatures()  : array<string|int, mixed>

Fetches and parses to html signatures

parseWysiwygHtmlToBbcode()  : string

Parses HTML produced by a WYSIWYG editor and produces the corresponding BBCode formatted text

__construct()  : mixed

Constructor

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

doParseSignature()  : array<string|int, mixed>

Used by getSignatureInfo and parseSignatures to parse a signature

fetchBbcodeOptions()  : array<string|int, mixed>

Compiles and returns an array of various bbcode-related vboptions.

fetchCustomTags()  : array<string|int, mixed>

Loads any user specified custom BB code tags.

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.

array(
    signature => parsed HTML signature
    allowed => array of bbcode tags the user is allowed to use in their signature
    disabled => array of bbcode tags the user is NOT allowed to use in their signature
)

array(
    defaultTags => array vB_Api_Bbcode::fetchTagList
    customTags => array @see vB_Api_Bbcode::fetchCustomTags
    defaultOptions => array vB_Api_Bbcode::fetchBbcodeOptions()
)

array(
    signature => parsed signature
    allowed => array of bbcode tags the user is allowed to use in their signature
    disabled => array of bbcode tags the user is NOT allowed to use in their signature
)

array(
    privatemessage => array(
        allowhtml
        allowbbcode
        allowimagecode
        allowsmilies
    )
    nonforum => array(
        dohtml
        dobbcode
        doimagecode
        dosmilies
    )
    arrays similar to 'nonforum' for visitormessage, groupmessage, and socialmessage.
)

array(
    option => array(
        bbcode_tag => array(
            html => replacement string
            strip_empty => int
            stop_parse => int
            disable_smilies => int
            disable_wordwrap => int
        )
        [...]
    )
    no_option => array(
        bbcode_tag => array(
            html => replacement string
            strip_empty => int
            stop_parse => int
            disable_smilies => int
            disable_wordwrap => int
        )
        [...]
    )
)

@param string|array $adminPermission The admin permission to check.  If an array