$attributes
$attributes :
addStmt(\PhpParser\Node\Stmt|\PhpParser\Builder $stmt) : $this
Adds a statement.
\PhpParser\Node\Stmt|\PhpParser\Builder | $stmt | The statement to add |
The builder instance (for fluid interface)
setDocComment(\PhpParser\Comment\Doc|string $docComment) : $this
Sets doc comment for the declaration.
\PhpParser\Comment\Doc|string | $docComment | Doc comment to set |
The builder instance (for fluid interface)
extend(\PhpParser\Node\Name|string $class) : $this
Extends a class.
\PhpParser\Node\Name|string | $class | Name of class to extend |
The builder instance (for fluid interface)
getNode() : \PhpParser\Node\Stmt\Class_
Returns the built class node.
The built class node
normalizeNode(\PhpParser\Node|\PhpParser\Builder $node) : \PhpParser\Node
Normalizes a node: Converts builder objects to nodes.
\PhpParser\Node|\PhpParser\Builder | $node | The node to normalize |
The normalized node
normalizeName(\PhpParser\Node\Name|string $name) : \PhpParser\Node\Name
Normalizes a name: Converts plain string names to PhpParser\Node\Name.
\PhpParser\Node\Name|string | $name | The name to normalize |
The normalized name
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.
\PhpParser\Node\Name|string|\PhpParser\Node\NullableType | $type | The type to normalize |
The normalized type
normalizeValue(mixed $value) : \PhpParser\Node\Expr
Normalizes a value: Converts nulls, booleans, integers, floats, strings and arrays into their respective nodes
mixed | $value | The value to normalize |
The normalized value
normalizeDocComment(\PhpParser\Comment\Doc|string $docComment) : \PhpParser\Comment\Doc
Normalizes a doc comment: Converts plain strings to PhpParser\Comment\Doc.
\PhpParser\Comment\Doc|string | $docComment | The doc comment to normalize |
The normalized doc comment
<?php
namespace PhpParser\Builder;
use PhpParser;
use PhpParser\Node\Name;
use PhpParser\Node\Stmt;
class Class_ extends Declaration
{
protected $name;
protected $extends = null;
protected $implements = array();
protected $flags = 0;
protected $uses = array();
protected $constants = array();
protected $properties = array();
protected $methods = array();
/**
* Creates a class builder.
*
* @param string $name Name of the class
*/
public function __construct($name) {
$this->name = $name;
}
/**
* Extends a class.
*
* @param Name|string $class Name of class to extend
*
* @return $this The builder instance (for fluid interface)
*/
public function extend($class) {
$this->extends = $this->normalizeName($class);
return $this;
}
/**
* Implements one or more interfaces.
*
* @param Name|string ...$interfaces Names of interfaces to implement
*
* @return $this The builder instance (for fluid interface)
*/
public function implement() {
foreach (func_get_args() as $interface) {
$this->implements[] = $this->normalizeName($interface);
}
return $this;
}
/**
* Makes the class abstract.
*
* @return $this The builder instance (for fluid interface)
*/
public function makeAbstract() {
$this->setModifier(Stmt\Class_::MODIFIER_ABSTRACT);
return $this;
}
/**
* Makes the class final.
*
* @return $this The builder instance (for fluid interface)
*/
public function makeFinal() {
$this->setModifier(Stmt\Class_::MODIFIER_FINAL);
return $this;
}
/**
* Adds a statement.
*
* @param Stmt|PhpParser\Builder $stmt The statement to add
*
* @return $this The builder instance (for fluid interface)
*/
public function addStmt($stmt) {
$stmt = $this->normalizeNode($stmt);
$targets = array(
'Stmt_TraitUse' => &$this->uses,
'Stmt_ClassConst' => &$this->constants,
'Stmt_Property' => &$this->properties,
'Stmt_ClassMethod' => &$this->methods,
);
$type = $stmt->getType();
if (!isset($targets[$type])) {
throw new \LogicException(sprintf('Unexpected node of type "%s"', $type));
}
$targets[$type][] = $stmt;
return $this;
}
/**
* Returns the built class node.
*
* @return Stmt\Class_ The built class node
*/
public function getNode() {
return new Stmt\Class_($this->name, array(
'flags' => $this->flags,
'extends' => $this->extends,
'implements' => $this->implements,
'stmts' => array_merge($this->uses, $this->constants, $this->properties, $this->methods),
), $this->attributes);
}
}