Properties

$name

$name : 

Type

$default

$default : 

Type

$byRef

$byRef : 

Type

$variadic

$variadic : 

Type

Methods

__construct()

__construct(string  $name) 

Creates a parameter builder.

Parameters

string $name

Name of the parameter

setDefault()

setDefault(mixed  $value) : $this

Sets default value for the parameter.

Parameters

mixed $value

Default value to use

Returns

$this —

The builder instance (for fluid interface)

setTypeHint()

setTypeHint(string|\PhpParser\Node\Name|\PhpParser\Node\NullableType  $type) : $this

Sets type hint for the parameter.

Parameters

string|\PhpParser\Node\Name|\PhpParser\Node\NullableType $type

Type hint to use

Returns

$this —

The builder instance (for fluid interface)

makeByRef()

makeByRef() : $this

Make the parameter accept the value by reference.

Returns

$this —

The builder instance (for fluid interface)

makeVariadic()

makeVariadic() : $this

Make the parameter variadic

Returns

$this —

The builder instance (for fluid interface)

getNode()

getNode() : \PhpParser\Node\Param

Returns the built parameter node.

Returns

\PhpParser\Node\Param

The built parameter node

normalizeNode()

normalizeNode(\PhpParser\Node|\PhpParser\Builder  $node) : \PhpParser\Node

Normalizes a node: Converts builder objects to nodes.

Parameters

\PhpParser\Node|\PhpParser\Builder $node

The node to normalize

Returns

\PhpParser\Node

The normalized node

normalizeName()

normalizeName(\PhpParser\Node\Name|string  $name) : \PhpParser\Node\Name

Normalizes a name: Converts plain string names to PhpParser\Node\Name.

Parameters

\PhpParser\Node\Name|string $name

The name to normalize

Returns

\PhpParser\Node\Name

The normalized name

normalizeType()

normalizeType(\PhpParser\Node\Name|string|\PhpParser\Node\NullableType  $type) : \PhpParser\Node\Name|string|\PhpParser\Node\NullableType

Normalizes a type: Converts plain-text type names into proper AST representation.

In particular, builtin types are left as strings, custom types become Names and nullables are wrapped in NullableType nodes.

Parameters

\PhpParser\Node\Name|string|\PhpParser\Node\NullableType $type

The type to normalize

Returns

\PhpParser\Node\Name|string|\PhpParser\Node\NullableType

The normalized type

normalizeValue()

normalizeValue(mixed  $value) : \PhpParser\Node\Expr

Normalizes a value: Converts nulls, booleans, integers, floats, strings and arrays into their respective nodes

Parameters

mixed $value

The value to normalize

Returns

\PhpParser\Node\Expr

The normalized value

normalizeDocComment()

normalizeDocComment(\PhpParser\Comment\Doc|string  $docComment) : \PhpParser\Comment\Doc

Normalizes a doc comment: Converts plain strings to PhpParser\Comment\Doc.

Parameters

\PhpParser\Comment\Doc|string $docComment

The doc comment to normalize

Returns

\PhpParser\Comment\Doc

The normalized doc comment

setModifier()

setModifier(integer  $modifier) 

Sets a modifier in the $this->type property.

Parameters

integer $modifier

Modifier to set