ConfvalDirective
extends SubDirective
in package
The confval directive configuration values.
https://sphinx-toolbox.readthedocs.io/en/stable/extensions/confval.html
Attributes
- #[Option]
- $name: 'name'
- $description: 'Id of the configuration value, used for linking to it.'
- #[Option]
- $name: 'type'
- $description: 'Type of the configuration value, e.g. "string", "int", etc.'
- #[Option]
- $name: 'required'
- $type: \phpDocumentor\Guides\RestructuredText\Directives\OptionType::Boolean
- $default: false
- $description: 'Whether the configuration value is required or not.'
- #[Option]
- $name: 'default'
- $description: 'Default value of the configuration value, if any.'
- #[Option]
- $name: 'noindex'
- $type: \phpDocumentor\Guides\RestructuredText\Directives\OptionType::Boolean
- $default: false
- $description: 'Whether the configuration value should not be indexed.'
Table of Contents
Constants
- NAME : mixed = 'confval'
Properties
- $startingRule : Rule
- $anchorReducer : AnchorNormalizer
- $inlineParser : InlineParser
- $logger : LoggerInterface|null
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|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
- getStartingRule() : Rule<string|int, CollectionNode>
- optionsToArray() : array<string, scalar|null>
- processSub() : Node
- readAllOptions() : array<string, scalar|array<string|int, scalar>|null>
- readOption() : mixed
- Gets an option value from a directive based on attribute configuration.
Constants
NAME
public
mixed
NAME
= 'confval'
Properties
$startingRule
protected
Rule
$startingRule
$anchorReducer read-only
private
AnchorNormalizer
$anchorReducer
$inlineParser read-only
private
InlineParser
$inlineParser
$logger read-only
private
LoggerInterface|null
$logger
= null
Methods
__construct()
public
__construct(Rule<string|int, CollectionNode> $startingRule, GenericLinkProvider $genericLinkProvider, AnchorNormalizer $anchorReducer, InlineParser $inlineParser[, LoggerInterface|null $logger = null ]) : mixed
Parameters
- $startingRule : Rule<string|int, CollectionNode>
- $genericLinkProvider : GenericLinkProvider
- $anchorReducer : AnchorNormalizer
- $inlineParser : InlineParser
- $logger : LoggerInterface|null = null
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
final 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
NodegetStartingRule()
protected
getStartingRule() : Rule<string|int, CollectionNode>
Return values
Rule<string|int, CollectionNode>optionsToArray()
protected
optionsToArray(array<string|int, DirectiveOption> $options) : array<string, scalar|null>
Parameters
- $options : array<string|int, DirectiveOption>
Return values
array<string, scalar|null>processSub()
protected
processSub(BlockContext $blockContext, CollectionNode $collectionNode, Directive $directive) : Node
Parameters
- $blockContext : BlockContext
- $collectionNode : CollectionNode
- $directive : Directive
Return values
NodereadAllOptions()
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