\PhpParser\BuilderClass_

Summary

Methods

Properties

Constants

addStmt()
addStmts()
setDocComment()
__construct()
extend()
implement()
makeAbstract()
makeFinal()
getNode()

No public properties found

No constants found

normalizeNode()
normalizeName()
normalizeType()
normalizeValue()
normalizeDocComment()
setModifier()

$attributes
$name
$extends
$implements
$flags
$uses
$constants
$properties
$methods

N/A

No private methods found

No private properties found

N/A

Properties

$attributes

$attributes :

Type

$name

$name :

Type

$extends

$extends :

Type

$implements

$implements :

Type

$flags

$flags :

Type

$uses

$uses :

Type

$constants

$constants :

Type

$properties

$properties :

Type

$methods

$methods :

Type

Methods

addStmt()

addStmt(\PhpParser\Node\Stmt|\PhpParser\Builder  $stmt) : $this

Adds a statement.

Parameters

\PhpParser\Node\Stmt|\PhpParser\Builder

$stmt

The statement to add

Returns

$this —

The builder instance (for fluid interface)

addStmts()

addStmts(array  $stmts) : $this

Adds multiple statements.

Parameters

array

$stmts

The statements to add

Returns

$this —

The builder instance (for fluid interface)

setDocComment()

setDocComment(\PhpParser\Comment\Doc|string  $docComment) : $this

Sets doc comment for the declaration.

Parameters

\PhpParser\Comment\Doc|string

$docComment

Doc comment to set

Returns

$this —

The builder instance (for fluid interface)

__construct()

__construct(string  $name)

Creates a class builder.

Parameters

string

$name

Name of the class

extend()

extend(\PhpParser\Node\Name|string  $class) : $this

Extends a class.

Parameters

\PhpParser\Node\Name|string

$class

Name of class to extend

Returns

$this —

The builder instance (for fluid interface)

implement()

implement() : $this

Implements one or more interfaces.

Returns

$this —

The builder instance (for fluid interface)

makeAbstract()

makeAbstract() : $this

Makes the class abstract.

Returns

$this —

The builder instance (for fluid interface)

makeFinal()

makeFinal() : $this

Makes the class final.

Returns

$this —

The builder instance (for fluid interface)

getNode()

getNode() : \PhpParser\Node\Stmt\Class_

Returns the built class node.

Returns

\PhpParser\Node\Stmt\Class_ —

The built class 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