Add generic definition of DOMNamedNodeMap (#2703)

* Fix #2638 - propagate phantom classes to recursive calls to Scanner::queueClassLikeForScanning() * Add generic definition of DOMNamedNodeMap
vimeo · Jan 29, 2020 · ecf85ae · ecf85ae
1 parent 10221f4
commit ecf85ae
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 7 deletions.
diff --git a/src/Psalm/Internal/Codebase/Scanner.php b/src/Psalm/Internal/Codebase/Scanner.php
@@ -280,14 +280,16 @@ public function getClassLikeFilePath($fq_classlike_name_lc)
      * @param  string|null  $referencing_file_path
      * @param  bool $analyze_too
      * @param  bool $store_failure
+     * @param  array<string, mixed> $phantom_classes
      *
      * @return void
      */
     public function queueClassLikeForScanning(
         $fq_classlike_name,
         $referencing_file_path = null,
         $analyze_too = false,
-        $store_failure = true
+        $store_failure = true,
+        array $phantom_classes = []
     ) {
         if ($fq_classlike_name[0] === '\\') {
             $fq_classlike_name = substr($fq_classlike_name, 1);
@@ -325,7 +327,7 @@ public function queueClassLikeForScanning(
                     $property_type->queueClassLikesForScanning(
                         $this->codebase,
                         null,
-                        [$fq_classlike_name_lc => true]
+                        $phantom_classes + [$fq_classlike_name_lc => true]
                     );
                 }
             }

diff --git a/src/Psalm/Internal/PropertyMap.php b/src/Psalm/Internal/PropertyMap.php
@@ -268,7 +268,7 @@
     'domelement' => [
         'schemaTypeInfo' => 'bool',
         'tagName' => 'string',
-        'attributes' => 'DOMNamedNodeMap',
+        'attributes' => 'DOMNamedNodeMap<DOMAttr>',
     ],
     'tidynode' => [
         'value' => 'string',

diff --git a/src/Psalm/Internal/Stubs/CoreGenericClasses.php b/src/Psalm/Internal/Stubs/CoreGenericClasses.php
@@ -946,6 +946,32 @@ class DOMNodeList implements Traversable, Countable {
     public function item($index) {}
 }
 
+/**
+ * @template-covariant TNode as DOMNode
+ * @template-implements Traversable<string, TNode>
+ */
+class DOMNamedNodeMap implements Traversable, Countable {
+    /**
+     * @var int
+     */
+    public $length;
+
+    /**
+     * @return TNode|null
+     */
+    public function getNamedItem(string $name): ?DOMNode {}
+
+    /**
+     * @return TNode|null
+     */
+    public function getNamedItemNS(string $namespaceURI, string $localName): ?DOMNode {}
+
+    /**
+     * @return TNode|null
+     */
+    public function item(int $index): ?DOMNode {}
+}
+
 /**
  * The SplDoublyLinkedList class provides the main functionalities of a doubly linked list.
  * @link https://php.net/manual/en/class.spldoublylinkedlist.php

diff --git a/src/Psalm/Type/Atomic.php b/src/Psalm/Type/Atomic.php
@@ -458,7 +458,8 @@ public function queueClassLikesForScanning(
                     $this->value,
                     $file_storage ? $file_storage->file_path : null,
                     false,
-                    !$this->from_docblock
+                    !$this->from_docblock,
+                    $phantom_classes
                 );
 
                 if ($file_storage) {
@@ -487,7 +488,8 @@ public function queueClassLikesForScanning(
                 $this->fq_classlike_name,
                 $file_storage ? $file_storage->file_path : null,
                 false,
-                !$this->from_docblock
+                !$this->from_docblock,
+                $phantom_classes
             );
             if ($file_storage) {
                 $file_storage->referenced_classlikes[strtolower($this->fq_classlike_name)] = $this->fq_classlike_name;
@@ -500,7 +502,8 @@ public function queueClassLikesForScanning(
                     $this->as,
                     $file_storage ? $file_storage->file_path : null,
                     false,
-                    !$this->from_docblock
+                    !$this->from_docblock,
+                    $phantom_classes
                 );
                 if ($file_storage) {
                     $file_storage->referenced_classlikes[strtolower($this->as)] = $this->as;
@@ -521,7 +524,8 @@ public function queueClassLikesForScanning(
                 $this->value,
                 $file_storage ? $file_storage->file_path : null,
                 false,
-                !$this->from_docblock
+                !$this->from_docblock,
+                $phantom_classes
             );
             if ($file_storage) {
                 $file_storage->referenced_classlikes[strtolower($this->value)] = $this->value;

diff --git a/tests/PropertyTypeTest.php b/tests/PropertyTypeTest.php
@@ -344,6 +344,12 @@ function foo(DOMElement $e) : void {
                         echo $e->attributes->length;
                     }',
             ],
+            'genericTypeFromPropertyMap' => [
+                '<?php
+                    function foo(DOMElement $e) : ?DOMAttr {
+                        return $e->attributes->item(0);
+                    }'
+            ],
             'goodArrayProperties' => [
                 '<?php
                     interface I1 {}