$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)
getNode() : \PhpParser\Node\Stmt\Interface_
Returns the built interface node.
The built interface 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 Interface_ extends Declaration
{
protected $name;
protected $extends = array();
protected $constants = array();
protected $methods = array();
/**
* Creates an interface builder.
*
* @param string $name Name of the interface
*/
public function __construct($name) {
$this->name = $name;
}
/**
* Extends one or more interfaces.
*
* @param Name|string ...$interfaces Names of interfaces to extend
*
* @return $this The builder instance (for fluid interface)
*/
public function extend() {
foreach (func_get_args() as $interface) {
$this->extends[] = $this->normalizeName($interface);
}
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);
$type = $stmt->getType();
switch ($type) {
case 'Stmt_ClassConst':
$this->constants[] = $stmt;
break;
case 'Stmt_ClassMethod':
// we erase all statements in the body of an interface method
$stmt->stmts = null;
$this->methods[] = $stmt;
break;
default:
throw new \LogicException(sprintf('Unexpected node of type "%s"', $type));
}
return $this;
}
/**
* Returns the built interface node.
*
* @return Stmt\Interface_ The built interface node
*/
public function getNode() {
return new Stmt\Interface_($this->name, array(
'extends' => $this->extends,
'stmts' => array_merge($this->constants, $this->methods),
), $this->attributes);
}
}