2011-04-18 19:02:30 +02:00
|
|
|
<?php
|
|
|
|
|
2014-02-06 14:44:16 +01:00
|
|
|
namespace PhpParser;
|
|
|
|
|
2016-07-25 20:57:53 +02:00
|
|
|
abstract class NodeAbstract implements Node, \JsonSerializable
|
2011-04-18 19:02:30 +02:00
|
|
|
{
|
2012-04-03 20:07:10 +02:00
|
|
|
protected $attributes;
|
2011-04-18 19:02:30 +02:00
|
|
|
|
2011-05-31 16:33:11 +02:00
|
|
|
/**
|
|
|
|
* Creates a Node.
|
|
|
|
*
|
2015-05-02 22:17:34 +02:00
|
|
|
* @param array $attributes Array of attributes
|
2011-05-31 16:33:11 +02:00
|
|
|
*/
|
2015-05-02 22:17:34 +02:00
|
|
|
public function __construct(array $attributes = array()) {
|
2012-04-29 23:32:09 +02:00
|
|
|
$this->attributes = $attributes;
|
2011-05-30 22:11:11 +02:00
|
|
|
}
|
|
|
|
|
2011-05-31 16:33:11 +02:00
|
|
|
/**
|
2011-09-21 21:43:19 +02:00
|
|
|
* Gets the type of the node.
|
2011-05-31 16:33:11 +02:00
|
|
|
*
|
2011-09-21 21:43:19 +02:00
|
|
|
* @return string Type of the node
|
2011-05-31 16:33:11 +02:00
|
|
|
*/
|
2011-05-27 18:20:44 +02:00
|
|
|
public function getType() {
|
2014-02-06 14:44:16 +01:00
|
|
|
return strtr(substr(rtrim(get_class($this), '_'), 15), '\\', '_');
|
2011-05-27 18:20:44 +02:00
|
|
|
}
|
|
|
|
|
2011-06-12 17:12:47 +02:00
|
|
|
/**
|
2011-06-28 14:11:12 +02:00
|
|
|
* Gets line the node started in.
|
2011-06-12 17:12:47 +02:00
|
|
|
*
|
|
|
|
* @return int Line
|
|
|
|
*/
|
|
|
|
public function getLine() {
|
2012-05-05 17:34:27 +02:00
|
|
|
return $this->getAttribute('startLine', -1);
|
2011-06-12 17:12:47 +02:00
|
|
|
}
|
2011-07-03 16:35:45 +02:00
|
|
|
|
2011-11-06 17:07:38 +01:00
|
|
|
/**
|
|
|
|
* Sets line the node started in.
|
|
|
|
*
|
|
|
|
* @param int $line Line
|
2017-04-29 12:58:35 +02:00
|
|
|
*
|
|
|
|
* @deprecated
|
2011-11-06 17:07:38 +01:00
|
|
|
*/
|
|
|
|
public function setLine($line) {
|
2012-05-05 17:34:27 +02:00
|
|
|
$this->setAttribute('startLine', (int) $line);
|
2011-11-06 17:07:38 +01:00
|
|
|
}
|
|
|
|
|
2011-07-03 16:35:45 +02:00
|
|
|
/**
|
2012-05-06 18:24:26 +02:00
|
|
|
* Gets the doc comment of the node.
|
2011-07-03 16:35:45 +02:00
|
|
|
*
|
2012-05-06 18:24:26 +02:00
|
|
|
* The doc comment has to be the last comment associated with the node.
|
|
|
|
*
|
2014-02-06 14:44:16 +01:00
|
|
|
* @return null|Comment\Doc Doc comment object or null
|
2011-07-03 16:35:45 +02:00
|
|
|
*/
|
|
|
|
public function getDocComment() {
|
2012-05-06 18:24:26 +02:00
|
|
|
$comments = $this->getAttribute('comments');
|
|
|
|
if (!$comments) {
|
|
|
|
return null;
|
|
|
|
}
|
2011-10-28 23:12:32 +02:00
|
|
|
|
2012-05-06 18:24:26 +02:00
|
|
|
$lastComment = $comments[count($comments) - 1];
|
2014-02-06 14:44:16 +01:00
|
|
|
if (!$lastComment instanceof Comment\Doc) {
|
2012-05-06 18:24:26 +02:00
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
return $lastComment;
|
2011-11-06 17:07:38 +01:00
|
|
|
}
|
2012-04-09 12:37:47 +02:00
|
|
|
|
2016-09-17 20:48:51 +02:00
|
|
|
/**
|
|
|
|
* Sets the doc comment of the node.
|
|
|
|
*
|
|
|
|
* This will either replace an existing doc comment or add it to the comments array.
|
|
|
|
*
|
|
|
|
* @param Comment\Doc $docComment Doc comment to set
|
|
|
|
*/
|
|
|
|
public function setDocComment(Comment\Doc $docComment) {
|
|
|
|
$comments = $this->getAttribute('comments', []);
|
|
|
|
|
|
|
|
$numComments = count($comments);
|
|
|
|
if ($numComments > 0 && $comments[$numComments - 1] instanceof Comment\Doc) {
|
|
|
|
// Replace existing doc comment
|
|
|
|
$comments[$numComments - 1] = $docComment;
|
|
|
|
} else {
|
|
|
|
// Append new comment
|
|
|
|
$comments[] = $docComment;
|
|
|
|
}
|
|
|
|
|
|
|
|
$this->setAttribute('comments', $comments);
|
|
|
|
}
|
|
|
|
|
2012-04-03 20:07:10 +02:00
|
|
|
public function setAttribute($key, $value) {
|
|
|
|
$this->attributes[$key] = $value;
|
|
|
|
}
|
2012-04-09 12:37:47 +02:00
|
|
|
|
2012-04-03 20:07:10 +02:00
|
|
|
public function hasAttribute($key) {
|
|
|
|
return array_key_exists($key, $this->attributes);
|
|
|
|
}
|
2012-04-09 12:37:47 +02:00
|
|
|
|
2012-05-06 18:24:26 +02:00
|
|
|
public function &getAttribute($key, $default = null) {
|
|
|
|
if (!array_key_exists($key, $this->attributes)) {
|
|
|
|
return $default;
|
|
|
|
} else {
|
|
|
|
return $this->attributes[$key];
|
|
|
|
}
|
2012-04-03 20:07:10 +02:00
|
|
|
}
|
2012-04-09 12:37:47 +02:00
|
|
|
|
2012-04-03 20:07:10 +02:00
|
|
|
public function getAttributes() {
|
|
|
|
return $this->attributes;
|
|
|
|
}
|
2016-07-25 20:57:53 +02:00
|
|
|
|
|
|
|
public function jsonSerialize() {
|
|
|
|
return ['nodeType' => $this->getType()] + get_object_vars($this);
|
|
|
|
}
|
2015-02-28 18:44:28 +01:00
|
|
|
}
|