comparison vendor/nikic/php-parser/lib/PhpParser/Node.php @ 13:5fb285c0d0e3

Update Drupal core to 8.4.7 via Composer. Security update; I *think* we've
been lucky to get away with this so far, as we don't support self-registration
which seems to be used by the so-called "drupalgeddon 2" attack that 8.4.5
was vulnerable to.

-<?php
+<?php declare(strict_types=1);
 
 namespace PhpParser;
 
 interface Node
 {
     /**
      * Gets the type of the node.
      *
      * @return string Type of the node
      */
-    public function getType();
+    public function getType() : string;
 
     /**
      * Gets the names of the sub nodes.
      *
      * @return array Names of sub nodes
      */
-    public function getSubNodeNames();
+    public function getSubNodeNames() : array;
+
+    /**
+     * Gets line the node started in (alias of getStartLine).
+     *
+     * @return int Start line (or -1 if not available)
+     */
+    public function getLine() : int;
 
     /**
      * Gets line the node started in.
      *
-     * @return int Line
+     * Requires the 'startLine' attribute to be enabled in the lexer (enabled by default).
+     *
+     * @return int Start line (or -1 if not available)
      */
-    public function getLine();
+    public function getStartLine() : int;
 
     /**
-     * Sets line the node started in.
+     * Gets the line the node ended in.
      *
-     * @param int $line Line
+     * Requires the 'endLine' attribute to be enabled in the lexer (enabled by default).
      *
-     * @deprecated
+     * @return int End line (or -1 if not available)
      */
-    public function setLine($line);
+    public function getEndLine() : int;
+
+    /**
+     * Gets the token offset of the first token that is part of this node.
+     *
+     * The offset is an index into the array returned by Lexer::getTokens().
+     *
+     * Requires the 'startTokenPos' attribute to be enabled in the lexer (DISABLED by default).
+     *
+     * @return int Token start position (or -1 if not available)
+     */
+    public function getStartTokenPos() : int;
+
+    /**
+     * Gets the token offset of the last token that is part of this node.
+     *
+     * The offset is an index into the array returned by Lexer::getTokens().
+     *
+     * Requires the 'endTokenPos' attribute to be enabled in the lexer (DISABLED by default).
+     *
+     * @return int Token end position (or -1 if not available)
+     */
+    public function getEndTokenPos() : int;
+
+    /**
+     * Gets the file offset of the first character that is part of this node.
+     *
+     * Requires the 'startFilePos' attribute to be enabled in the lexer (DISABLED by default).
+     *
+     * @return int File start position (or -1 if not available)
+     */
+    public function getStartFilePos() : int;
+
+    /**
+     * Gets the file offset of the last character that is part of this node.
+     *
+     * Requires the 'endFilePos' attribute to be enabled in the lexer (DISABLED by default).
+     *
+     * @return int File end position (or -1 if not available)
+     */
+    public function getEndFilePos() : int;
+
+    /**
+     * Gets all comments directly preceding this node.
+     *
+     * The comments are also available through the "comments" attribute.
+     *
+     * @return Comment[]
+     */
+    public function getComments() : array;
 
     /**
      * Gets the doc comment of the node.
      *
      * The doc comment has to be the last comment associated with the node.

      * Sets an attribute on a node.
      *
      * @param string $key
      * @param mixed  $value
      */
-    public function setAttribute($key, $value);
+    public function setAttribute(string $key, $value);
 
     /**
      * Returns whether an attribute exists.
      *
      * @param string $key
      *
      * @return bool
      */
-    public function hasAttribute($key);
+    public function hasAttribute(string $key) : bool;
 
     /**
      * Returns the value of an attribute.
      *
      * @param string $key
      * @param mixed  $default
      *
      * @return mixed
      */
-    public function &getAttribute($key, $default = null);
+    public function getAttribute(string $key, $default = null);
 
     /**
-     * Returns all attributes for the given node.
+     * Returns all the attributes of this node.
      *
      * @return array
      */
-    public function getAttributes();
+    public function getAttributes() : array;
+
+    /**
+     * Replaces all the attributes of this node.
+     *
+     * @param array $attributes
+     */
+    public function setAttributes(array $attributes);
 }