class Formatter implements ExtenderInterface, LifecycleInterface

Methods

configure(callable|string $callback)

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.

parse(callable|string $callback)

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

unparse(callable|string $callback)

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

render(callable|string $callback)

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

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

No description

void
onEnable(Container $container, Extension $extension)

No description

void
onDisable(Container $container, Extension $extension)

No description

Details

Formatter configure(callable|string $callback)

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.

Parameters

callable|string $callback

Return Value

Formatter

Formatter parse(callable|string $callback)

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

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

Parameters

callable|string $callback

Return Value

Formatter

Formatter unparse(callable|string $callback)

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

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

Parameters

callable|string $callback

Return Value

Formatter

Formatter render(callable|string $callback)

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

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

Parameters

callable|string $callback

Return Value

Formatter

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

Parameters

Container $container
Extension|null $extension

Return Value

void

void onEnable(Container $container, Extension $extension)

Parameters

Container $container
Extension $extension

Return Value

void

void onDisable(Container $container, Extension $extension)

Parameters

Container $container
Extension $extension

Return Value

void