EnvironmentBuilderInterface
extends
ConfigurationProviderInterface
in
Interface for building the Environment with any extensions, parsers, listeners, etc. that it may need
Table of Contents
Methods
- addBlockStartParser() : $this
- Registers the given block start parser with the Environment
- addDelimiterProcessor() : EnvironmentBuilderInterface
- Registers the given delimiter processor with the Environment
- addEventListener() : $this
- Registers the given event listener
- addExtension() : EnvironmentBuilderInterface
- Registers the given extension with the Environment
- addInlineParser() : $this
- Registers the given inline parser with the Environment
- addRenderer() : $this
- Registers the given node renderer with the Environment
- getConfiguration() : ConfigurationInterface
Methods
addBlockStartParser()
Registers the given block start parser with the Environment
public
addBlockStartParser(BlockStartParserInterface $parser[, int $priority = 0 ]) : $this
Parameters
- $parser : BlockStartParserInterface
-
Block parser instance
- $priority : int = 0
-
Priority (a higher number will be executed earlier)
Tags
Return values
$thisaddDelimiterProcessor()
Registers the given delimiter processor with the Environment
public
addDelimiterProcessor(DelimiterProcessorInterface $processor) : EnvironmentBuilderInterface
Parameters
- $processor : DelimiterProcessorInterface
-
Delimiter processors instance
Tags
Return values
EnvironmentBuilderInterfaceaddEventListener()
Registers the given event listener
public
addEventListener(class-string $eventClass, callable $listener[, int $priority = 0 ]) : $this
Parameters
- $eventClass : class-string
-
Fully-qualified class name of the event this listener should respond to
- $listener : callable
-
Listener to be executed
- $priority : int = 0
-
Priority (a higher number will be executed earlier)
Tags
Return values
$thisaddExtension()
Registers the given extension with the Environment
public
addExtension(ExtensionInterface $extension) : EnvironmentBuilderInterface
Parameters
- $extension : ExtensionInterface
Tags
Return values
EnvironmentBuilderInterfaceaddInlineParser()
Registers the given inline parser with the Environment
public
addInlineParser(InlineParserInterface $parser[, int $priority = 0 ]) : $this
Parameters
- $parser : InlineParserInterface
-
Inline parser instance
- $priority : int = 0
-
Priority (a higher number will be executed earlier)
Tags
Return values
$thisaddRenderer()
Registers the given node renderer with the Environment
public
addRenderer(string $nodeClass, NodeRendererInterface $renderer[, int $priority = 0 ]) : $this
Parameters
- $nodeClass : string
-
The fully-qualified node element class name the renderer below should handle
- $renderer : NodeRendererInterface
-
The renderer responsible for rendering the type of element given above
- $priority : int = 0
-
Priority (a higher number will be executed earlier)
Tags
Return values
$thisgetConfiguration()
public
getConfiguration() : ConfigurationInterface