ToctreeDirective
extends BaseDirective
in package
Sphinx based Toctree directive.
This directive has an issue, as the related documents are resolved on parse, but during the rendering we are using the Metas to collect the titles of those documents. There is some step missing in our process which could be resolved by using https://github.com/phpDocumentor/guides/pull/21?
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- 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
- 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>
Properties
$settingsManager
private
SettingsManager
$settingsManager
$startingRule read-only
private
Rule
$startingRule
$toctreeBuilder read-only
private
ToctreeBuilder
$toctreeBuilder
Methods
__construct()
public
__construct(ToctreeBuilder $toctreeBuilder, Rule<string|int, InlineCompoundNode> $startingRule[, SettingsManager|null $settingsManager = null ]) : mixed
Parameters
- $toctreeBuilder : ToctreeBuilder
- $startingRule : Rule<string|int, InlineCompoundNode>
- $settingsManager : SettingsManager|null = null
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
stringprocess()
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
Parameters
- $blockContext : BlockContext
-
the current document context with the content of the directive
- $directive : Directive
-
parsed directive containing options and variable
Return values
Node|nullprocessNode()
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
NodeoptionsToArray()
protected
optionsToArray(array<string|int, DirectiveOption> $options) : array<string, scalar|null>
Parameters
- $options : array<string|int, DirectiveOption>