Guides

CardNode extends GeneralDirectiveNode
in package
implements LinkTargetNode, OptionalLinkTargetsNode, PrefixedLinkTargetNode

FinalYes

A catch-all directive Node containing all information about the original directive in rst.

Table of Contents

Interfaces

LinkTargetNode
OptionalLinkTargetsNode
Makes the implementing node an optional link target. If Noindex is true no references are generated, there is no entry in the objects index and no warning about duplicate ids.
PrefixedLinkTargetNode

Constants

LINK_PREFIX  = 'card-'
LINK_TYPE  = 'std:card'

Properties

$classes  : array<string|int, string>
$content  : InlineCompoundNode
$name  : string
$options  : array<string, scalar|null>
$plainContent  : string
$title  : TitleNode|null
$value  : TValue
$cardFooter  : CardFooterNode|null
$cardHeader  : CardHeaderNode|null
$cardHeight  : int
$cardImage  : CardImageNode|null
$id  : string

Methods

__construct()  : mixed
addChildNode()  : void
getAnchor()  : string
getCardFooter()  : CardFooterNode|null
getCardHeader()  : CardHeaderNode|null
getCardHeight()  : int
getCardImage()  : CardImageNode|null
getChildren()  : array<string|int, TValue>
getClasses()  : array<string|int, string>
getClassesString()  : string
getContent()  : InlineCompoundNode
getId()  : string
getLinkText()  : string
getLinkType()  : string
getName()  : string
getOption()  : mixed
getOptions()  : array<string, scalar|null>
getPlainContent()  : string
getPrefix()  : string
getTitle()  : TitleNode|null
getValue()  : TValue
hasOption()  : bool
isNoindex()  : bool
pushChildNode()  : void
removeNode()  : self
replaceNode()  : self
setCardHeight()  : CardNode
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

LINK_PREFIX

public mixed LINK_PREFIX = 'card-'

LINK_TYPE

public mixed LINK_TYPE = 'std:card'

Properties

$classes

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

$options

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

$plainContent read-only

protected string $plainContent

Methods

__construct()

public __construct(string $name, string $plainContent, InlineCompoundNode $content[, TitleNode|null $title = null ][, array<int, Node> $value = [] ][, CardHeaderNode|null $cardHeader = null ][, CardImageNode|null $cardImage = null ][, CardFooterNode|null $cardFooter = null ][, string $id = '' ][, int $cardHeight = 0 ]) : mixed
Parameters
$name : string
$plainContent : string
$content : InlineCompoundNode
$title : TitleNode|null = null
$value : array<int, Node> = []
$cardHeader : CardHeaderNode|null = null
$cardImage : CardImageNode|null = null
$cardFooter : CardFooterNode|null = null
$id : string = ''
$cardHeight : int = 0

addChildNode()

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

getAnchor()

public getAnchor() : string
Return values
string

getCardHeight()

public getCardHeight() : int
Return values
int

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

getName()

public getName() : 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

getPrefix()

public getPrefix() : string
Return values
string

getValue()

public getValue() : TValue
Return values
TValue

hasOption()

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

isNoindex()

public isNoindex() : bool
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