Guides

AuthorNode extends AbstractNode
in package

FinalYes

The author element holds the name of the author of a document, section or code-block

Table of Contents

Constants

CONTEXT_CODE  = 'code'
CONTEXT_DOCUMENT  = 'document'
CONTEXT_SECTION  = 'section'

Properties

$classes  : array<string|int, string>
$options  : array<string, scalar|null>
$value  : TValue
$children  : array<string|int, mixed>
$context  : string
$email  : string|null

Methods

__construct()  : mixed
getChildren()  : array<string|int, Node>
getClasses()  : array<string|int, string>
getClassesString()  : string
getContext()  : string
getEmail()  : string|null
getOption()  : mixed
getOptions()  : array<string, scalar|null>
getValue()  : TValue
hasOption()  : bool
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

CONTEXT_DOCUMENT

public mixed CONTEXT_DOCUMENT = 'document'

CONTEXT_SECTION

public mixed CONTEXT_SECTION = 'section'

Properties

$classes

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

$options

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

$children read-only

private array<string|int, mixed> $children

$context read-only

private string $context = self::CONTEXT_DOCUMENT

Methods

__construct()

public __construct(string $value, array<string|int, Node> $children[, string $context = self::CONTEXT_DOCUMENT ][, string|null $email = null ]) : mixed
Parameters
$value : string
$children : array<string|int, Node>
$context : string = self::CONTEXT_DOCUMENT
$email : string|null = null

getChildren()

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

getClasses()

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

getClassesString()

public getClassesString() : string
Return values
string

getContext()

public getContext() : string
Return values
string

getEmail()

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

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

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