Merge pull request #548 from flightphp/php8-named-arguments-support

n0nag0n · web-flow · commit 22570b998795 · 2025-03-14T23:12:50.000-06:00
PHP 8 named arguments support
diff --git a/composer.json b/composer.json
@@ -33,14 +33,17 @@
     },
     "autoload-dev": {
         "classmap": [
-            "tests/classes/User.php",
-            "tests/classes/Hello.php",
-            "tests/classes/Factory.php",
-            "tests/classes/TesterClass.php"
-        ]
+            "tests/classes/"
+        ],
+        "psr-4": {
+            "Tests\\PHP8\\": [
+                "tests/named-arguments"
+            ]
+        }
     },
     "require-dev": {
         "ext-pdo_sqlite": "*",
+        "flightphp/container": "^1.0",
         "flightphp/runway": "^0.2.3 || ^1.0",
         "league/container": "^4.2",
         "level-2/dice": "^4.0",
diff --git a/flight/Engine.php b/flight/Engine.php
@@ -16,6 +16,7 @@
 use flight\template\View;
 use Throwable;
 use flight\net\Route;
+use Psr\Container\ContainerInterface;
 
 /**
  * The Engine class contains the core functionality of the framework.
@@ -265,9 +266,9 @@ public function handleException(Throwable $e): void
     /**
      * Registers the container handler
      *
-     * @param callable|object $containerHandler Callback function or PSR-11 Container object that sets the container and how it will inject classes
+     * @template T of object
      *
-     * @return void
+     * @param ContainerInterface|callable(class-string<T> $id, array<int|string, mixed> $params): ?T $containerHandler Callback function or PSR-11 Container object that sets the container and how it will inject classes
      */
     public function registerContainerHandler($containerHandler): void
     {
diff --git a/flight/Flight.php b/flight/Flight.php
@@ -9,6 +9,7 @@
 use flight\template\View;
 use flight\net\Route;
 use flight\core\EventDispatcher;
+use Psr\Container\ContainerInterface;
 
 require_once __DIR__ . '/autoload.php';
 
@@ -18,17 +19,22 @@
  * @license MIT, http://flightphp.com/license
  * @copyright Copyright (c) 2011, Mike Cao <mike@mikecao.com>
  *
+ * @template T of object
+ *
  * # Core methods
  * @method static void start() Starts the framework.
- * @method static void path(string $path) Adds a path for autoloading classes.
+ * @method static void path(string $dir) Adds a path for autoloading classes.
  * @method static void stop(?int $code = null) Stops the framework and sends a response.
  * @method static void halt(int $code = 200, string $message = '', bool $actuallyExit = true)
  * Stop the framework with an optional status code and message.
  * @method static void register(string $name, string $class, array<int, mixed> $params = [], ?callable $callback = null)
  * Registers a class to a framework method.
  * @method static void unregister(string $methodName)
  * Unregisters a class to a framework method.
- * @method static void registerContainerHandler(callable|object $containerHandler) Registers a container handler.
+ * @method static void registerContainerHandler(ContainerInterface|callable(class-string<T> $id, array<int|string, mixed> $params): ?T $containerHandler) Registers a container handler.
+ *
+ * # Class registration
+ * @method EventDispatcher eventDispatcher() Gets event dispatcher
  *
  * # Class registration
  * @method EventDispatcher eventDispatcher() Gets event dispatcher
@@ -104,6 +110,7 @@ class Flight
      */
     private function __construct()
     {
+        //
     }
 
     /**
@@ -114,6 +121,7 @@ private function __construct()
      */
     private function __clone()
     {
+        //
     }
 
     /**
diff --git a/flight/commands/RouteCommand.php b/flight/commands/RouteCommand.php
@@ -106,7 +106,7 @@ public function shouldAddRoute(Route $route)
         if ($showAll === true) {
             $boolval = true;
         } else {
-            $methods = [ 'GET', 'POST', 'PUT', 'DELETE', 'PATCH' ];
+            $methods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH'];
             foreach ($methods as $method) {
                 $lowercaseMethod = strtolower($method);
                 if (
diff --git a/flight/core/Dispatcher.php b/flight/core/Dispatcher.php
@@ -52,7 +52,9 @@ class Dispatcher
     /**
      * Sets the dependency injection container handler.
      *
-     * @param ContainerInterface|(callable(string $classString, array<int, mixed> $params): (null|object)) $containerHandler
+     * @template T of object
+     *
+     * @param ContainerInterface|(callable(class-string<T> $classString, array<int, mixed> $params): ?T) $containerHandler
      * Dependency injection container.
      *
      * @throws InvalidArgumentException If $containerHandler is not a `callable` or instance of `Psr\Container\ContainerInterface`.
@@ -231,7 +233,7 @@ public function hook(string $name, string $type, callable $callback): self
 
             if ($parametersNumber === 1) {
                 /** @disregard &$params in after filters are deprecated. */
-                $callback = fn (array &$params, &$output) => $callback($output);
+                $callback = fn(array &$params, &$output) => $callback($output);
             }
         }
 
@@ -437,11 +439,12 @@ protected function verifyValidClassCallable($class, $method, $resolvedClass): vo
     public function resolveContainerClass(string $class, array &$params)
     {
         // PSR-11
-        if (
-            is_a($this->containerHandler, '\Psr\Container\ContainerInterface')
-            && $this->containerHandler->has($class)
-        ) {
-            return $this->containerHandler->get($class);
+        if (is_a($this->containerHandler, '\Psr\Container\ContainerInterface')) {
+            try {
+                return $this->containerHandler->get($class);
+            } catch (Throwable $exception) {
+                return null;
+            }
         }
 
         // Just a callable where you configure the behavior (Dice, PHP-DI, etc.)
diff --git a/flight/net/Request.php b/flight/net/Request.php
@@ -211,8 +211,8 @@ public function init(array $properties = []): self
                     $this->data->setData($data);
                 }
             }
-        // Check PUT, PATCH, DELETE for application/x-www-form-urlencoded data
-        } elseif (in_array($this->method, [ 'PUT', 'DELETE', 'PATCH' ], true) === true) {
+            // Check PUT, PATCH, DELETE for application/x-www-form-urlencoded data
+        } elseif (in_array($this->method, ['PUT', 'DELETE', 'PATCH'], true) === true) {
             $body = $this->getBody();
             if ($body !== '') {
                 $data = [];
diff --git a/flight/util/ReturnTypeWillChange.php b/flight/util/ReturnTypeWillChange.php
@@ -5,4 +5,5 @@
 // This file is only here so that the PHP8 attribute for doesn't throw an error in files
 class ReturnTypeWillChange
 {
+    //
 }
diff --git a/phpstan.neon b/phpstan.neon
@@ -7,6 +7,7 @@ parameters:
     excludePaths:
         - vendor
         - flight/util/ReturnTypeWillChange.php
+        - tests/named-arguments
     paths:
         - flight
         - index.php
diff --git a/phpunit.xml b/phpunit.xml
@@ -22,6 +22,7 @@
     <testsuites>
         <testsuite name="default">
             <directory>tests/</directory>
+            <exclude>tests/named-arguments/</exclude>
         </testsuite>
     </testsuites>
     <logging />
diff --git a/tests/EngineTest.php b/tests/EngineTest.php
@@ -4,7 +4,6 @@
 
 namespace tests;
 
-use ErrorException;
 use Exception;
 use flight\database\PdoWrapper;
 use flight\Engine;
diff --git a/tests/FlightTest.php b/tests/FlightTest.php
@@ -389,7 +389,7 @@ public function testKeepThePreviousStateOfOneViewComponentByDefault(): void
         html;
 
         // if windows replace \n with \r\n
-        $html = str_replace("\n", PHP_EOL, $html);
+        $html = str_replace(["\n", "\r\n"], PHP_EOL, $html);
 
         $this->expectOutputString($html);
 
diff --git a/tests/ViewTest.php b/tests/ViewTest.php
@@ -233,8 +233,8 @@ public static function renderDataProvider(): array
 
         html;
 
-        $html1 = str_replace("\n", PHP_EOL, $html1);
-        $html2 = str_replace("\n", PHP_EOL, $html2);
+        $html1 = str_replace(["\n", "\r\n"], PHP_EOL, $html1);
+        $html2 = str_replace(["\n", "\r\n"], PHP_EOL, $html2);
 
         return [
             [
diff --git a/tests/commands/RouteCommandTest.php b/tests/commands/RouteCommandTest.php
@@ -105,15 +105,22 @@ public function testGetRoutes()
         $app->handle(['runway', 'routes']);
 
         $this->assertStringContainsString('Routes', file_get_contents(static::$ou));
-        $this->assertStringContainsString('+---------+-----------+-------+----------+----------------+
-| Pattern | Methods   | Alias | Streamed | Middleware     |
-+---------+-----------+-------+----------+----------------+
-| /       | GET, HEAD |       | No       | -              |
-| /post   | POST      |       | No       | Closure        |
-| /delete | DELETE    |       | No       | -              |
-| /put    | PUT       |       | No       | -              |
-| /patch  | PATCH     |       | No       | Bad Middleware |
-+---------+-----------+-------+----------+----------------+', $this->removeColors(file_get_contents(static::$ou)));
+        $expected = <<<'output'
+        +---------+-----------+-------+----------+----------------+
+        | Pattern | Methods   | Alias | Streamed | Middleware     |
+        +---------+-----------+-------+----------+----------------+
+        | /       | GET, HEAD |       | No       | -              |
+        | /post   | POST      |       | No       | Closure        |
+        | /delete | DELETE    |       | No       | -              |
+        | /put    | PUT       |       | No       | -              |
+        | /patch  | PATCH     |       | No       | Bad Middleware |
+        +---------+-----------+-------+----------+----------------+
+        output;
+
+        $this->assertStringContainsString(
+            $expected,
+            $this->removeColors(file_get_contents(static::$ou))
+        );
     }
 
     public function testGetPostRoute()
diff --git a/tests/named-arguments/ExampleClass.php b/tests/named-arguments/ExampleClass.php
@@ -0,0 +1,8 @@
+<?php
+
+declare(strict_types=1);
+
+class ExampleClass
+{
+    //
+}
diff --git a/tests/named-arguments/FlightTest.php b/tests/named-arguments/FlightTest.php
@@ -0,0 +1,128 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\PHP8;
+
+use DateTimeImmutable;
+use ExampleClass;
+use Flight;
+use flight\Container;
+use flight\Engine;
+use flight\net\Route;
+use PHPUnit\Framework\TestCase;
+use stdClass;
+
+final class FlightTest extends TestCase
+{
+    private Engine $engine;
+
+    protected function setUp(): void
+    {
+        $this->engine = new Engine;
+        Flight::init();
+        Flight::setEngine($this->engine);
+    }
+
+    //////////////////
+    // CORE METHODS //
+    //////////////////
+    public function test_path(): void
+    {
+        Flight::path(dir: __DIR__);
+
+        $exampleObject = new ExampleClass();
+        self::assertInstanceOf(ExampleClass::class, $exampleObject);
+    }
+
+    public function test_stop_with_code(): void
+    {
+        Flight::stop(code: 500);
+
+        self::expectOutputString('');
+        self::assertSame(500, Flight::response()->status());
+    }
+
+    public function test_halt(): void
+    {
+        Flight::halt(actuallyExit: false, code: 500, message: 'Test');
+
+        self::expectOutputString('Test');
+        self::assertSame(500, Flight::response()->status());
+    }
+
+    public function test_register(): void
+    {
+        Flight::register(
+            class: stdClass::class,
+            name: 'customClass',
+            callback: static function (stdClass $object): void {
+                $object->property = 'value';
+            },
+            params: []
+        );
+
+        $object = Flight::customClass();
+
+        self::assertInstanceOf(stdClass::class, $object);
+        self::assertObjectHasProperty('property', $object);
+        self::assertSame('value', $object->property);
+
+        Flight::unregister(methodName: 'customClass');
+    }
+
+    public function test_register_container(): void
+    {
+        $dateTime = new DateTimeImmutable();
+
+        $controller = new class($dateTime) {
+            public function __construct(private DateTimeImmutable $dateTime)
+            {
+                //
+            }
+
+            public function test(): void
+            {
+                echo $this->dateTime->format('Y-m-d');
+            }
+        };
+
+        Flight::registerContainerHandler(
+            containerHandler: new Container()
+        );
+
+        Flight::request()->url = '/test';
+
+        Flight::route(
+            pass_route: true,
+            alias: 'testRoute',
+            callback: [$controller::class, 'test'],
+            pattern: '/test'
+        );
+
+        self::expectOutputString($dateTime->format('Y-m-d'));
+
+        Flight::start();
+    }
+
+    /////////////////////
+    // ROUTING METHODS //
+    /////////////////////
+    public function test_static_route(): void
+    {
+        Flight::request()->url = '/test';
+
+        $route = Flight::route(
+            pass_route: true,
+            alias: 'testRoute',
+            callback: function () {
+                echo 'test';
+            },
+            pattern: '/test'
+        );
+
+        self::assertInstanceOf(Route::class, $route);
+        self::expectOutputString('test');
+        Flight::start();
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@`
`16`	`16`	`use flight\template\View;`
`17`	`17`	`use Throwable;`
`18`	`18`	`use flight\net\Route;`
	`19`	`+use Psr\Container\ContainerInterface;`
`19`	`20`
`20`	`21`	`/**`
`21`	`22`	`* The Engine class contains the core functionality of the framework.`
`@@ -265,9 +266,9 @@ public function handleException(Throwable $e): void`
`265`	`266`	`/**`
`266`	`267`	`* Registers the container handler`
`267`	`268`	`*`
`268`		`- * @param callable\|object $containerHandler Callback function or PSR-11 Container object that sets the container and how it will inject classes`
	`269`	`+ * @template T of object`
`269`	`270`	`*`
`270`		`- * @return void`
	`271`	`+ * @param ContainerInterface\|callable(class-string<T> $id, array<int\|string, mixed> $params): ?T $containerHandler Callback function or PSR-11 Container object that sets the container and how it will inject classes`
`271`	`272`	`*/`
`272`	`273`	`public function registerContainerHandler($containerHandler): void`
`273`	`274`	`{`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,9 @@ class Dispatcher`
`52`	`52`	`/**`
`53`	`53`	`* Sets the dependency injection container handler.`
`54`	`54`	`*`
`55`		`- * @param ContainerInterface\|(callable(string $classString, array<int, mixed> $params): (null\|object)) $containerHandler`
	`55`	`+ * @template T of object`
	`56`	`+ *`
	`57`	`+ * @param ContainerInterface\|(callable(class-string<T> $classString, array<int, mixed> $params): ?T) $containerHandler`
`56`	`58`	`* Dependency injection container.`
`57`	`59`	`*`
`58`	`60`	* @throws InvalidArgumentException If $containerHandler is not a `callable` or instance of `Psr\Container\ContainerInterface`.
`@@ -231,7 +233,7 @@ public function hook(string $name, string $type, callable $callback): self`
`231`	`233`
`232`	`234`	`if ($parametersNumber === 1) {`
`233`	`235`	`/** @disregard &$params in after filters are deprecated. */`
`234`		`- $callback = fn (array &$params, &$output) => $callback($output);`
	`236`	`+ $callback = fn(array &$params, &$output) => $callback($output);`
`235`	`237`	`}`
`236`	`238`	`}`
`237`	`239`
`@@ -437,11 +439,12 @@ protected function verifyValidClassCallable($class, $method, $resolvedClass): vo`
`437`	`439`	`public function resolveContainerClass(string $class, array &$params)`
`438`	`440`	`{`
`439`	`441`	`// PSR-11`
`440`		`- if (`
`441`		`- is_a($this->containerHandler, '\Psr\Container\ContainerInterface')`
`442`		`- && $this->containerHandler->has($class)`
`443`		`- ) {`
`444`		`- return $this->containerHandler->get($class);`
	`442`	`+ if (is_a($this->containerHandler, '\Psr\Container\ContainerInterface')) {`
	`443`	`+ try {`
	`444`	`+ return $this->containerHandler->get($class);`
	`445`	`+ } catch (Throwable $exception) {`
	`446`	`+ return null;`
	`447`	`+ }`
`445`	`448`	`}`
`446`	`449`
`447`	`450`	`// Just a callable where you configure the behavior (Dice, PHP-DI, etc.)`
Original file line number	Diff line number	Diff line change
`@@ -211,8 +211,8 @@ public function init(array $properties = []): self`
`211`	`211`	`$this->data->setData($data);`
`212`	`212`	`}`
`213`	`213`	`}`
`214`		`- // Check PUT, PATCH, DELETE for application/x-www-form-urlencoded data`
`215`		`- } elseif (in_array($this->method, [ 'PUT', 'DELETE', 'PATCH' ], true) === true) {`
	`214`	`+ // Check PUT, PATCH, DELETE for application/x-www-form-urlencoded data`
	`215`	`+ } elseif (in_array($this->method, ['PUT', 'DELETE', 'PATCH'], true) === true) {`
`216`	`216`	`$body = $this->getBody();`
`217`	`217`	`if ($body !== '') {`
`218`	`218`	`$data = [];`
Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,5 @@`
`5`	`5`	`// This file is only here so that the PHP8 attribute for doesn't throw an error in files`
`6`	`6`	`class ReturnTypeWillChange`
`7`	`7`	`{`
	`8`	`+ //`
`8`	`9`	`}`