Guides

OptionNode extends CompoundNode
in package
implements LinkTargetNode, MultipleLinkTargetsNode

FinalYes

Describes a command line argument or switch. Option argument names should be enclosed in angle brackets.

https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-option

Table of Contents

Interfaces

LinkTargetNode
MultipleLinkTargetsNode

Constants

LINK_TYPE  = 'std:option'

Properties

$classes  : array<string|int, string>
$options  : array<string, scalar|null>
$value  : TValue
$additionalIds  : array<string|int, mixed>
$id  : string
$plainContent  : string

Methods

__construct()  : mixed
addChildNode()  : void
getAdditionalIds()  : array<string|int, string>
getChildren()  : array<string|int, TValue>
getClasses()  : array<string|int, string>
getClassesString()  : string
getId()  : string
getLinkText()  : string
getLinkType()  : string
getOption()  : mixed
getOptions()  : array<string, scalar|null>
getPlainContent()  : string
getValue()  : TValue
hasOption()  : bool
pushChildNode()  : void
removeNode()  : self
replaceNode()  : self
setClasses()  : void
Normalizes class names following the rules of identifier-normalization
setValue()  : void
withKeepExistingOptions()  : static
Adds $options as default options without overriding any options already set.
withOptions()  : static

Constants

Properties

$classes

protected array<string|int, string> $classes = []

$options

protected array<string, scalar|null> $options = []

$additionalIds read-only

private array<string|int, mixed> $additionalIds

$plainContent read-only

private string $plainContent

Methods

__construct()

public __construct(string $id, string $plainContent, array<string|int, string> $additionalIds[, array<int, Node> $value = [] ]) : mixed
Parameters
$id : string
$plainContent : string
$additionalIds : array<string|int, string>
$value : array<int, Node> = []

addChildNode()

public addChildNode(TValue $node) : void
Parameters
$node : TValue

getAdditionalIds()

public getAdditionalIds() : array<string|int, string>
Return values
array<string|int, string>

getChildren()

public getChildren() : array<string|int, TValue>
Return values
array<string|int, TValue>

getClasses()

public getClasses() : array<string|int, string>
Return values
array<string|int, string>

getClassesString()

public getClassesString() : string
Return values
string

getId()

public getId() : string
Return values
string

getLinkText()

public getLinkText() : string
Return values
string

getLinkType()

public getLinkType() : string
Return values
string

getOption()

public getOption(string $name[, TType|null $default = null ]) : mixed
Parameters
$name : string
$default : TType|null = null
Tags
phpstan-return

($default is null ? mixed|null: TType|null)

getOptions()

public getOptions() : array<string, scalar|null>
Return values
array<string, scalar|null>

getPlainContent()

public getPlainContent() : string
Return values
string

getValue()

public getValue() : TValue
Return values
TValue

hasOption()

public hasOption(string $name) : bool
Parameters
$name : string
Return values
bool

pushChildNode()

public pushChildNode(TValue $node) : void
Parameters
$node : TValue

removeNode()

public removeNode(int $key) : self
Parameters
$key : int
Tags
@return

$this<TValue>

Return values
self

replaceNode()

public replaceNode(int $key, TValue $node) : self
Parameters
$key : int
$node : TValue
Tags
@return

$this<TValue>

Return values
self

setValue()

public setValue(TValue $value) : void
Parameters
$value : TValue

withKeepExistingOptions()

Adds $options as default options without overriding any options already set.

public withKeepExistingOptions(array<string, scalar|null> $options) : static
Parameters
$options : array<string, scalar|null>
Return values
static

withOptions()

public withOptions(array<string, scalar|null> $options) : static
Parameters
$options : array<string, scalar|null>
Return values
static 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results