ContentsDirective
extends BaseDirective
in package
Standarad rst `contents` directive
Displays a table of content of the current page
Attributes
- #[Option]
- $name: 'local'
- $type: \phpDocumentor\Guides\RestructuredText\Directives\OptionType::Boolean
- $description: 'If set, the table of contents will only include sections that are local to the current document.'
- $default: false
- #[Option]
- $name: 'depth'
- $description: 'The maximum depth of the table of contents.'
Table of Contents
Properties
Methods
- __construct() : mixed
- createNode() : Node|null
- getAliases() : array<string|int, string>
- Allow a directive to be registered under multiple names.
- getName() : string
- Get the directive name
- process() : Node
- 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>
- readAllOptions() : array<string, scalar|array<string|int, scalar>|null>
- readOption() : mixed
- Gets an option value from a directive based on attribute configuration.
Properties
$documentNameResolver read-only
private
DocumentNameResolverInterface
$documentNameResolver
Methods
__construct()
public
__construct(DocumentNameResolverInterface $documentNameResolver) : mixed
Parameters
- $documentNameResolver : DocumentNameResolverInterface
createNode()
public
createNode(DirectiveNode $directiveNode) : Node|null
Parameters
- $directiveNode : DirectiveNode
Return values
Node|nullgetAliases()
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
Parameters
- $blockContext : BlockContext
-
the current document context with the content of the directive
- $directive : Directive
-
parsed directive containing options and variable
Return values
NodeprocessNode()
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>
Return values
array<string, scalar|null>readAllOptions()
protected
final readAllOptions(Directive $directive) : array<string, scalar|array<string|int, scalar>|null>
Parameters
- $directive : Directive
Return values
array<string, scalar|array<string|int, scalar>|null>readOption()
Gets an option value from a directive based on attribute configuration.
protected
final readOption(Directive $directive, string $optionName) : mixed
Looks up the option in the directive and returns its value converted to the appropriate type based on the Option attribute defined on this directive class. If the option is not present in the directive, returns the default value from the attribute.
Parameters
- $directive : Directive
-
The directive containing the options
- $optionName : string
-
The name of the option to retrieve
Return values
mixed —The option value converted to the appropriate type, or the default value