1
0
mirror of https://github.com/danog/PHP-Parser.git synced 2024-11-26 20:04:48 +01:00
PHP-Parser/lib/PhpParser/Node.php

87 lines
1.8 KiB
PHP
Raw Normal View History

2017-08-18 22:57:27 +02:00
<?php declare(strict_types=1);
2011-09-21 21:43:19 +02:00
namespace PhpParser;
interface Node
2011-09-21 21:43:19 +02:00
{
/**
* Gets the type of the node.
*
* @return string Type of the node
*/
2017-04-28 21:40:59 +02:00
public function getType() : string;
2011-09-21 21:43:19 +02:00
/**
* Gets the names of the sub nodes.
*
* @return array Names of sub nodes
*/
2017-04-28 21:40:59 +02:00
public function getSubNodeNames() : array;
2011-09-21 21:43:19 +02:00
/**
* Gets line the node started in.
*
* @return int Line
*/
2017-04-28 21:40:59 +02:00
public function getLine() : int;
2011-09-21 21:43:19 +02:00
/**
* Gets the doc comment of the node.
2011-09-21 21:43:19 +02:00
*
* The doc comment has to be the last comment associated with the node.
*
* @return null|Comment\Doc Doc comment object or null
*/
public function getDocComment();
/**
* 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);
/**
* Sets an attribute on a node.
*
* @param string $key
* @param mixed $value
*/
2017-04-28 21:40:59 +02:00
public function setAttribute(string $key, $value);
/**
* Returns whether an attribute exists.
*
* @param string $key
*
* @return bool
*/
2017-04-28 21:40:59 +02:00
public function hasAttribute(string $key) : bool;
/**
* Returns the value of an attribute.
*
* @param string $key
* @param mixed $default
*
* @return mixed
*/
2017-04-28 21:40:59 +02:00
public function &getAttribute(string $key, $default = null);
/**
2017-05-05 18:18:44 +02:00
* Returns all the attributes of this node.
*
* @return array
*/
2017-04-28 21:40:59 +02:00
public function getAttributes() : array;
2017-05-05 18:18:44 +02:00
/**
* Replaces all the attributes of this node.
*
* @param array $attributes
*/
public function setAttributes(array $attributes);
}