Support for Stringable

Author: ondrejmirtes

src/BetterReflection.php

@@ -23,6 +23,7 @@
 use Roave\BetterReflection\SourceLocator\Type\PhpInternalSourceLocator;
 use Roave\BetterReflection\SourceLocator\Type\SourceLocator;
 use Roave\BetterReflection\Util\FindReflectionOnLine;
+use const PHP_VERSION_ID;
 
 final class BetterReflection
 {

src/Reflection/ReflectionClass.php

@@ -1300,7 +1300,7 @@ private function getCurrentClassImplementedInterfacesIndexedByName() : array
         $node = $this->node;
 
         if ($node instanceof ClassNode) {
-            return array_merge(
+            $interfaces = array_merge(
                 [],
                 ...array_map(
                     function (Node\Name $interfaceName) : array {
@@ -1311,6 +1311,25 @@ function (Node\Name $interfaceName) : array {
                     $node->implements
                 )
             );
+
+            if (BetterReflection::$phpVersion >= 80000) {
+                foreach ($node->getMethods() as $method) {
+                    if ($method->name->toLowerString() !== '__tostring') {
+                        continue;
+                    }
+
+                    foreach ($interfaces as $interface) {
+                        if ($interface->getName() === 'Stringable') {
+                            return $interfaces;
+                        }
+                    }
+
+                    $interfaces['Stringable'] = $this->reflectClassForNamedNode(new Node\Name('Stringable'));
+                    break;
+                }
+            }
+
+            return $interfaces;
         }
 
         // assumption: first key is the current interface
@@ -1350,7 +1369,7 @@ private function getInterfacesHierarchy() : array
         $node = $this->node;
         assert($node instanceof InterfaceNode);
 
-        return array_merge(
+        $interfaces = array_merge(
             [$this->getName() => $this],
             ...array_map(
                 function (Node\Name $interfaceName) : array {
@@ -1361,6 +1380,25 @@ function (Node\Name $interfaceName) : array {
                 $node->extends
             )
         );
+
+        if (BetterReflection::$phpVersion >= 80000) {
+            foreach ($node->getMethods() as $method) {
+                if ($method->name->toLowerString() !== '__tostring') {
+                    continue;
+                }
+
+                foreach ($interfaces as $interface) {
+                    if ($interface->getName() === 'Stringable') {
+                        return $interfaces;
+                    }
+                }
+
+                $interfaces['Stringable'] = $this->reflectClassForNamedNode(new Node\Name('Stringable'));
+                break;
+            }
+        }
+
+        return $interfaces;
     }
 
     /**

test/unit/Fixture/ClassWithToString.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Roave\BetterReflectionTest\Fixture;
+
+class ClassWithToString
+{
+
+    public function __toString(): string
+    {
+        return 'foo';
+    }
+
+}

test/unit/Fixture/ClassWithToStringAndStringable.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Roave\BetterReflectionTest\Fixture;
+
+class ClassWithToStringAndStringable implements \Stringable
+{
+
+    public function __toString(): string
+    {
+        return 'foo';
+    }
+
+}

test/unit/Fixture/InterfaceWithToString.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Roave\BetterReflectionTest\Fixture;
+
+interface InterfaceWithToString
+{
+
+    public function __toString(): string;
+
+}

test/unit/Fixture/InterfaceWithToStringAndStringable.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Roave\BetterReflectionTest\Fixture;
+
+interface InterfaceWithToStringAndStringable extends \Stringable
+{
+
+    public function __toString(): string;
+
+}

test/unit/Reflection/ReflectionClassStringableTest.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Roave\BetterReflectionTest\Reflection;
+
+use PHPUnit\Framework\TestCase;
+use Roave\BetterReflection\BetterReflection;
+use Roave\BetterReflection\Reflection\ReflectionClass;
+use Roave\BetterReflectionTest\Fixture\ClassWithToString;
+use Roave\BetterReflectionTest\Fixture\ClassWithToStringAndStringable;
+use Roave\BetterReflectionTest\Fixture\InterfaceWithToString;
+use Roave\BetterReflectionTest\Fixture\InterfaceWithToStringAndStringable;
+use Stringable;
+use const PHP_VERSION_ID;
+
+class ReflectionClassStringableTest extends TestCase
+{
+    public function tearDown() : void
+    {
+        BetterReflection::$phpVersion = PHP_VERSION_ID;
+    }
+
+    public function dataToString() : array
+    {
+        return [
+            [ClassWithToString::class],
+            [InterfaceWithToString::class],
+        ];
+    }
+
+    /**
+     * @dataProvider dataToString
+     */
+    public function testNoStringableOnPhp7(string $className) : void
+    {
+        BetterReflection::$phpVersion = 70400;
+        $reflection                   = ReflectionClass::createFromName($className);
+        self::assertFalse($reflection->implementsInterface(Stringable::class));
+        self::assertNotContains(Stringable::class, $reflection->getInterfaceNames());
+    }
+
+    /**
+     * @dataProvider dataToString
+     */
+    public function testStringableOnPhp8(string $className) : void
+    {
+        BetterReflection::$phpVersion = 80000;
+        $reflection                   = ReflectionClass::createFromName($className);
+        self::assertTrue($reflection->implementsInterface(Stringable::class));
+        self::assertContains(Stringable::class, $reflection->getInterfaceNames());
+    }
+
+    public function dataToStringAndStringable() : array
+    {
+        return [
+            [ClassWithToStringAndStringable::class],
+            [InterfaceWithToStringAndStringable::class],
+        ];
+    }
+
+    /**
+     * @dataProvider dataToStringAndStringable
+     */
+    public function testStringableOnlyOnce(string $className) : void
+    {
+        BetterReflection::$phpVersion = 80000;
+        $reflection                   = ReflectionClass::createFromName($className);
+        self::assertTrue($reflection->implementsInterface(Stringable::class));
+        self::assertSame([Stringable::class], $reflection->getInterfaceNames());
+    }
+}