Guides

TocDepthNode extends MetadataNode
in package

FinalYes

The maximum depth for a table of contents of this file.

.. note:: This metadata effects to the depth of local toctree. But it does not effect to the depth of global toctree. So this would not be change the sidebar of some themes which uses global one.

Table of Contents

Properties

$classes  : array<string|int, string>
$options  : array<string, scalar|null>
$value  : TValue

Methods

__construct()  : mixed
getClasses()  : array<string|int, string>
getClassesString()  : string
getOption()  : mixed
getOptions()  : array<string, scalar|null>
getValue()  : TValue
hasOption()  : bool
setClasses()  : void
Normalizes class names following the rules of identifier-normalization
setValue()  : void
toString()  : string
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(int $value) : mixed
Parameters
$value : int

getClasses()

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

getClassesString()

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

getValue()

public getValue() : TValue
Return values
TValue

hasOption()

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

setValue()

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

toString()

public toString() : string
Return values
string

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