Formatter  

class Formatter implements ExtenderInterface, LifecycleInterface

Methods

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.

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.

Formatter
unparse(callable|string $callback)

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

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.

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

No description

onEnable(Container $container, Extension $extension)

No description

onDisable(Container $container, Extension $extension)

No description

Details

at line 38
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 The callback can be a closure or invokable class, and should accept: - \s9e\TextFormatter\Configurator $configurator The callable should return void.

Return Value

Formatter

at line 62
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 The callback can be a closure or invokable class, and should accept: - \s9e\TextFormatter\Parser $parser - mixed $context - string $text: The text to be parsed. - \Flarum\User\User|null $actor. This argument MUST either be nullable, or omitted entirely. The callback should return: - string $text: The text to be parsed.

Return Value

Formatter

at line 84
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 The callback can be a closure or invokable class, and should accept: - mixed $context - string $xml: The parsed text. The callback should return: - string $xml: The text to be unparsed.

Return Value

Formatter

at line 108
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 The callback can be a closure or invokable class, and should accept: - \s9e\TextFormatter\Renderer $renderer - mixed $context - string $xml: The xml to be rendered. - ServerRequestInterface $request. This argument MUST either be nullable, or omitted entirely. The callback should return: - string $xml: The xml to be rendered.

Return Value

Formatter

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

Parameters

Container $container
Extension $extension

at line 138
onEnable(Container $container, Extension $extension)

Parameters

Container $container
Extension $extension

at line 144
onDisable(Container $container, Extension $extension)

Parameters

Container $container
Extension $extension