Merge pull request #563 from FriendsOfCake/custom-finder

Allow all actions to use custom finder with options.
FriendsOfCake · Jan 6, 2018 · 52b2936 · 52b2936
2 parents 39b29c3 + 20ae205
commit 52b2936
Show file tree

Hide file tree

Showing 7 changed files with 97 additions and 9 deletions.
diff --git a/src/Action/Bulk/BaseAction.php b/src/Action/Bulk/BaseAction.php
@@ -105,7 +105,9 @@ protected function _constructSubject(array $ids)
     {
         $repository = $this->_table();
 
-        $query = $repository->find($this->findMethod(), $this->_getFindConfig($ids));
+        list($finder, $options) = $this->_extractFinder();
+        $options = array_merge($options, $this->_getFindConfig($ids));
+        $query = $repository->find($finder, $options);
 
         $subject = $this->_subject();
         $subject->set([

diff --git a/src/Action/IndexAction.php b/src/Action/IndexAction.php
@@ -49,7 +49,8 @@ class IndexAction extends BaseAction
      */
     protected function _handle()
     {
-        $query = $this->_table()->find($this->findMethod());
+        list($finder, $options) = $this->_extractFinder();
+        $query = $this->_table()->find($finder, $options);
         $subject = $this->_subject(['success' => true, 'query' => $query]);
 
         $this->_trigger('beforePaginate', $subject);

diff --git a/src/Action/LookupAction.php b/src/Action/LookupAction.php
@@ -1,6 +1,7 @@
 <?php
 namespace Crud\Action;
 
+use Crud\Traits\FindMethodTrait;
 use Crud\Traits\SerializeTrait;
 use Crud\Traits\ViewTrait;
 use Crud\Traits\ViewVarTrait;
@@ -14,6 +15,7 @@
 class LookupAction extends BaseAction
 {
 
+    use FindMethodTrait;
     use SerializeTrait;
     use ViewTrait;
     use ViewVarTrait;
@@ -36,7 +38,9 @@ class LookupAction extends BaseAction
      */
     protected function _handle()
     {
-        $query = $this->_table()->find($this->config('findMethod'), $this->_getFindConfig());
+        list($finder, $options) = $this->_extractFinder();
+        $options = array_merge($options, $this->_getFindConfig());
+        $query = $this->_table()->find($finder, $options);
         $subject = $this->_subject(['success' => true, 'query' => $query]);
 
         $this->_trigger('beforeLookup', $subject);

diff --git a/src/Traits/FindMethodTrait.php b/src/Traits/FindMethodTrait.php
@@ -25,6 +25,24 @@ public function findMethod($method = null)
         return $this->config('findMethod', $method);
     }
 
+    /**
+     * Extracts the finder name and options out of the "findMethod" option.
+     *
+     * @return array An array containing in the first position the finder name
+     *   and in the second the options to be passed to it.
+     */
+    protected function _extractFinder()
+    {
+        $finder = $this->findMethod();
+        $options = [];
+        if (is_array($finder)) {
+            $options = (array)current($finder);
+            $finder = key($finder);
+        }
+
+        return [$finder, $options];
+    }
+
     /**
      * Find a record from the ID
      *
@@ -36,12 +54,7 @@ protected function _findRecord($id, Subject $subject)
     {
         $repository = $this->_table();
 
-        $finder = $this->findMethod();
-        $options = [];
-        if (is_array($finder)) {
-            $options = (array)current($finder);
-            $finder = key($finder);
-        }
+        list($finder, $options) = $this->_extractFinder();
         $query = $repository->find($finder, $options);
         $query->where([current($query->aliasField($repository->primaryKey())) => $id]);
 

diff --git a/tests/TestCase/Action/Bulk/SetValueActionTest.php b/tests/TestCase/Action/Bulk/SetValueActionTest.php
@@ -178,4 +178,31 @@ function ($event) {
         $this->assertTrue($this->_subject->success);
         $this->assertRedirect('/users');
     }
+
+    /**
+     * Test custom finder with options
+     *
+     * @return void
+     */
+    public function testPostWithCustomFinder()
+    {
+        $this->_eventManager->on(
+            'Dispatcher.invokeController',
+            ['priority' => 1000],
+            function ($event) {
+                $this->_subscribeToEvents($this->_controller);
+                $this->_controller->Crud->action('deactivateAll')
+                    ->findMethod(['withCustomOptions' => ['foo' => 'bar']]);
+            }
+        );
+
+        $this->post('/blogs/deactivateAll', [
+            'id' => [
+                1,
+                2,
+            ],
+        ]);
+
+        $this->assertSame(['foo' => 'bar'], $this->_controller->Blogs->customOptions);
+    }
 }
diff --git a/tests/TestCase/Action/IndexActionTest.php b/tests/TestCase/Action/IndexActionTest.php
@@ -104,4 +104,24 @@ function () {
         $this->get('/blogs');
         $this->assertContains('Page 1 of 1, showing 1 records out of 1 total', $this->_response->body());
     }
+
+    /**
+     * Test using custom finder with options.
+     *
+     * @return void
+     */
+    public function testGetWithCustomFinder()
+    {
+        $this->_eventManager->on(
+            'Dispatcher.invokeController',
+            ['priority' => 1000],
+            function () {
+                $this->_controller->Crud->action('index')
+                    ->findMethod(['withCustomOptions' => ['foo' => 'bar']]);
+            }
+        );
+
+        $this->get('/blogs');
+        $this->assertSame(['foo' => 'bar'], $this->_controller->Blogs->customOptions);
+    }
 }
diff --git a/tests/TestCase/Action/LookupActionTest.php b/tests/TestCase/Action/LookupActionTest.php
@@ -103,4 +103,25 @@ function () {
         $this->assertNotNull($this->viewVariable('viewVar'));
         $this->assertEquals($expected, $this->viewVariable('blogs')->toArray());
     }
+
+    /**
+     * Test using custom finder with options.
+     *
+     * @return void
+     */
+    public function testGetWithCustomFinder()
+    {
+        $this->_eventManager->on(
+            'Dispatcher.invokeController',
+            ['priority' => 1000],
+            function () {
+                $this->_subscribeToEvents($this->_controller);
+                $this->_controller->Crud->action('lookup')
+                    ->findMethod(['withCustomOptions' => ['foo' => 'bar']]);
+            }
+        );
+
+        $this->get('/blogs/lookup.json');
+        $this->assertSame(['foo' => 'bar'], $this->_controller->Blogs->customOptions);
+    }
 }