\PhpParser\NodeName

__construct()

__construct(string|array|self  $name, array  $attributes = array()) 

Constructs a name node.

Parameters

getType()

getType() : string

Gets the type of the node.

Returns

Type of the node

getLine()

getLine() : integer

Gets line the node started in.

Returns

Line

setLine()

setLine(integer  $line) 

Sets line the node started in.

Parameters

getDocComment()

getDocComment() : null|\PhpParser\Comment\Doc

Gets the doc comment of the node.

The doc comment has to be the last comment associated with the node.

Returns

Doc comment object or null

setDocComment()

setDocComment(\PhpParser\Comment\Doc  $docComment) 

Sets the doc comment of the node.

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

Parameters

setAttribute()

setAttribute(string  $key, mixed  $value) 

Sets an attribute on a node.

Parameters

hasAttribute()

hasAttribute(string  $key) : boolean

Returns whether an attribute exists.

Parameters

Returns

getAttribute()

getAttribute(string  $key, mixed  $default = null) : mixed

Returns the value of an attribute.

Parameters

Returns

getAttributes()

getAttributes() : array

Returns all attributes for the given node.

Returns

jsonSerialize()

jsonSerialize() 

getSubNodeNames()

getSubNodeNames() 

getFirst()

getFirst() : string

Gets the first part of the name, i.e. everything before the first namespace separator.

Returns

First part of the name

getLast()

getLast() : string

Gets the last part of the name, i.e. everything after the last namespace separator.

Returns

Last part of the name

isUnqualified()

isUnqualified() : boolean

Checks whether the name is unqualified. (E.g. Name)

Returns

Whether the name is unqualified

isQualified()

isQualified() : boolean

Checks whether the name is qualified. (E.g. Name\Name)

Returns

Whether the name is qualified

isFullyQualified()

isFullyQualified() : boolean

Checks whether the name is fully qualified. (E.g. \Name)

Returns

Whether the name is fully qualified

isRelative()

isRelative() : boolean

Checks whether the name is explicitly relative to the current namespace. (E.g. namespace\Name)

Returns

Whether the name is relative

toString()

toString() : string

Returns a string representation of the name by imploding the namespace parts with the namespace separator.

Returns

String representation

__toString()

__toString() : string

Returns a string representation of the name by imploding the namespace parts with the namespace separator.

Returns

String representation

slice()

slice(integer  $offset, integer|null  $length = null) : static|null

Gets a slice of a name (similar to array_slice).

This method returns a new instance of the same type as the original and with the same attributes.

If the slice is empty, null is returned. The null value will be correctly handled in concatenations using concat().

Offset and length have the same meaning as in array_slice().

Parameters

Returns

Sliced name

concat()

concat(string|array|self|null  $name1, string|array|self|null  $name2, array  $attributes = array()) : static|null

Concatenate two names, yielding a new Name instance.

The type of the generated instance depends on which class this method is called on, for example Name\FullyQualified::concat() will yield a Name\FullyQualified instance.

If one of the arguments is null, a new instance of the other name will be returned. If both arguments are null, null will be returned. As such, writing Name::concat($namespace, $shortName) where $namespace is a Name node or null will work as expected.

Parameters

Returns

Concatenated name

prepareName()

prepareName(string|array|self  $name) : array

Prepares a (string, array or Name node) name for use in name changing methods by converting it to an array.

Parameters

Returns

Prepared name