$name
$name :
setDocComment(\PhpParser\Comment\Doc|string $docComment) : $this
Sets doc comment for the property.
\PhpParser\Comment\Doc|string | $docComment | Doc comment to set |
The builder instance (for fluid interface)
getNode() : \PhpParser\Node\Stmt\Property
Returns the built class node.
The built property 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\Stmt;
class Property extends PhpParser\BuilderAbstract
{
protected $name;
protected $flags = 0;
protected $default = null;
protected $attributes = array();
/**
* Creates a property builder.
*
* @param string $name Name of the property
*/
public function __construct($name) {
$this->name = $name;
}
/**
* Makes the property public.
*
* @return $this The builder instance (for fluid interface)
*/
public function makePublic() {
$this->setModifier(Stmt\Class_::MODIFIER_PUBLIC);
return $this;
}
/**
* Makes the property protected.
*
* @return $this The builder instance (for fluid interface)
*/
public function makeProtected() {
$this->setModifier(Stmt\Class_::MODIFIER_PROTECTED);
return $this;
}
/**
* Makes the property private.
*
* @return $this The builder instance (for fluid interface)
*/
public function makePrivate() {
$this->setModifier(Stmt\Class_::MODIFIER_PRIVATE);
return $this;
}
/**
* Makes the property static.
*
* @return $this The builder instance (for fluid interface)
*/
public function makeStatic() {
$this->setModifier(Stmt\Class_::MODIFIER_STATIC);
return $this;
}
/**
* Sets default value for the property.
*
* @param mixed $value Default value to use
*
* @return $this The builder instance (for fluid interface)
*/
public function setDefault($value) {
$this->default = $this->normalizeValue($value);
return $this;
}
/**
* Sets doc comment for the property.
*
* @param PhpParser\Comment\Doc|string $docComment Doc comment to set
*
* @return $this The builder instance (for fluid interface)
*/
public function setDocComment($docComment) {
$this->attributes = array(
'comments' => array($this->normalizeDocComment($docComment))
);
return $this;
}
/**
* Returns the built class node.
*
* @return Stmt\Property The built property node
*/
public function getNode() {
return new Stmt\Property(
$this->flags !== 0 ? $this->flags : Stmt\Class_::MODIFIER_PUBLIC,
array(
new Stmt\PropertyProperty($this->name, $this->default)
),
$this->attributes
);
}
}