Add identifier to the Callable (#258)

Author: mspirkov

src/TypeResolver.php

@@ -466,18 +466,22 @@ private function createFromGeneric(GenericTypeNode $type, Context $context): Typ
 
     private function createFromCallable(CallableTypeNode $type, Context $context): Callable_
     {
-        return new Callable_(array_map(
-            function (CallableTypeParameterNode $param) use ($context): CallableParameter {
-                return new CallableParameter(
-                    $this->createType($param->type, $context),
-                    $param->parameterName !== '' ? trim($param->parameterName, '$') : null,
-                    $param->isReference,
-                    $param->isVariadic,
-                    $param->isOptional
-                );
-            },
-            $type->parameters
-        ), $this->createType($type->returnType, $context));
+        return new Callable_(
+            (string) $type->identifier,
+            array_map(
+                function (CallableTypeParameterNode $param) use ($context): CallableParameter {
+                    return new CallableParameter(
+                        $this->createType($param->type, $context),
+                        $param->parameterName !== '' ? trim($param->parameterName, '$') : null,
+                        $param->isReference,
+                        $param->isVariadic,
+                        $param->isOptional
+                    );
+                },
+                $type->parameters
+            ),
+            $this->createType($type->returnType, $context)
+        );
     }
 
     private function createFromConst(ConstTypeNode $type, Context $context): Type

src/Types/Callable_.php

@@ -22,6 +22,8 @@
  */
 final class Callable_ implements Type
 {
+    /** @var string */
+    private $identifier;
     /** @var Type|null */
     private $returnType;
     /** @var CallableParameter[] */
@@ -30,12 +32,21 @@ final class Callable_ implements Type
     /**
      * @param CallableParameter[] $parameters
      */
-    public function __construct(array $parameters = [], ?Type $returnType = null)
-    {
+    public function __construct(
+        string $identifier = 'callable',
+        array $parameters = [],
+        ?Type $returnType = null
+    ) {
+        $this->identifier = $identifier;
         $this->parameters = $parameters;
         $this->returnType = $returnType;
     }
 
+    public function getIdentifier(): string
+    {
+        return $this->identifier;
+    }
+
     /** @return CallableParameter[] */
     public function getParameters(): array
     {
@@ -52,6 +63,6 @@ public function getReturnType(): ?Type
      */
     public function __toString(): string
     {
-        return 'callable';
+        return $this->identifier;
     }
 }

tests/unit/TypeResolverTest.php

@@ -1139,11 +1139,20 @@ public function callableProvider(): array
             ],
             [
                 'callable(): Foo',
-                new Callable_([], new Object_(new Fqsen('\\phpDocumentor\\Foo'))),
+                new Callable_('callable', [], new Object_(new Fqsen('\\phpDocumentor\\Foo'))),
+            ],
+            [
+                'Closure(): Foo',
+                new Callable_('Closure', [], new Object_(new Fqsen('\\phpDocumentor\\Foo'))),
+            ],
+            [
+                '\Closure(): Foo',
+                new Callable_('\Closure', [], new Object_(new Fqsen('\\phpDocumentor\\Foo'))),
             ],
             [
                 'callable(): (Foo&Bar)',
                 new Callable_(
+                    'callable',
                     [],
                     new Intersection(
                         [
@@ -1156,6 +1165,7 @@ public function callableProvider(): array
             [
                 'callable(A&...$a=, B&...=, C): Foo',
                 new Callable_(
+                    'callable',
                     [
                         new CallableParameter(
                             new Object_(new Fqsen('\\phpDocumentor\\A')),

tests/unit/Types/CallableTest.php

@@ -0,0 +1,81 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of phpDocumentor.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @link      http://phpdoc.org
+ */
+
+namespace phpDocumentor\Reflection\Types;
+
+use phpDocumentor\Reflection\Fqsen;
+use PHPUnit\Framework\TestCase;
+
+final class CallableTest extends TestCase
+{
+    public function testCreate(): void
+    {
+        $identifier = 'callable';
+        $parameters = [
+            new CallableParameter(
+                new Object_(new Fqsen('\\phpDocumentor\\A')),
+                'a',
+                true,
+                true,
+                true
+            ),
+            new CallableParameter(
+                new Object_(new Fqsen('\\phpDocumentor\\B')),
+                null,
+                true,
+                true,
+                true
+            ),
+            new CallableParameter(
+                new Object_(new Fqsen('\\phpDocumentor\\C')),
+                null,
+                false,
+                false,
+                false
+            ),
+        ];
+
+        $returnType = new Object_(new Fqsen('\\phpDocumentor\\Foo'));
+
+        $type = new Callable_($identifier, $parameters, $returnType);
+
+        $this->assertSame($identifier, $type->getIdentifier());
+        $this->assertSame($parameters, $type->getParameters());
+        $this->assertSame($returnType, $type->getReturnType());
+    }
+
+    /**
+     * @dataProvider provideToStringData
+     */
+    public function testToString(string $expectedResult, Callable_ $type): void
+    {
+        $this->assertSame($expectedResult, (string) $type);
+    }
+
+    /**
+     * @return array<string, array{string, Callable_}>
+     */
+    public static function provideToStringData(): array
+    {
+        return [
+            'basic' => [
+                'callable',
+                new Callable_(),
+            ],
+            'closure' => [
+                '\Closure',
+                new Callable_('\Closure'),
+            ],
+        ];
+    }
+}