Declare more precise phpdoc types

nikic · Apr 12, 2024 · dce0f17 · dce0f17
1 parent 4d36e9c
commit dce0f17
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/lib/PhpParser/Node.php b/lib/PhpParser/Node.php
@@ -8,6 +8,7 @@ interface Node
      * Gets the type of the node.
      *
      * @return string Type of the node
+     * @psalm-return non-empty-string
      */
     public function getType() : string;
 

diff --git a/lib/PhpParser/Node/Name.php b/lib/PhpParser/Node/Name.php
@@ -8,6 +8,7 @@ class Name extends NodeAbstract
 {
     /**
      * @var string[] Parts of the name
+     * @psalm-var non-empty-array<string>
      * @deprecated Use getParts() instead
      */
     public $parts;
@@ -37,6 +38,7 @@ public function getSubNodeNames() : array {
      * Get parts of name (split by the namespace separator).
      *
      * @return string[] Parts of name
+     * @psalm-return non-empty-array<string>
      */
     public function getParts(): array {
         return $this->parts;
@@ -101,6 +103,7 @@ public function isRelative() : bool {
      * account (e.g., not including a leading backslash for fully qualified names).
      *
      * @return string String representation
+     * @psalm-return non-empty-string
      */
     public function toString() : string {
         return implode('\\', $this->parts);
@@ -111,6 +114,7 @@ public function toString() : string {
      * leading backslash for fully qualified names.
      *
      * @return string String representation
+     * @psalm-return non-empty-string
      */
     public function toCodeString() : string {
         return $this->toString();
@@ -121,6 +125,7 @@ public function toCodeString() : string {
      * account (e.g., no leading backslash for fully qualified names).
      *
      * @return string Lowercased string representation
+     * @psalm-return non-empty-string
      */
     public function toLowerString() : string {
         return strtolower(implode('\\', $this->parts));
@@ -141,6 +146,7 @@ public function isSpecialClassName() : bool {
      * namespace separator.
      *
      * @return string String representation
+     * @psalm-return non-empty-string
      */
     public function __toString() : string {
         return implode('\\', $this->parts);
@@ -225,6 +231,7 @@ public static function concat($name1, $name2, array $attributes = []) {
      * @param string|string[]|self $name Name to prepare
      *
      * @return string[] Prepared name
+     * @psalm-return non-empty-array<string>
      */
     private static function prepareName($name) : array {
         if (\is_string($name)) {