Guides

CardGridNode extends GeneralDirectiveNode
in package

FinalYes

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

Table of Contents

Properties

$classes  : array<string|int, string>
$content  : InlineCompoundNode
$name  : string
$options  : array<string, scalar|null>
$plainContent  : string
$value  : TValue
$cardHeight  : int
$columns  : int
$columnsLg  : int
$columnsMd  : int
$columnsSm  : int
$columnsXl  : int
$gap  : int

Methods

__construct()  : mixed
addChildNode()  : void
getCardHeight()  : int
getChildren()  : array<string|int, TValue>
getClasses()  : array<string|int, string>
getClassesString()  : string
getColumns()  : int
getColumnsLg()  : int
getColumnsMd()  : int
getColumnsSm()  : int
getColumnsXl()  : int
getContent()  : InlineCompoundNode
getGap()  : int
getName()  : 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

Properties

$classes

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

$options

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

Methods

__construct()

public __construct(string $name, string $plainContent, InlineCompoundNode $content[, array<int, Node> $value = [] ][, int $columns = 0 ][, int $columnsSm = 0 ][, int $columnsMd = 0 ][, int $columnsLg = 0 ][, int $columnsXl = 0 ][, int $gap = 0 ][, int $cardHeight = 0 ]) : mixed
Parameters
$name : string
$plainContent : string
$content : InlineCompoundNode
$value : array<int, Node> = []
$columns : int = 0
$columnsSm : int = 0
$columnsMd : int = 0
$columnsLg : int = 0
$columnsXl : int = 0
$gap : int = 0
$cardHeight : int = 0

addChildNode()

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

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

getColumns()

public getColumns() : int
Return values
int

getColumnsLg()

public getColumnsLg() : int
Return values
int

getColumnsMd()

public getColumnsMd() : int
Return values
int

getColumnsSm()

public getColumnsSm() : int
Return values
int

getColumnsXl()

public getColumnsXl() : int
Return values
int

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>

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