Guides

CodeNode extends TextNode
in package

FinalYes

Table of Contents

Properties

$classes  : array<string|int, string>
$language  : string|null
$options  : array<string, scalar|null>
$value  : TValue
$caption  : InlineCompoundNode|null
$emphasizeLines  : string|null
$startingLineNumber  : int|null

Methods

__construct()  : mixed
getCaption()  : InlineCompoundNode|null
getClasses()  : array<string|int, string>
getClassesString()  : string
getEmphasizeLines()  : string|null
getLanguage()  : string|null
getOption()  : mixed
getOptions()  : array<string, scalar|null>
getStartingLineNumber()  : int|null
getValue()  : TValue
hasOption()  : bool
setCaption()  : void
setClasses()  : void
Normalizes class names following the rules of identifier-normalization
setEmphasizeLines()  : void
setLanguage()  : void
setStartingLineNumber()  : void
setValue()  : void
toString()  : string
withKeepExistingOptions()  : static
Adds $options as default options without overriding any options already set.
withOptions()  : static
normalizeLines()  : string

Properties

$classes

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

$language

protected string|null $language = null

$options

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

$emphasizeLines

private string|null $emphasizeLines = null

$startingLineNumber

private int|null $startingLineNumber = null

The line number to start counting from and display, or null to hide line numbers

Methods

__construct()

public __construct(array<string|int, string> $lines[, string|null $language = null ]) : mixed
Parameters
$lines : array<string|int, string>
$language : string|null = null

getClasses()

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

getClassesString()

public getClassesString() : string
Return values
string

getEmphasizeLines()

public getEmphasizeLines() : string|null
Return values
string|null

getLanguage()

public getLanguage() : string|null
Return values
string|null

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>

getStartingLineNumber()

public getStartingLineNumber() : int|null
Return values
int|null

getValue()

public getValue() : TValue
Return values
TValue

hasOption()

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

setEmphasizeLines()

public setEmphasizeLines(string|null $emphasizeLines) : void
Parameters
$emphasizeLines : string|null

setLanguage()

public setLanguage([string|null $language = null ]) : void
Parameters
$language : string|null = null

setStartingLineNumber()

public setStartingLineNumber(int|null $lineNumber) : void
Parameters
$lineNumber : int|null

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

normalizeLines()

protected static normalizeLines(array<string|int, string> $lines) : string
Parameters
$lines : array<string|int, string>
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results