Merge pull request #276 from mspirkov/add-callable-array

Add support for `callable-array`

Author: jaapio

src/PseudoTypes/CallableArray.php

@@ -0,0 +1,43 @@
+<?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\PseudoTypes;
+
+use phpDocumentor\Reflection\PseudoType;
+use phpDocumentor\Reflection\Type;
+use phpDocumentor\Reflection\Types\Array_;
+use phpDocumentor\Reflection\Types\Integer;
+use phpDocumentor\Reflection\Types\Mixed_;
+
+/**
+ * Value Object representing the type 'callable-array'.
+ *
+ * @psalm-immutable
+ */
+final class CallableArray extends Array_ implements PseudoType
+{
+    public function __construct()
+    {
+        parent::__construct(new Mixed_(), new Integer());
+    }
+
+    public function underlyingType(): Type
+    {
+        return new Array_(new Mixed_(), new Integer());
+    }
+
+    public function __toString(): string
+    {
+        return 'callable-array';
+    }
+}

src/TypeResolver.php

@@ -18,6 +18,7 @@
 use phpDocumentor\Reflection\PseudoTypes\ArrayKey;
 use phpDocumentor\Reflection\PseudoTypes\ArrayShape;
 use phpDocumentor\Reflection\PseudoTypes\ArrayShapeItem;
+use phpDocumentor\Reflection\PseudoTypes\CallableArray;
 use phpDocumentor\Reflection\PseudoTypes\CallableString;
 use phpDocumentor\Reflection\PseudoTypes\ClassString;
 use phpDocumentor\Reflection\PseudoTypes\ClosedResource;
@@ -169,6 +170,7 @@ final class TypeResolver
         'object' => Object_::class,
         'mixed' => Mixed_::class,
         'array' => Array_::class,
+        'callable-array' => CallableArray::class,
         'array-key' => ArrayKey::class,
         'non-empty-array' => NonEmptyArray::class,
         'resource' => Resource_::class,

tests/unit/PseudoTypes/CallableArrayTest.php

@@ -0,0 +1,36 @@
+<?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\PseudoTypes;
+
+use phpDocumentor\Reflection\Types\Array_;
+use phpDocumentor\Reflection\Types\Integer;
+use phpDocumentor\Reflection\Types\Mixed_;
+use PHPUnit\Framework\TestCase;
+
+final class CallableArrayTest extends TestCase
+{
+    public function testCreate(): void
+    {
+        $type = new CallableArray();
+
+        $this->assertEquals(new Array_(new Mixed_(), new Integer()), $type->underlyingType());
+        $this->assertEquals(new Mixed_(), $type->getValueType());
+        $this->assertEquals(new Integer(), $type->getKeyType());
+    }
+
+    public function testToString(): void
+    {
+        $this->assertSame('callable-array', (string) (new CallableArray()));
+    }
+}

tests/unit/TypeResolverTest.php

@@ -18,6 +18,7 @@
 use phpDocumentor\Reflection\PseudoTypes\ArrayKey;
 use phpDocumentor\Reflection\PseudoTypes\ArrayShape;
 use phpDocumentor\Reflection\PseudoTypes\ArrayShapeItem;
+use phpDocumentor\Reflection\PseudoTypes\CallableArray;
 use phpDocumentor\Reflection\PseudoTypes\CallableString;
 use phpDocumentor\Reflection\PseudoTypes\ClassString;
 use phpDocumentor\Reflection\PseudoTypes\ClosedResource;
@@ -672,6 +673,7 @@ public function provideKeywords(): array
             ['callable-string', CallableString::class],
             ['callback', Callable_::class],
             ['array', Array_::class],
+            ['callable-array', CallableArray::class],
             ['array-key', ArrayKey::class],
             ['scalar', Scalar::class],
             ['object', Object_::class],