DirectiveRule
in package
implements
Rule
Tags
Table of Contents
Interfaces
Constants
- PRIORITY = 70
Properties
- $directives : array<string, BaseDirective>
- $generalDirective : GeneralDirective
- $inlineMarkupRule : InlineMarkupRule
- $logger : LoggerInterface
Methods
- __construct() : mixed
- applies() : bool
- apply() : TNode|null
- Enters this state and loops through all relevant lines until a Node is produced.
- collectDirectiveContents() : Buffer
- collectDirectiveOptionContent() : void
- Collects the content of multiline directive options:
- getDirectiveHandler() : BaseDirective
- interpretDirectiveOptions() : void
- isDirectiveOption() : bool
- parseDirective() : Directive|null
- parseDirectiveContent() : void
- parseDirectiveOption() : DirectiveOption
- Directive options are stored in the field-list syntax:
- postProcessNode() : Node
- Post processes a node created by a directive to apply common options
- registerDirective() : void
Constants
PRIORITY
public
mixed
PRIORITY
= 70
Properties
$directives
private
array<string, BaseDirective>
$directives
$generalDirective read-only
private
GeneralDirective
$generalDirective
$inlineMarkupRule read-only
private
InlineMarkupRule
$inlineMarkupRule
$logger read-only
private
LoggerInterface
$logger
Methods
__construct()
public
__construct(InlineMarkupRule $inlineMarkupRule, LoggerInterface $logger, GeneralDirective $generalDirective[, iterable<string|int, BaseDirective> $directives = [] ]) : mixed
Parameters
- $inlineMarkupRule : InlineMarkupRule
- $logger : LoggerInterface
- $generalDirective : GeneralDirective
- $directives : iterable<string|int, BaseDirective> = []
applies()
public
applies(BlockContext $blockContext) : bool
Parameters
- $blockContext : BlockContext
Return values
boolapply()
Enters this state and loops through all relevant lines until a Node is produced.
public
apply(BlockContext $blockContext[, CompoundNode|null $on = null ]) : TNode|null
The opening line is considered relevant and as such is always used (this is found the case in the self::Applies() method, otherwise we wouldn't have been here) but for all subsequent lines we use a Look Ahead to test whether it should be included in the Node.
By using a Look Ahead, we prevent the cursor from advancing; and this caused the cursor to 'rest' on the line that is considered that last relevant line. The document parser will advance the line after successfully parsing this and to send the Parser into a line that belongs to another state.
Parameters
- $blockContext : BlockContext
- $on : CompoundNode|null = null
Return values
TNode|nullcollectDirectiveContents()
private
collectDirectiveContents(LinesIterator $documentIterator) : Buffer
Parameters
- $documentIterator : LinesIterator
Return values
BuffercollectDirectiveOptionContent()
Collects the content of multiline directive options:
private
collectDirectiveOptionContent(LinesIterator $documentIterator, DirectiveOption $directiveOption) : void
.. figure:: foo.jpg :width: 100 :alt: Field options might use more than one line
This is a foo!
Parameters
- $documentIterator : LinesIterator
- $directiveOption : DirectiveOption
getDirectiveHandler()
private
getDirectiveHandler(Directive $directive) : BaseDirective
Parameters
- $directive : Directive
Return values
BaseDirectiveinterpretDirectiveOptions()
private
interpretDirectiveOptions(LinesIterator $documentIterator, Directive $directive) : void
Parameters
- $documentIterator : LinesIterator
- $directive : Directive
isDirectiveOption()
private
isDirectiveOption(string|null $line) : bool
Parameters
- $line : string|null
Return values
boolparseDirective()
private
parseDirective(string $line) : Directive|null
Parameters
- $line : string
Return values
Directive|nullparseDirectiveContent()
private
parseDirectiveContent(Directive $directive, BlockContext $blockContext) : void
Parameters
- $directive : Directive
- $blockContext : BlockContext
parseDirectiveOption()
Directive options are stored in the field-list syntax:
private
parseDirectiveOption(string $line) : DirectiveOption
.. figure:: foo.jpg :width: 100 :alt: Field options might use more than one line :yet another option: abc :empty option:
Parameters
- $line : string
Tags
Return values
DirectiveOptionpostProcessNode()
Post processes a node created by a directive to apply common options
private
postProcessNode(Node $node, array<string|int, DirectiveOption> $options) : Node
Parameters
- $node : Node
- $options : array<string|int, DirectiveOption>
Return values
NoderegisterDirective()
private
registerDirective(BaseDirective $directive) : void
Parameters
- $directive : BaseDirective