Deprecate Node::getLine() in favor of Node::getStartLine()

nikic · Sep 17, 2023 · 1873020 · 1873020
1 parent 1b346f7
commit 1873020
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -29,6 +29,10 @@ See UPGRADE-5.0 for detailed migration instructions.
   have been removed. Use `Comment::getStartLine()`, `Comment::getStartTokenPos()` and
   `Comment::getStartFilePos()` instead.
 
+### Deprecated
+
+* The `Node::getLine()` method has been deprecated. Use `Node::getStartLine()` instead.
+
 Version 5.0.0-alpha3 (2023-06-24)
 ---------------------------------
 

diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -292,3 +292,4 @@ Additionally, the token array is now terminated by a sentinel token with ID 0.
  * The deprecated `Error` constructor taking a start line has been removed. Pass `['startLine' => $startLine]` attributes instead.
  * The deprecated `Comment::getLine()`, `Comment::getTokenPos()` and `Comment::getFilePos()` methods have been removed. Use `Comment::getStartLine()`, `Comment::getStartTokenPos()` and `Comment::getStartFilePos()` instead.
  * `Comment::getReformattedText()` now normalizes CRLF newlines to LF newlines.
+ * The `Node::getLine()` method has been deprecated. Use `Node::getStartLine()` instead.
diff --git a/lib/PhpParser/Node.php b/lib/PhpParser/Node.php
@@ -21,6 +21,8 @@ public function getSubNodeNames(): array;
      * Gets line the node started in (alias of getStartLine).
      *
      * @return int Start line (or -1 if not available)
+     *
+     * @deprecated Use getStartLine() instead
      */
     public function getLine(): int;