Added ClassRegistry stub

Closes #1

Author: ariddlestone

composer.json

@@ -36,6 +36,7 @@
             "vendor/cakephp/cakephp/lib/Cake/Controller",
             "vendor/cakephp/cakephp/lib/Cake/Event",
             "vendor/cakephp/cakephp/lib/Cake/Model",
+            "vendor/cakephp/cakephp/lib/Cake/Utility",
             "vendor/cakephp/cakephp/lib/Cake/View"
         ]
     },

extension.neon

@@ -5,6 +5,8 @@ parameters:
       - lib/Cake/Model/Behavior/*.php
       - app/Plugin/*/Model/Behavior/*.php
       - app/Model/Behavior/*.php
+  stubFiles:
+    - stubs/Utility.php
 services:
   - class: ARiddlestone\PHPStanCakePHP2\ControllerComponentsExtension
     tags:

stubs/Utility.php

@@ -0,0 +1,99 @@
+<?php
+
+class ClassRegistry
+{
+    /**
+     * @var array<string,mixed>
+     */
+    protected $_objects = array();
+
+    /**
+     * @var array<string,mixed>
+     */
+    protected $_map = array();
+
+    /**
+     * @var array<string,mixed>
+     */
+    protected $_config = array();
+
+    /**
+     * @return ClassRegistry
+     */
+    public static function getInstance(): ClassRegistry {}
+
+    /**
+     * @template T
+     * @param class-string<T>|string|array<mixed> $class
+     * @param bool $strict
+     * @return ($class is class-string<T> ? T : (bool|object))
+     */
+    public static function init($class, bool $strict = false) {}
+
+    /**
+     * @param string $key
+     * @param object $object
+     * @return bool
+     */
+    public static function addObject(string $key, object $object): bool {}
+
+    /**
+     * @param string $key
+     * @return void
+     */
+    public static function removeObject(string $key): void {}
+
+    /**
+     * @param string $key
+     * @return bool
+     */
+    public static function isKeySet(string $key): bool {}
+
+    /**
+     * @return array<string>
+     */
+    public static function keys(): array {}
+
+    /**
+     * @param string $key
+     * @return object|false
+     */
+    public static function getObject(string $key) {}
+
+    /**
+     * @param string $type
+     * @param array<mixed> $param
+     * @return mixed
+     */
+    public static function config(string $type, array $param = array()) {}
+
+    /**
+     * @param string $alias
+     * @param string $class
+     * @return object|false
+     */
+    protected function &_duplicate(string $alias, string $class) {}
+
+    /**
+     * @param string $key
+     * @param string $name
+     * @return void
+     */
+    public static function map(string $key, string $name): void {}
+
+    /**
+     * @return array<string> Keys of registry's map
+     */
+    public static function mapKeys(): array {}
+
+    /**
+     * @param string $key
+     * @return string
+     */
+    protected function _getMap(string $key): string {}
+
+    /**
+     * @return void
+     */
+    public static function flush(): void {}
+}

tests/Stubs/UtilityTest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace ARiddlestone\PHPStanCakePHP2\Test\Stubs;
+
+use PHPStan\Testing\TypeInferenceTestCase;
+
+class UtilityTest extends TypeInferenceTestCase
+{
+    /**
+     * @return mixed[]
+     */
+    public function dataFileAsserts(): iterable
+    {
+        yield from $this->gatherAssertTypes(__DIR__ . '/../data/stubs/class_registry_init.php');
+    }
+
+    /**
+     * @dataProvider dataFileAsserts
+     * @param mixed $args
+     */
+    public function testControllerExtensions(string $assertType, string $file, ...$args): void
+    {
+        $this->assertFileAsserts($assertType, $file, ...$args);
+    }
+
+    public static function getAdditionalConfigFiles(): array
+    {
+        return [
+            __DIR__ . '/../data/phpstan.neon',
+        ];
+    }
+}

tests/data/stubs/class_registry_init.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use function PHPStan\Testing\assertType;
+
+$class = ClassRegistry::init('BasicModel');
+assertType('BasicModel', $class);
+
+$notClass = ClassRegistry::init('NotAClass');
+assertType('bool|object', $notClass);