Formatter  

class Formatter implements ExtenderInterface, LifecycleInterface

Methods

Formatter
configure(callable|string $callback)

<p>Configure the formatter. This can be used to add support for custom markdown/bbcode/etc tags, or otherwise change the formatter. Please see documentation for the s9e text formatter library for more information on how to use this.</p>

Formatter
parse(callable|string $callback)

<p>Prepare the system for parsing. This can be used to modify the text that will be parsed, or to modify the parser.</p>

Formatter
unparse(callable|string $callback)

<p>Prepare the system for unparsing. This can be used to modify the text that was parsed.</p>

Formatter
render(callable|string $callback)

<p>Prepare the system for rendering. This can be used to modify the xml that will be rendered, or to modify the renderer.</p>

void
extend(Container $container, Extension $extension = null)

No description

void
onEnable(Container $container, Extension $extension)

No description

void
onDisable(Container $container, Extension $extension)

No description

Details

at line 42
Formatter configure(callable|string $callback)

<p>Configure the formatter. This can be used to add support for custom markdown/bbcode/etc tags, or otherwise change the formatter. Please see documentation for the s9e text formatter library for more information on how to use this.</p>

Parameters

callable|string $callback

Return Value

Formatter

at line 66
Formatter parse(callable|string $callback)

<p>Prepare the system for parsing. This can be used to modify the text that will be parsed, or to modify the parser.</p>

<p>Please note that the text to be parsed must be returned, regardless of whether it's changed.</p>

Parameters

callable|string $callback

Return Value

Formatter

at line 88
Formatter unparse(callable|string $callback)

<p>Prepare the system for unparsing. This can be used to modify the text that was parsed.</p>

<p>Please note that the parsed text must be returned, regardless of whether it's changed.</p>

Parameters

callable|string $callback

Return Value

Formatter

at line 112
Formatter render(callable|string $callback)

<p>Prepare the system for rendering. This can be used to modify the xml that will be rendered, or to modify the renderer.</p>

<p>Please note that the xml to be rendered must be returned, regardless of whether it's changed.</p>

Parameters

callable|string $callback

Return Value

Formatter

at line 119
void extend(Container $container, Extension $extension = null)

Parameters

Container $container
Extension $extension

Return Value

void

at line 142
void onEnable(Container $container, Extension $extension)

Parameters

Container $container
Extension $extension

Return Value

void

at line 148
void onDisable(Container $container, Extension $extension)

Parameters

Container $container
Extension $extension

Return Value

void