CitationInlineNode
extends AnnotationInlineNode
in package
FinalYes
This node represents a citation inline a text
Lorem ipsum [Ref]_ dolor sit amet.
.. [Ref] Book or article reference, URL or whatever.
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#citations
Table of Contents
Constants
- TYPE = 'citation_inline'
Properties
- $classes : array<string|int, string>
- $internalTarget : InternalTarget|null
- $options : array<string, scalar|null>
- $value : TValue
- $name : string
- $type : string
Methods
- __construct() : mixed
- getClasses() : array<string|int, string>
- getClassesString() : string
- getInternalTarget() : InternalTarget|null
- getName() : string
- getOption() : mixed
- getOptions() : array<string, scalar|null>
- getType() : string
- getValue() : TValue
- hasOption() : bool
- setClasses() : void
- Normalizes class names following the rules of identifier-normalization
- setInternalTarget() : void
- setValue() : void
- toString() : string
- withKeepExistingOptions() : static
- Adds $options as default options without overriding any options already set.
- withOptions() : static
Constants
TYPE
public
final mixed
TYPE
= 'citation_inline'
Properties
$classes
protected
array<string|int, string>
$classes
= []
$internalTarget
protected
InternalTarget|null
$internalTarget
= null
$options
protected
array<string, scalar|null>
$options
= []
$value
protected
TValue
$value
$name read-only
private
string
$name
$type read-only
private
string
$type
Methods
__construct()
public
__construct(string $value, string $name) : mixed
Parameters
- $value : string
- $name : string
getClasses()
public
getClasses() : array<string|int, string>
Return values
array<string|int, string>getClassesString()
public
getClassesString() : string
Return values
stringgetInternalTarget()
public
getInternalTarget() : InternalTarget|null
Return values
InternalTarget|nullgetName()
public
getName() : string
Return values
stringgetOption()
public
getOption(string $name[, TType|null $default = null ]) : mixed
Parameters
- $name : string
- $default : TType|null = null
Tags
getOptions()
public
getOptions() : array<string, scalar|null>
Return values
array<string, scalar|null>getType()
public
getType() : string
Return values
stringgetValue()
public
getValue() : TValue
Return values
TValuehasOption()
public
hasOption(string $name) : bool
Parameters
- $name : string
Return values
boolsetClasses()
Normalizes class names following the rules of identifier-normalization
public
setClasses(array<string|int, string> $classes) : void
Parameters
- $classes : array<string|int, string>
Tags
setInternalTarget()
public
setInternalTarget(InternalTarget|null $internalTarget) : void
Parameters
- $internalTarget : InternalTarget|null
setValue()
public
setValue(TValue $value) : void
Parameters
- $value : TValue
toString()
public
toString() : string
Return values
stringwithKeepExistingOptions()
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
staticwithOptions()
public
withOptions(array<string, scalar|null> $options) : static
Parameters
- $options : array<string, scalar|null>