PHPFUI/InstaDoc
 
Copied!

Interface for building the Environment with any extensions, parsers, listeners, etc. that it may need

AbstractInterface
Methods
public abstract addBlockStartParser(League\CommonMark\Parser\Block\BlockStartParserInterface $parser, int $priority = 0) : League\CommonMark\Environment\EnvironmentBuilderInterface
 

Registers the given block start parser with the Environment

  • param \BlockStartParserInterface $parser Block parser instance
  • param int $priority Priority (a higher number will be executed earlier)
  • return $this
  • throws \AlreadyInitializedException if the Environment has already been initialized
public abstract addDelimiterProcessor(League\CommonMark\Delimiter\Processor\DelimiterProcessorInterface $processor) : League\CommonMark\Environment\EnvironmentBuilderInterface
 

Registers the given delimiter processor with the Environment

  • param \DelimiterProcessorInterface $processor Delimiter processors instance
  • throws \AlreadyInitializedException if the Environment has already been initialized
public abstract addEventListener(string $eventClass, callable $listener, int $priority = 0) : League\CommonMark\Environment\EnvironmentBuilderInterface
 

Registers the given event listener

  • param class-string $eventClass Fully-qualified class name of the event this listener should respond to
  • param callable $listener Listener to be executed
  • param int $priority Priority (a higher number will be executed earlier)
  • return $this
  • throws \AlreadyInitializedException if the Environment has already been initialized
public abstract addExtension(League\CommonMark\Extension\ExtensionInterface $extension) : League\CommonMark\Environment\EnvironmentBuilderInterface
 

Registers the given extension with the Environment

  • throws \AlreadyInitializedException if the Environment has already been initialized
public abstract addInlineParser(League\CommonMark\Parser\Inline\InlineParserInterface $parser, int $priority = 0) : League\CommonMark\Environment\EnvironmentBuilderInterface
 

Registers the given inline parser with the Environment

  • param \InlineParserInterface $parser Inline parser instance
  • param int $priority Priority (a higher number will be executed earlier)
  • return $this
  • throws \AlreadyInitializedException if the Environment has already been initialized
public abstract addRenderer(string $nodeClass, League\CommonMark\Renderer\NodeRendererInterface $renderer, int $priority = 0) : League\CommonMark\Environment\EnvironmentBuilderInterface
 

Registers the given node renderer with the Environment

  • param string $nodeClass The fully-qualified node element class name the renderer below should handle
  • param \NodeRendererInterface $renderer The renderer responsible for rendering the type of element given above
  • param int $priority Priority (a higher number will be executed earlier)
  • psalm-param class-string<Node> $nodeClass
  • return $this
  • throws \AlreadyInitializedException if the Environment has already been initialized
public abstract League\Config\ConfigurationProviderInterface::getConfiguration() : League\Config\ConfigurationInterface
© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration