Menu

## Const_ extends NodeAbstract
in package

Const_.php : 7

### Table of Contents

$name : Identifier
$namespacedName : Name
$value : Expr
$attributes : mixed
__construct() : mixed
  Constructs a const node for use in class const and const statements.
getAttribute() : mixed
  Returns the value of an attribute.
getAttributes() : array<string|int, mixed>
  Returns all the attributes of this node.
getComments() : array<string|int, Comment>
  Gets all comments directly preceding this node.
getDocComment() : null|Doc
  Gets the doc comment of the node.
getEndFilePos() : int
  Gets the file offset of the last character that is part of this node.
getEndLine() : int
  Gets the line the node ended in.
getEndTokenPos() : int
  Gets the token offset of the last token that is part of this node.
getLine() : int
  Gets line the node started in (alias of getStartLine).
getStartFilePos() : int
  Gets the file offset of the first character that is part of this node.
getStartLine() : int
  Gets line the node started in.
getStartTokenPos() : int
  Gets the token offset of the first token that is part of this node.
getSubNodeNames() : array<string|int, mixed>
getType() : string
hasAttribute() : bool
  Returns whether an attribute exists.
jsonSerialize() : array<string|int, mixed>
setAttribute() : mixed
  Sets an attribute on a node.
setAttributes() : mixed
  Replaces all the attributes of this node.
setDocComment() : mixed
  Sets the doc comment of the node.

### Properties

#### $name

Const_.php : 10
`public Identifier $name`

Name

#### $namespacedName

Const_.php : 15
`public Name $namespacedName`

Namespaced name (if using NameResolver)

#### $value

Const_.php : 12
`public Expr $value`

Value

#### $attributes

NodeAbstract.php : 7
`protected mixed $attributes`

### Methods

#### __construct()

Const_.php : 24

Constructs a const node for use in class const and const statements.

`public __construct(string|Identifier $name, Expr $value[, array<string|int, mixed> $attributes = [] ]) : mixed`

##### Parameters

$name : string|Identifier

  Name

$value : Expr

  Value

$attributes : array<string|int, mixed> = []

  Additional attributes

##### Return values

mixed —

#### getAttribute()

NodeAbstract.php : 156

Returns the value of an attribute.

`public getAttribute(string $key[, mixed $default = null ]) : mixed`

##### Parameters

$key : string
$default : mixed = null

##### Return values

mixed —

#### getAttributes()

NodeAbstract.php : 164

Returns all the attributes of this node.

`public getAttributes() : array<string|int, mixed>`

##### Return values

array<string|int, mixed> —

#### getComments()

NodeAbstract.php : 104

Gets all comments directly preceding this node.

`public getComments() : array<string|int, Comment>`

The comments are also available through the "comments" attribute.

##### Return values

array<string|int, Comment> —

#### getDocComment()

NodeAbstract.php : 113

Gets the doc comment of the node.

`public getDocComment() : null|Doc`

##### Return values

null|Doc —

Doc comment object or null

#### getEndFilePos()

NodeAbstract.php : 93

Gets the file offset of the last character that is part of this node.

`public getEndFilePos() : int`

Requires the 'endFilePos' attribute to be enabled in the lexer (DISABLED by default).

##### Return values

int —

File end position (or -1 if not available)

#### getEndLine()

NodeAbstract.php : 45

Gets the line the node ended in.

`public getEndLine() : int`

Requires the 'endLine' attribute to be enabled in the lexer (enabled by default).

##### Return values

int —

End line (or -1 if not available)

#### getEndTokenPos()

NodeAbstract.php : 71

Gets the token offset of the last token that is part of this node.

`public getEndTokenPos() : int`

The offset is an index into the array returned by Lexer::getTokens().

Requires the 'endTokenPos' attribute to be enabled in the lexer (DISABLED by default).

##### Return values

int —

Token end position (or -1 if not available)

#### getLine()

NodeAbstract.php : 23

Gets line the node started in (alias of getStartLine).

`public getLine() : int`

##### Return values

int —

Start line (or -1 if not available)

#### getStartFilePos()

NodeAbstract.php : 82

Gets the file offset of the first character that is part of this node.

`public getStartFilePos() : int`

Requires the 'startFilePos' attribute to be enabled in the lexer (DISABLED by default).

##### Return values

int —

File start position (or -1 if not available)

#### getStartLine()

NodeAbstract.php : 34

Gets line the node started in.

`public getStartLine() : int`

Requires the 'startLine' attribute to be enabled in the lexer (enabled by default).

##### Return values

int —

Start line (or -1 if not available)

#### getStartTokenPos()

NodeAbstract.php : 58

Gets the token offset of the first token that is part of this node.

`public getStartTokenPos() : int`

The offset is an index into the array returned by Lexer::getTokens().

Requires the 'startTokenPos' attribute to be enabled in the lexer (DISABLED by default).

##### Return values

int —

Token start position (or -1 if not available)

#### getSubNodeNames()

Const_.php : 30
`public getSubNodeNames() : array<string|int, mixed>`

##### Return values

array<string|int, mixed> —

#### getType()

Const_.php : 34
`public getType() : string`

##### Return values

string —

#### hasAttribute()

NodeAbstract.php : 152

Returns whether an attribute exists.

`public hasAttribute(string $key) : bool`

##### Parameters

$key : string

##### Return values

bool —

#### jsonSerialize()

NodeAbstract.php : 175
`public jsonSerialize() : array<string|int, mixed>`

##### Return values

array<string|int, mixed> —

#### setAttribute()

NodeAbstract.php : 148

Sets an attribute on a node.

`public setAttribute(string $key, mixed $value) : mixed`

##### Parameters

$key : string
$value : mixed

##### Return values

mixed —

#### setAttributes()

NodeAbstract.php : 168

Replaces all the attributes of this node.

`public setAttributes(array<string|int, mixed> $attributes) : mixed`

##### Parameters

$attributes : array<string|int, mixed>

##### Return values

mixed —

#### setDocComment()

NodeAbstract.php : 132

Sets the doc comment of the node.

`public setDocComment(Doc $docComment) : mixed`

This will either replace an existing doc comment or add it to the comments array.

##### Parameters

$docComment : Doc

  Doc comment to set

##### Return values

mixed —

## Search results