Formatter  

class Formatter

Properties

protected array $configurationCallbacks
protected array $parsingCallbacks
protected array $unparsingCallbacks
protected array $renderingCallbacks

Methods

__construct(Repository $cache, string $cacheDir)

No description

void
addConfigurationCallback(callable $callback)

No description

void
addParsingCallback(callable $callback)

No description

void
addUnparsingCallback(callable $callback)

No description

void
addRenderingCallback(callable $callback)

No description

string
parse(string $text, mixed $context = null, User|null $user = null)

No description

string
render(string $xml, mixed $context = null, ServerRequestInterface|null $request = null)

No description

string|null
unparse(string|null $xml, mixed $context = null)

No description

void
flush()

Flush the cache so that the formatter components are regenerated.

Configurator
getConfigurator()

No description

void
configureExternalLinks(Configurator $configurator)

No description

mixed
getComponent(string $name)

Get a TextFormatter component ("renderer" or "parser" or "js").

Parser
getParser(mixed $context = null)

No description

Renderer
getRenderer()

No description

string
getJs()

Get the formatter JavaScript.

string
configureDefaultsOnLinks(string $xml)

No description

string
convert(string|null $content)

Converts a plain text string (with or without Markdown) to it's HTML equivalent.

Details

at line 28
__construct(Repository $cache, string $cacheDir)

Parameters

Repository $cache
string $cacheDir

at line 37
void addConfigurationCallback(callable $callback)

Parameters

callable $callback

Return Value

void

at line 45
void addParsingCallback(callable $callback)

Parameters

callable $callback

Return Value

void

at line 53
void addUnparsingCallback(callable $callback)

Parameters

callable $callback

Return Value

void

at line 61
void addRenderingCallback(callable $callback)

Parameters

callable $callback

Return Value

void

at line 66
string parse(string $text, mixed $context = null, User|null $user = null)

Parameters

string $text
mixed $context
User|null $user

Return Value

string

at line 84
string render(string $xml, mixed $context = null, ServerRequestInterface|null $request = null)

Parameters

string $xml
mixed $context
ServerRequestInterface|null $request

Return Value

string

at line 97
string|null unparse(string|null $xml, mixed $context = null)

Parameters

string|null $xml
mixed $context

Return Value

string|null

at line 113
void flush()

Flush the cache so that the formatter components are regenerated.

Return Value

void

at line 118
protected Configurator getConfigurator()

Return Value

Configurator

Parameters

Configurator $configurator

Return Value

void

at line 166
protected mixed getComponent(string $name)

Get a TextFormatter component ("renderer" or "parser" or "js").

Parameters

string $name

Return Value

mixed

at line 175
protected Parser getParser(mixed $context = null)

Parameters

mixed $context

Return Value

Parser

at line 184
protected Renderer getRenderer()

Return Value

Renderer

at line 198
string getJs()

Get the formatter JavaScript.

Return Value

string

Parameters

string $xml

Return Value

string

at line 215
string convert(string|null $content)

Converts a plain text string (with or without Markdown) to it's HTML equivalent.

Parameters

string|null $content

Return Value

string