Guides

TodoDirective extends ActionDirective
in package

FinalYes

Todo directives are treated as comments, omitting all content or options

Table of Contents

Methods

getAliases()  : array<string|int, string>
Allow a directive to be registered under multiple names.
getName()  : string
Get the directive name
process()  : Node|null
This is the function called by the parser to process the directive, it can be overloaded to do anything with the document, like tweaking nodes or change the parser context
processAction()  : void
processNode()  : Node
This can be overloaded to write a directive that just create one node for the document, which is common
optionsToArray()  : array<string, scalar|null>

Methods

getAliases()

Allow a directive to be registered under multiple names.

public getAliases() : array<string|int, string>

Aliases can be used for directives whose name has been deprecated or allows for multiple spellings.

Return values
array<string|int, string>

getName()

Get the directive name

public getName() : string
Return values
string

process()

This is the function called by the parser to process the directive, it can be overloaded to do anything with the document, like tweaking nodes or change the parser context

public process(BlockContext $blockContext, Directive $directive) : Node|null

The node that directly follows the directive is also passed to it

Parameters
$blockContext : BlockContext

the current document context with the content of the directive

$directive : Directive

parsed directive containing options and variable

Return values
Node|null

processAction()

public processAction(BlockContext $blockContext, Directive $directive) : void
Parameters
$blockContext : BlockContext

the current document context with the content of the directive

$directive : Directive

parsed directive containing options and variable

processNode()

This can be overloaded to write a directive that just create one node for the document, which is common

public processNode(BlockContext $blockContext, Directive $directive) : Node

The arguments are the same that process

Parameters
$blockContext : BlockContext
$directive : Directive
Return values
Node

optionsToArray()

protected optionsToArray(array<string|int, DirectiveOption> $options) : array<string, scalar|null>
Parameters
$options : array<string|int, DirectiveOption>
Return values
array<string, scalar|null> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results