Rename UrlRoutable method to not conflict with laravel UrlRoutable (#558

) Fixes #451
laravel-doctrine · Aug 14, 2023 · 8e6d22e · 8e6d22e
1 parent e4529c8
commit 8e6d22e
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 41 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -50,6 +50,9 @@ If you have been setting "driverOptions" on your MySQL database config, you shou
 ## Metadata driver `config` removed
 Used deprecated YamlDriver and was not supported by doctrine.
 
+## UrlRoutable::getRouteKeyName renamed to getRouteKeyNameStatic
+This method was renamed to not conflict with the UrlRoutable trait of Laravel.
+
 ## Logging configuration changed
 DBAL deprecated the SQLLogger functionality in favor of the new middleware functionality.
 Logging moved to the new middlewares section.

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1178,36 +1178,11 @@ parameters:
 			count: 1
 			path: src/Loggers/Logger.php
 
-		-
-			message: "#^If condition is always true\\.$#"
-			count: 1
-			path: src/Middleware/SubstituteBindings.php
-
 		-
 			message: "#^Method LaravelDoctrine\\\\ORM\\\\Middleware\\\\SubstituteBindings\\:\\:substituteImplicitBindings\\(\\) has no return type specified\\.$#"
 			count: 1
 			path: src/Middleware/SubstituteBindings.php
 
-		-
-			message: "#^Parameter \\#1 \\$callback of function call_user_func expects callable\\(\\)\\: mixed, array\\{string\\|null, 'getRouteKeyName'\\} given\\.$#"
-			count: 1
-			path: src/Middleware/SubstituteBindings.php
-
-		-
-			message: "#^Parameter \\#1 \\$criteria of method Doctrine\\\\Persistence\\\\ObjectRepository\\<object\\>\\:\\:findOneBy\\(\\) expects array\\<string, mixed\\>, array\\<int\\|string, mixed\\> given\\.$#"
-			count: 1
-			path: src/Middleware/SubstituteBindings.php
-
-		-
-			message: "#^Parameter \\#1 \\$objectOrClass of class ReflectionClass constructor expects class\\-string\\<T of object\\>\\|T of object, string\\|null given\\.$#"
-			count: 1
-			path: src/Middleware/SubstituteBindings.php
-
-		-
-			message: "#^Parameter \\#1 \\$persistentObject of method Doctrine\\\\Persistence\\\\ManagerRegistry\\:\\:getRepository\\(\\) expects class\\-string\\<object\\>, string\\|null given\\.$#"
-			count: 1
-			path: src/Middleware/SubstituteBindings.php
-
 		-
 			message: "#^Parameter \\#1 \\$route of method Illuminate\\\\Contracts\\\\Routing\\\\Registrar\\:\\:substituteBindings\\(\\) expects Illuminate\\\\Routing\\\\Route, object\\|string\\|null given\\.$#"
 			count: 1
@@ -1218,11 +1193,6 @@ parameters:
 			count: 1
 			path: src/Middleware/SubstituteBindings.php
 
-		-
-			message: "#^Unable to resolve the template type T in call to method Doctrine\\\\Persistence\\\\ManagerRegistry\\:\\:getRepository\\(\\)$#"
-			count: 1
-			path: src/Middleware/SubstituteBindings.php
-
 		-
 			message: "#^Cannot call method routeNotificationFor\\(\\) on class\\-string\\|object\\.$#"
 			count: 1

diff --git a/src/Contracts/UrlRoutable.php b/src/Contracts/UrlRoutable.php
@@ -4,5 +4,5 @@
 
 interface UrlRoutable
 {
-    public static function getRouteKeyName(): string;
+    public static function getRouteKeyNameStatic(): string;
 }
diff --git a/src/Middleware/SubstituteBindings.php b/src/Middleware/SubstituteBindings.php
@@ -9,6 +9,8 @@
 use Illuminate\Routing\Route;
 use LaravelDoctrine\ORM\Contracts\UrlRoutable;
 use ReflectionParameter;
+use function class_exists;
+use function is_a;
 
 class SubstituteBindings
 {
@@ -67,11 +69,11 @@ protected function substituteImplicitBindings(Route $route)
             $id    = $parameters[$parameter->name];
             $class = $this->getClassName($parameter);
 
-            if ($repository = $this->registry->getRepository($class)) {
-                $reflectionClass = new \ReflectionClass($class);
+            if ($class) {
+                $repository = $this->registry->getRepository($class);
 
-                if ($reflectionClass->implementsInterface(UrlRoutable::class)) {
-                    $name = call_user_func([$class, 'getRouteKeyName']);
+                if (is_a($class, UrlRoutable::class, true)) {
+                    $name = call_user_func([$class, 'getRouteKeyNameStatic']);
 
                     $entity = $repository->findOneBy([
                         $name => $id
@@ -105,6 +107,9 @@ private function signatureParameters(Route $route)
             })->toArray();
     }
 
+    /**
+     * @return class-string
+     */
     private function getClassName(ReflectionParameter $parameter): ?string
     {
         $class = null;
@@ -113,6 +118,6 @@ private function getClassName(ReflectionParameter $parameter): ?string
             $class = $type->getName();
         }
 
-        return $class;
+        return class_exists($class) ? $class : null;
     }
 }
diff --git a/tests/Middleware/SubstituteBindingsTest.php b/tests/Middleware/SubstituteBindingsTest.php
@@ -65,7 +65,7 @@ public function test_entity_binding()
         $router = $this->getRouter();
         $router->get('foo/{entity}', [
             'middleware' => SubstituteBindings::class,
-            'uses'       => 'EntityController@returnEntityName',     
+            'uses'       => 'EntityController@returnEntityName',
         ]);
 
         $this->mockRegistry();
@@ -85,7 +85,7 @@ public function test_entity_binding_expect_entity_not_found_exception()
 
         $router->get('foo/{entity}', [
             'middleware' => SubstituteBindings::class,
-            'uses'       => 'EntityController@returnEntityName',                       
+            'uses'       => 'EntityController@returnEntityName',
         ]);
 
         $this->mockRegistry();
@@ -99,7 +99,7 @@ public function test_entity_binding_get_null_entity()
         $router = $this->getRouter();
         $router->get('foo/{entity}', [
             'middleware' => SubstituteBindings::class,
-            'uses'       => 'EntityController@returnEntity',            
+            'uses'       => 'EntityController@returnEntity',
         ]);
 
         $this->mockRegistry();
@@ -120,7 +120,7 @@ public function test_binding_value()
 
         $router->get('doc/trine', [
             'middleware' => SubstituteBindings::class,
-            'uses'       => 'EntityController@checkRequest',        
+            'uses'       => 'EntityController@checkRequest',
         ]);
 
         $this->assertEquals('request', $router->dispatch(Request::create('doc/trine', 'GET'))->getContent());
@@ -225,7 +225,7 @@ public function getName()
         return strtolower($this->name);
     }
 
-    public static function getRouteKeyName(): string
+    public static function getRouteKeyNameStatic(): string
     {
         return 'name';
     }