Merge pull request #560 from FriendsOfCake/custom-finder

Allow using custom finder with options.
FriendsOfCake · Jan 2, 2018 · 39b29c3 · 39b29c3
2 parents ba256b5 + 81a8bdd
commit 39b29c3
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 3 deletions.
diff --git a/src/Traits/FindMethodTrait.php b/src/Traits/FindMethodTrait.php
@@ -12,8 +12,9 @@ trait FindMethodTrait
      * If `$method` is NULL the current value is returned
      * else the `findMethod` is changed
      *
-     * @param string|null $method Method name
-     * @return string
+     * @param string|array|null $method Method name as string or array where
+     * key is finder name and value is find options.
+     * @return string|array
      */
     public function findMethod($method = null)
     {
@@ -35,7 +36,13 @@ protected function _findRecord($id, Subject $subject)
     {
         $repository = $this->_table();
 
-        $query = $repository->find($this->findMethod());
+        $finder = $this->findMethod();
+        $options = [];
+        if (is_array($finder)) {
+            $options = (array)current($finder);
+            $finder = key($finder);
+        }
+        $query = $repository->find($finder, $options);
         $query->where([current($query->aliasField($repository->primaryKey())) => $id]);
 
         $subject->set([

diff --git a/tests/App/Model/Table/BlogsTable.php b/tests/App/Model/Table/BlogsTable.php
@@ -1,7 +1,23 @@
 <?php
 namespace Crud\Test\App\Model\Table;
 
+use Cake\ORM\Query;
+
 class BlogsTable extends \Cake\ORM\Table
 {
+    public $customOptions;
+
+    /**
+     * findWithCustomOptions
+     *
+     * @param Query $query
+     * @param array $options
+     * @return void
+     */
+    public function findWithCustomOptions(Query $query, array $options)
+    {
+        $this->customOptions = $options;
 
+        return $query;
+    }
 }
diff --git a/tests/TestCase/Action/EditActionTest.php b/tests/TestCase/Action/EditActionTest.php
@@ -74,6 +74,26 @@ public function testActionGetWithQueryArgs()
         $this->assertContains($expected, $result, '"body" do not match the expected value');
     }
 
+    /**
+     * Test for custom finder with options.
+     *
+     * @return void
+     */
+    public function testCustomFinder()
+    {
+        $this->_eventManager->on(
+            'Dispatcher.invokeController',
+            ['priority' => 1000],
+            function ($event) {
+                $this->_controller->Crud->action('edit')
+                    ->findMethod(['withCustomOptions' => ['foo' => 'bar']]);
+            }
+        );
+
+        $this->get('/blogs/edit/1');
+        $this->assertSame(['foo' => 'bar'], $this->_controller->Blogs->customOptions);
+    }
+
     /**
      * Test POST will update an existing record
      *