Make EntityFieldReflection aware of the book property added by book.module. (#523)

Co-authored-by: M Parker <[email protected]>
Co-authored-by: Matt Glaman <[email protected]>

Author: mparker17

src/Reflection/EntityFieldsViaMagicReflectionExtension.php

@@ -28,6 +28,12 @@ public function hasProperty(ClassReflection $classReflection, string $propertyNa
             return false;
         }
 
+        foreach ($classReflection->getAncestors() as $ancestor) {
+            if (array_key_exists($propertyName, $ancestor->getPropertyTags())) {
+                return false;
+            }
+        }
+
         // We need to find a way to parse the entity annotation so that at the minimum the `entity_keys` are
         // supported. The real fix is Drupal developers _really_ need to start writing @property definitions in the
         // class doc if they don't get `get` methods.

stubs/Drupal/Core/Entity/EntityChangedInterface.stub

@@ -0,0 +1,6 @@
+<?php
+
+namespace Drupal\Core\Entity;
+
+interface EntityChangedInterface extends EntityInterface {
+}

stubs/Drupal/Core/Entity/EntityPublishedInterface.stub

@@ -0,0 +1,6 @@
+<?php
+
+namespace Drupal\Core\Entity;
+
+interface EntityPublishedInterface extends EntityInterface {
+}

stubs/Drupal/Core/Entity/RevisionLogInterface.stub

@@ -0,0 +1,6 @@
+<?php
+
+namespace Drupal\Core\Entity;
+
+interface RevisionLogInterface extends RevisionableInterface {
+}

stubs/Drupal/Core/Entity/RevisionableInterface.stub

@@ -0,0 +1,6 @@
+<?php
+
+namespace Drupal\Core\Entity;
+
+interface RevisionableInterface extends EntityInterface {
+}

stubs/Drupal/node/NodeInterface.stub

@@ -0,0 +1,36 @@
+<?php
+
+namespace Drupal\node;
+
+use Drupal\Core\Entity\EntityPublishedInterface;
+use Drupal\Core\Entity\RevisionLogInterface;
+use Drupal\user\EntityOwnerInterface;
+use Drupal\Core\Entity\EntityChangedInterface;
+use Drupal\Core\Entity\ContentEntityInterface;
+
+/**
+ * @phpstan-type BookData array{
+ *      nid: int|numeric-string,
+ *      bid: int|numeric-string,
+ *      pid: int|numeric-string,
+ *      has_children: int|numeric-string|bool,
+ *      weight: int|numeric-string,
+ *      depth: int|numeric-string,
+ *      p1: int|numeric-string,
+ *      p2: int|numeric-string,
+ *      p3: int|numeric-string,
+ *      p4: int|numeric-string,
+ *      p5: int|numeric-string,
+ *      p6: int|numeric-string,
+ *      p7: int|numeric-string,
+ *      p8: int|numeric-string,
+ *      p9: int|numeric-string,
+ *      link_path: string,
+ *      link_title: string,
+ * }
+ *
+ * @property BookData $book
+ */
+interface NodeInterface extends ContentEntityInterface, EntityChangedInterface, EntityOwnerInterface, RevisionLogInterface, EntityPublishedInterface {
+
+}

stubs/Drupal/node/user/EntityOwnerInterface.stub

@@ -0,0 +1,6 @@
+<?php
+
+namespace Drupal\user;
+
+interface EntityOwnerInterface {
+}

tests/src/Reflection/EntityFieldsViaMagicReflectionExtensionTest.php

@@ -72,10 +72,10 @@ public function dataHasProperty(): \Generator
             'target_id',
             true,
         ];
-        yield 'field item list: value' => [
+        yield 'field item list: value (read from interface stub)' => [
             \Drupal\Core\Field\FieldItemList::class,
             'value',
-            true,
+            false,
         ];
         yield 'field item list_interface: value' => [
             \Drupal\Core\Field\FieldItemListInterface::class,

tests/src/Type/EntityPropertyTypeTest.php

@@ -13,7 +13,8 @@ final class EntityPropertyTypeTest extends TypeInferenceTestCase
 
     public function dataFileAsserts(): iterable
     {
-        yield from $this->gatherAssertTypes(__DIR__ . '/data/entity-properties.php');
+        yield from self::gatherAssertTypes(__DIR__ . '/data/entity-properties.php');
+        yield from self::gatherAssertTypes(__DIR__ . '/data/book-module.php');
     }
 
     /**

tests/src/Type/data/book-module.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace BookModuleProperty;
+
+use Drupal\node\Entity\Node;
+use function PHPStan\Testing\assertType;
+
+$node = Node::create(['type' => 'book']);
+assertType('array{nid: int|numeric-string, bid: int|numeric-string, pid: int|numeric-string, has_children: bool|int|numeric-string, weight: int|numeric-string, depth: int|numeric-string, p1: int|numeric-string, p2: int|numeric-string, p3: int|numeric-string, p4: int|numeric-string, p5: int|numeric-string, p6: int|numeric-string, p7: int|numeric-string, p8: int|numeric-string, p9: int|numeric-string, link_path: string, link_title: string}', $node->book);