Documentation

BBCodeFormatter
in package

Table of Contents

Properties

$gameID  : int
$noLinks  : bool
$parser  : BBCode

Methods

__construct()  : mixed
format()  : string
getInstance()  : self
renderTag()  : string|bool
Converts a BBCode tag into some other text depending on the tag and value.

Properties

Methods

format()

public format(string $message[, int|null $gameID = null ][, bool $noLinks = false ]) : string
Parameters
$message : string
$gameID : int|null = null
$noLinks : bool = false
Return values
string

renderTag()

Converts a BBCode tag into some other text depending on the tag and value.

public renderTag(BBCode $bbParser, int $action, string $tagName, string $default, array<string, string> $tagParams, string $tagContent) : string|bool

This is called in two stages: first with action BBCODE_CHECK (where the returned value must be a boolean) and second, if the first check passes, with action BBCODE_OUTPUT.

Parameters
$bbParser : BBCode
$action : int
$tagName : string
$default : string
$tagParams : array<string, string>
$tagContent : string
Return values
string|bool

        
On this page

Search results