Merge pull request #57 from CakeDC/feature/typed-association-find-by

AssociationTableMixinClassReflectionExtension must rely on generic to detect native methods

Author: rochamarcelo

src/Method/AssociationTableMixinClassReflectionExtension.php

@@ -58,17 +58,15 @@ public function hasMethod(ClassReflection $classReflection, string $methodName):
                 return true;
             }
         }
-
         if (!$classReflection->is(Association::class)) {
             return false;
         }
-
-        // For associations, provide magic find(All)?By methods
-        if (preg_match('/^find(All)?By/', $methodName) === 1) {
-            return true;
+        if (preg_match('/^find(All)?By/', $methodName) !== 1) {
+            return false;
         }
+        $classReflection = $this->getAssociationTargetClassReflection($classReflection);
 
-        return $this->getTableReflection()->hasMethod($methodName);
+        return !$classReflection->hasNativeMethod($methodName);
     }
 
     /**
@@ -120,4 +118,22 @@ public function getProperty(ClassReflection $classReflection, string $propertyNa
     {
         return $this->getTableReflection()->getNativeProperty($propertyName);
     }
+
+    /**
+     * @param \PHPStan\Reflection\ClassReflection $classReflection
+     * @return \PHPStan\Reflection\ClassReflection
+     */
+    protected function getAssociationTargetClassReflection(ClassReflection $classReflection): ClassReflection
+    {
+        $subType = $classReflection->getActiveTemplateTypeMap()->getTypes()['T'] ?? null;
+        if ($subType === null || !$subType->isObject()->yes()) {
+            return $this->getTableReflection();
+        }
+        $tableClass = $subType->getObjectClassReflections()[0] ?? null;
+        if ($tableClass !== null) {
+            return $tableClass;
+        }
+
+        return $this->getTableReflection();
+    }
 }

tests/test_app/Controller/NotesController.php

@@ -154,4 +154,33 @@ public function indexTestAssociation()
         $sameRole = $myUser->role === 'user';
         $this->set(compact('sameRole'));
     }
+
+    /**
+     * @return void
+     */
+    public function listUsers()
+    {
+        //UsersTable::findByNamed exists it is not a magic method
+        $userNamed = $this->Notes->Users->findByNamed('John Doe')->id;//Users is a BelongsTo association
+        $this->set(compact('userNamed'));
+        $userNamedMary = $this->fetchTable('Users')->findByNamed('Mary')->id;
+        $this->set(compact('userNamedMary'));
+        $myUserNamed = $this->Notes->MyUsers->findByNamed('John Doe')->id;//Users is a BelongsTo association
+        $this->set(compact('myUserNamed'));
+
+        //UsersTable::findByRole is a magic finder method
+        $userList = $this->Notes->Users->findByRole('admin')->all()->toArray();
+        $this->set(compact('userList'));
+        $userListGuest = $this->fetchTable('Users')->findByRole('guest')->all()->toArray();
+        $this->set(compact('userListGuest'));
+        $myUsersList = $this->Notes->MyUsers->findByRole('admin')->all()->toArray();
+        $this->set(compact('myUsersList'));
+
+        //UsersTable::findAllByFoo exists it is not a magic method
+        $users = $this->Notes->Users->findAllByFoo(100) / 20;
+        $myUsers = $this->Notes->MyUsers->findAllByFoo(100) / 30;
+        $this->set(compact('users', 'myUsers'));
+        //BelongsTo should match the correct Users table methods.
+        $this->Notes->Users->blockOld();
+    }
 }

tests/test_app/Model/Table/NotesTable.php

@@ -21,7 +21,7 @@
  * @method \App\Model\Entity\Note|\Cake\Datasource\EntityInterface get(mixed $primaryKey, string[]|string $finder = 'all',\Psr\SimpleCache\CacheInterface|string|null $cache = null,\Closure|string|null $cacheKey = null, mixed ...$args)
  * @property \App\Model\Table\VeryCustomize00009ArticlesTable&\Cake\ORM\Association\HasMany $VeryCustomize00009Articles
  * @property \Cake\ORM\Association\BelongsTo<\App\Model\Table\UsersTable> $Users
- * @property \Cake\ORM\Association\BelongsTo&\App\Model\Table\UsersTable $MyUsers
+ * @property \Cake\ORM\Association\BelongsTo&\App\Model\Table\UsersTable $MyUsers//Don't use generic here, we need this way for testing
  */
 class NotesTable extends Table
 {

tests/test_app/Model/Table/UsersTable.php

@@ -49,4 +49,22 @@ public function blockOld(): void
         $articleQuery = $this->Articles->findByTitle('Test');
         $articleQuery->first();
     }
+
+    /**
+     * @param string $name
+     * @return \App\Model\Entity\User
+     */
+    public function findByNamed(string $name): User
+    {
+        return new User(['name' => strtolower($name)]);
+    }
+
+    /**
+     * @param int $foo
+     * @return int
+     */
+    public function findAllByFoo(int $foo): int
+    {
+        return $foo * 200;
+    }
 }