2011-05-27 18:20:44 +02:00
|
|
|
<?php
|
|
|
|
|
2014-02-06 14:44:16 +01:00
|
|
|
namespace PhpParser\Node\Stmt;
|
|
|
|
|
|
|
|
use PhpParser\Node;
|
2015-06-01 18:32:25 +02:00
|
|
|
use PhpParser\Node\FunctionLike;
|
2014-02-06 14:44:16 +01:00
|
|
|
|
2017-01-20 23:45:54 +01:00
|
|
|
/**
|
|
|
|
* @property Node\Name $namespacedName Namespaced name (if using NameResolver)
|
|
|
|
*/
|
2015-06-01 18:32:25 +02:00
|
|
|
class Function_ extends Node\Stmt implements FunctionLike
|
2011-05-27 18:20:44 +02:00
|
|
|
{
|
2015-02-28 18:44:28 +01:00
|
|
|
/** @var bool Whether function returns by reference */
|
|
|
|
public $byRef;
|
2017-04-28 19:09:39 +02:00
|
|
|
/** @var Node\Identifier Name */
|
2015-02-28 18:44:28 +01:00
|
|
|
public $name;
|
|
|
|
/** @var Node\Param[] Parameters */
|
|
|
|
public $params;
|
2017-04-28 19:09:39 +02:00
|
|
|
/** @var null|Node\Identifier|Node\Name|Node\NullableType Return type */
|
2015-03-12 13:17:31 +01:00
|
|
|
public $returnType;
|
2017-01-19 22:46:28 +01:00
|
|
|
/** @var Node\Stmt[] Statements */
|
2015-02-28 18:44:28 +01:00
|
|
|
public $stmts;
|
|
|
|
|
2011-10-28 19:06:24 +02:00
|
|
|
/**
|
|
|
|
* Constructs a function node.
|
|
|
|
*
|
2017-04-28 19:09:39 +02:00
|
|
|
* @param string|Node\Identifier $name Name
|
2012-04-29 23:32:09 +02:00
|
|
|
* @param array $subNodes Array of the following optional subnodes:
|
2015-03-12 13:17:31 +01:00
|
|
|
* 'byRef' => false : Whether to return by reference
|
|
|
|
* 'params' => array(): Parameters
|
|
|
|
* 'returnType' => null : Return type
|
|
|
|
* 'stmts' => array(): Statements
|
2012-04-29 23:32:09 +02:00
|
|
|
* @param array $attributes Additional attributes
|
2011-10-28 19:06:24 +02:00
|
|
|
*/
|
2012-04-29 23:32:09 +02:00
|
|
|
public function __construct($name, array $subNodes = array(), array $attributes = array()) {
|
2015-05-02 22:17:34 +02:00
|
|
|
parent::__construct($attributes);
|
2017-04-24 22:32:40 +02:00
|
|
|
$this->byRef = $subNodes['byRef'] ?? false;
|
2017-04-28 19:09:39 +02:00
|
|
|
$this->name = \is_string($name) ? new Node\Identifier($name) : $name;
|
2017-04-24 22:32:40 +02:00
|
|
|
$this->params = $subNodes['params'] ?? array();
|
2017-04-28 19:09:39 +02:00
|
|
|
$returnType = $subNodes['returnType'] ?? null;
|
|
|
|
$this->returnType = \is_string($returnType) ? new Node\Identifier($returnType) : $returnType;
|
2017-04-24 22:32:40 +02:00
|
|
|
$this->stmts = $subNodes['stmts'] ?? array();
|
2015-02-28 18:44:28 +01:00
|
|
|
}
|
|
|
|
|
2017-04-28 21:40:59 +02:00
|
|
|
public function getSubNodeNames() : array {
|
2015-03-12 13:17:31 +01:00
|
|
|
return array('byRef', 'name', 'params', 'returnType', 'stmts');
|
2011-10-28 19:06:24 +02:00
|
|
|
}
|
2015-06-01 18:32:25 +02:00
|
|
|
|
2017-04-28 21:40:59 +02:00
|
|
|
public function returnsByRef() : bool {
|
2015-06-01 18:32:25 +02:00
|
|
|
return $this->byRef;
|
|
|
|
}
|
|
|
|
|
2017-04-28 21:40:59 +02:00
|
|
|
public function getParams() : array {
|
2015-06-01 18:32:25 +02:00
|
|
|
return $this->params;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getReturnType() {
|
|
|
|
return $this->returnType;
|
|
|
|
}
|
|
|
|
|
2017-05-07 19:54:32 +02:00
|
|
|
/** @return Node\Stmt[] */
|
2017-04-28 21:40:59 +02:00
|
|
|
public function getStmts() : array {
|
2015-06-01 18:32:25 +02:00
|
|
|
return $this->stmts;
|
|
|
|
}
|
2015-02-28 18:44:28 +01:00
|
|
|
}
|