MarkupManager
in package
Uses
Singleton
This class manages Twig functions, token parsers and filters.
Tags
Table of Contents
- EXTENSION_FILTER = 'filters'
- EXTENSION_FUNCTION = 'functions'
- EXTENSION_TOKEN_PARSER = 'tokens'
- $callbacks : array<string|int, mixed>
- $instance : mixed
- $items : array<string|int, mixed>
- $pluginManager : PluginManager
- $transactionItems : array<string|int, mixed>
- $transactionMode : bool
- __clone() : mixed
- __wakeup() : mixed
- beginTransaction() : void
- Start a new transaction.
- endTransaction() : void
- Ends an active transaction.
- forgetInstance() : mixed
- Forget this singleton's instance if it exists
- instance() : mixed
- Create a new instance of this singleton.
- listExtensions() : array<string|int, mixed>
- Returns a list of the registered Twig extensions of a type.
- listFilters() : array<string|int, mixed>
- Returns a list of the registered Twig filters.
- listFunctions() : array<string|int, mixed>
- Returns a list of the registered Twig functions.
- listTokenParsers() : array<string|int, mixed>
- Returns a list of the registered Twig token parsers.
- makeTwigFilters() : array<string|int, mixed>
- Makes a set of Twig filters for use in a twig extension.
- makeTwigFunctions() : array<string|int, mixed>
- Makes a set of Twig functions for use in a twig extension.
- makeTwigTokenParsers() : array<string|int, mixed>
- Makes a set of Twig token parsers for use in a twig extension.
- registerCallback() : mixed
- Registers a callback function that defines simple Twig extensions.
- registerExtensions() : mixed
- Registers the CMS Twig extension items.
- registerFilters() : mixed
- Registers a CMS Twig Filter
- registerFunctions() : mixed
- Registers a CMS Twig Function
- registerTokenParsers() : mixed
- Registers a CMS Twig Token Parser
- transaction() : void
- Execute a single serving transaction, containing filters, functions, and token parsers that are disposed of afterwards.
- __construct() : mixed
- Constructor.
- init() : mixed
- Initialize this singleton.
- isWildCallable() : mixed
- Tests if a callable type contains a wildcard, also acts as a utility to replace the wildcard with a string.
- loadExtensions() : mixed
Constants
EXTENSION_FILTER
public
mixed
EXTENSION_FILTER
= 'filters'
EXTENSION_FUNCTION
public
mixed
EXTENSION_FUNCTION
= 'functions'
EXTENSION_TOKEN_PARSER
public
mixed
EXTENSION_TOKEN_PARSER
= 'tokens'
Properties
$callbacks
protected
array<string|int, mixed>
$callbacks
= []
Cache of registration callbacks.
$instance
protected
static mixed
$instance
$items
protected
array<string|int, mixed>
$items
Globally registered extension items
$pluginManager
protected
PluginManager
$pluginManager
$transactionItems
protected
array<string|int, mixed>
$transactionItems
Transaction based extension items
$transactionMode
protected
bool
$transactionMode
= false
Manager is in transaction mode
Methods
__clone()
public
__clone() : mixed
Return values
mixed —__wakeup()
public
__wakeup() : mixed
Return values
mixed —beginTransaction()
Start a new transaction.
public
beginTransaction() : void
Return values
void —endTransaction()
Ends an active transaction.
public
endTransaction() : void
Return values
void —forgetInstance()
Forget this singleton's instance if it exists
public
final static forgetInstance() : mixed
Return values
mixed —instance()
Create a new instance of this singleton.
public
final static instance() : mixed
Return values
mixed —listExtensions()
Returns a list of the registered Twig extensions of a type.
public
listExtensions( $type) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —listFilters()
Returns a list of the registered Twig filters.
public
listFilters() : array<string|int, mixed>
Return values
array<string|int, mixed> —listFunctions()
Returns a list of the registered Twig functions.
public
listFunctions() : array<string|int, mixed>
Return values
array<string|int, mixed> —listTokenParsers()
Returns a list of the registered Twig token parsers.
public
listTokenParsers() : array<string|int, mixed>
Return values
array<string|int, mixed> —makeTwigFilters()
Makes a set of Twig filters for use in a twig extension.
public
makeTwigFilters([array<string|int, mixed> $filters = [] ]) : array<string|int, mixed>
Parameters
- $filters : array<string|int, mixed> = []
-
Current collection
Return values
array<string|int, mixed> —makeTwigFunctions()
Makes a set of Twig functions for use in a twig extension.
public
makeTwigFunctions([array<string|int, mixed> $functions = [] ]) : array<string|int, mixed>
Parameters
- $functions : array<string|int, mixed> = []
-
Current collection
Return values
array<string|int, mixed> —makeTwigTokenParsers()
Makes a set of Twig token parsers for use in a twig extension.
public
makeTwigTokenParsers([array<string|int, mixed> $parsers = [] ]) : array<string|int, mixed>
Parameters
- $parsers : array<string|int, mixed> = []
-
Current collection
Return values
array<string|int, mixed> —registerCallback()
Registers a callback function that defines simple Twig extensions.
public
registerCallback(callable $callback) : mixed
The callback function should register menu items by calling the manager's
registerFunctions, registerFilters, registerTokenParsers function.
The manager instance is passed to the callback function as an argument. Usage:
MarkupManager::registerCallback(function ($manager) {
$manager->registerFilters([...]);
$manager->registerFunctions([...]);
$manager->registerTokenParsers([...]);
});
Parameters
- $callback : callable
-
A callable function.
Return values
mixed —registerExtensions()
Registers the CMS Twig extension items.
public
registerExtensions(string $type, array<string|int, mixed> $definitions) : mixed
The argument is an array of the extension definitions. The array keys represent the function/filter name, specific for the plugin/module. Each element in the array should be an associative array.
Parameters
- $type : string
-
The extension type: filters, functions, tokens
- $definitions : array<string|int, mixed>
-
An array of the extension definitions.
Return values
mixed —registerFilters()
Registers a CMS Twig Filter
public
registerFilters(array<string|int, mixed> $definitions) : mixed
Parameters
- $definitions : array<string|int, mixed>
-
An array of the extension definitions.
Return values
mixed —registerFunctions()
Registers a CMS Twig Function
public
registerFunctions(array<string|int, mixed> $definitions) : mixed
Parameters
- $definitions : array<string|int, mixed>
-
An array of the extension definitions.
Return values
mixed —registerTokenParsers()
Registers a CMS Twig Token Parser
public
registerTokenParsers(array<string|int, mixed> $definitions) : mixed
Parameters
- $definitions : array<string|int, mixed>
-
An array of the extension definitions.
Return values
mixed —transaction()
Execute a single serving transaction, containing filters, functions, and token parsers that are disposed of afterwards.
public
transaction(Closure $callback) : void
Parameters
- $callback : Closure
Return values
void —__construct()
Constructor.
protected
final __construct() : mixed
Return values
mixed —init()
Initialize this singleton.
protected
init() : mixed
Return values
mixed —isWildCallable()
Tests if a callable type contains a wildcard, also acts as a utility to replace the wildcard with a string.
protected
isWildCallable(callable $callable[, string|bool $replaceWith = false ]) : mixed
Parameters
- $callable : callable
- $replaceWith : string|bool = false
Return values
mixed —loadExtensions()
protected
loadExtensions() : mixed