class Function_
Same name in this branch
- 11.1.x vendor/nikic/php-parser/lib/PhpParser/Node/Scalar/MagicConst/Function_.php \PhpParser\Node\Scalar\MagicConst\Function_
- 11.1.x vendor/nikic/php-parser/lib/PhpParser/Node/Stmt/Function_.php \PhpParser\Node\Stmt\Function_
- 11.1.x vendor/nikic/php-parser/lib/PhpParser/Builder/Function_.php \PhpParser\Builder\Function_
Abstract class for functions.
@author Marco Marchiò <marco.mm89@gmail.com>
Hierarchy
- class \Peast\Syntax\Node\Node implements \Peast\Syntax\Node\JSONSerializable
- class \Peast\Syntax\Node\Function_ extends \Peast\Syntax\Node\Node
Expanded class hierarchy of Function_
File
-
vendor/
mck89/ peast/ lib/ Peast/ Syntax/ Node/ Function_.php, line 17
Namespace
Peast\Syntax\NodeView source
abstract class Function_ extends Node {
/**
* Map of node properties
*
* @var array
*/
protected $propertiesMap = array(
"id" => true,
"params" => true,
"body" => true,
"generator" => false,
"async" => false,
);
/**
* Function name
*
* @var Identifier
*/
protected $id;
/**
* Function parameters array
*
* @var Pattern[]
*/
protected $params = array();
/**
* Function body
*
* @var BlockStatement
*/
protected $body;
/**
* Generator flag that is true when the function is a generator
*
* @var bool
*/
protected $generator = false;
/**
* Async flag that is true when it is an async function
*
* @var bool
*/
protected $async = false;
/**
* Returns function name
*
* @return Identifier
*/
public function getId() {
return $this->id;
}
/**
* Sets function name
*
* @param Identifier $id Function name
*
* @return $this
*/
public function setId($id) {
$this->assertType($id, "Identifier", true);
$this->id = $id;
return $this;
}
/**
* Returns function parameters array
*
* @return Pattern[]
*/
public function getParams() {
return $this->params;
}
/**
* Sets function parameters array
*
* @param Pattern[] $params Function parameters array
*
* @return $this
*/
public function setParams($params) {
$this->assertArrayOf($params, "Pattern");
$this->params = $params;
return $this;
}
/**
* Returns function body
*
* @return BlockStatement
*/
public function getBody() {
return $this->body;
}
/**
* Sets function body
*
* @param BlockStatement $body Function body
*
* @return $this
*/
public function setBody($body) {
$this->assertType($body, "BlockStatement");
$this->body = $body;
return $this;
}
/**
* Returns the generator flag that is true when the function is a generator
*
* @return bool
*/
public function getGenerator() {
return $this->generator;
}
/**
* Sets the generator flag that is true when the function is a generator
*
* @param bool $generator Generator flag
*
* @return $this
*/
public function setGenerator($generator) {
$this->generator = (bool) $generator;
return $this;
}
/**
* Returns the async flag that is true when it is an async function
*
* @return bool
*/
public function getAsync() {
return $this->async;
}
/**
* Sets the async flag that is true when it is an async function
*
* @param bool $async Async flag
*
* @return $this
*/
public function setAsync($async) {
$this->async = (bool) $async;
return $this;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
Function_::$async | protected | property | Async flag that is true when it is an async function | ||
Function_::$body | protected | property | Function body | ||
Function_::$generator | protected | property | Generator flag that is true when the function is a generator | ||
Function_::$id | protected | property | Function name | ||
Function_::$params | protected | property | Function parameters array | ||
Function_::$propertiesMap | protected | property | Map of node properties | Overrides Node::$propertiesMap | 1 |
Function_::getAsync | public | function | Returns the async flag that is true when it is an async function | ||
Function_::getBody | public | function | Returns function body | ||
Function_::getGenerator | public | function | Returns the generator flag that is true when the function is a generator | ||
Function_::getId | public | function | Returns function name | ||
Function_::getParams | public | function | Returns function parameters array | ||
Function_::setAsync | public | function | Sets the async flag that is true when it is an async function | ||
Function_::setBody | public | function | Sets function body | 1 | |
Function_::setGenerator | public | function | Sets the generator flag that is true when the function is a generator | ||
Function_::setId | public | function | Sets function name | 1 | |
Function_::setParams | public | function | Sets function parameters array | ||
Node::$leadingComments | protected | property | Leading comments array | ||
Node::$location | public | property | Node location in the source code | ||
Node::$trailingComments | protected | property | Trailing comments array | ||
Node::assertArrayOf | protected | function | Asserts that the given value is an array of defined type | ||
Node::assertType | protected | function | Asserts that the given value respects the defined type | ||
Node::getLeadingComments | public | function | Returns leading comments array | ||
Node::getLocation | public | function | Returns node location in the source code | ||
Node::getTrailingComments | public | function | Returns trailing comments array | ||
Node::getType | public | function | Returns node type | 2 | |
Node::jsonSerialize | public | function | Returns a serializable version of the node | 2 | |
Node::render | public | function | Renders the current node | ||
Node::setEndPosition | public | function | Sets the end position of the node in the source code | ||
Node::setLeadingComments | public | function | Sets leading comments array | 1 | |
Node::setStartPosition | public | function | Sets the start position of the node in the source code | ||
Node::setTrailingComments | public | function | Sets trailing comments array | 1 | |
Node::traverse | public | function | Traverses the current node and all its child nodes using the given function |
||
Node::typeError | protected | function | Throws an error if the defined type is not supported b | ||
Node::__construct | public | function | Class constructor |