phpBB API Documentation
Class

phpbb\textformatter\s9e\factory

class factory implements cache_interface

Creates s9e\TextFormatter objects

Methods

__construct(data_access $data_access, driver_interface $cache, dispatcher_interface $dispatcher, config $config, link_helper $link_helper, string $cache_dir, string $cache_key_parser, string $cache_key_renderer)

Constructor

invalidate()

Invalidate and/or regenerate this text formatter's cache(s)

tidy()

Tidy/prune this text formatter's cache(s)

Configurator get_configurator()

Generate and return a new configured instance of s9e\TextFormatter\Configurator

array regenerate()

Regenerate and cache a new parser and renderer

Details

at line 146
public __construct(data_access $data_access, driver_interface $cache, dispatcher_interface $dispatcher, config $config, link_helper $link_helper, string $cache_dir, string $cache_key_parser, string $cache_key_renderer)

Constructor

Parameters

data_access $data_access
driver_interface $cache
dispatcher_interface $dispatcher
config $config
link_helper $link_helper
string $cache_dir Path to the cache dir
string $cache_key_parser Cache key used for the parser
string $cache_key_renderer Cache key used for the renderer

at line 161
public invalidate()

Invalidate and/or regenerate this text formatter's cache(s)

at line 171
public tidy()

Tidy/prune this text formatter's cache(s)

at line 192
public Configurator get_configurator()

Generate and return a new configured instance of s9e\TextFormatter\Configurator

Return Value

Configurator

at line 381
public array regenerate()

Regenerate and cache a new parser and renderer

Return Value

array Associative array with at least two elements: "parser" and "renderer"