Class BBCodeHighlighter

__construct()

__construct() 

Builds a BBCodeHighlighter objet

• Inherited from \BBCodeHighlighter

Tags

None found

get_content()

get_content() : string

Returns the content of the parser. If you called a method which parses the content, this content will be parsed.

Returns

string —

The content of the parser.

• Inherited from \AbstractParser

Tags

None found

set_content()

set_content(string $content) 

Sets the content of the parser. When you will call a parse method, it will deal with this content.

Parameters

string

$content

Content

• Inherited from \AbstractParser

Tags

None found

set_path_to_root()

set_path_to_root(string $path) 

Sets the reference path for relative URL

Parameters

string

$path

Path

• Inherited from \AbstractParser

Tags

None found

get_path_to_root()

get_path_to_root() : string

Returns the path to root attribute.

Returns

string —

The path

• Inherited from \AbstractParser

Tags

None found

set_page_path()

set_page_path(string $page_path) 

Sets the page path

Parameters

string

$page_path

Page path

• Inherited from \AbstractParser

Tags

None found

get_page_path()

get_page_path() : string

Returns the page path

Returns

string —

path

• Inherited from \AbstractParser

Tags

None found

add_module_special_tag()

add_module_special_tag( $pattern,  $replacement) 

{@inheritdoc}

Parameters

	$pattern
	$replacement

• Inherited from \AbstractParser

Tags

None found

get_module_special_tags()

get_module_special_tags() 

{@inheritdoc}

• Inherited from \AbstractParser

Tags

None found

parse()

parse(boolean $inline_code = self::BBCODE_HIGHLIGHTER_BLOCK_CODE) : void

Highlights the content of the parser.

Parameters

boolean

$inline_code

If you want that the code make a new HTML paragraph, use BBCODE_HIGHLIGHTER_BLOCK_CODE (default parameter) and if you want that it would be integrated in a line, use BBCODE_HIGHLIGHTER_INLINE_CODE

• Inherited from \BBCodeHighlighter

Tags

None found

_parse_imbricated()

_parse_imbricated(string $match, string $regex, string $replace) 

Parses a nested tag

Parameters

string	$match	The regular expression which matches the tag to replace
string	$regex	The regular expression which matches the replacement
string	$replace	The replacement syntax.

• Inherited from \AbstractParser

Tags

None found

parse_tag_args()

parse_tag_args(string $matches, string $allowed_args = array()) 

Parses tag args to get allowed ones

Parameters

string	$matches	The regular expression which matches the tag args
string	$allowed_args	The args that are allowed to be present

static

• Inherited from \AbstractParser

Tags

None found

highlight_bbcode_tag_with_many_parameters()

highlight_bbcode_tag_with_many_parameters(array<mixed,string> $matches) : string

Callback which highlights the parameters of a complex tag

Parameters

array<mixed,string>

$matches

elements matched by the regular expression

Returns

string —

The complex tag highlighted

• Inherited from \BBCodeHighlighter

Tags

None found