Add setter and getter for autoRender flag.

cakephp · Nov 20, 2017 · 0b6e5ad · 0b6e5ad
1 parent 4fdab63
commit 0b6e5ad
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 2 deletions.
diff --git a/src/Controller/Controller.php b/src/Controller/Controller.php
@@ -162,7 +162,7 @@ class Controller implements EventListenerInterface, EventDispatcherInterface
      *
      * @var bool
      */
-    public $autoRender = true;
+    protected $autoRender = true;
 
     /**
      * Instance of ComponentRegistry used to create Components
@@ -337,6 +337,7 @@ public function __get($name)
         $deprecated = [
             'name' => 'getName',
             'plugin' => 'getPlugin',
+            'autoRender' => 'isAutoRenderEnabled',
         ];
         if (isset($deprecated[$name])) {
             $method = $deprecated[$name];
@@ -379,6 +380,7 @@ public function __set($name, $value)
         $deprecated = [
             'name' => 'setName',
             'plugin' => 'setPlugin',
+            'autoRender' => 'enableAutoRender',
         ];
         if (isset($deprecated[$name])) {
             $method = $deprecated[$name];
@@ -452,6 +454,29 @@ public function setPlugin($plugin)
         return $this;
     }
 
+    /**
+     * Returns true if an action should be rendered automatically.
+     *
+     * @return bool
+     */
+    public function isAutoRenderEnabled()
+    {
+        return $this->autoRender;
+    }
+
+    /**
+     * Enable or disbale automatic action rendering.
+     *
+     * @param bool $autoRender Flag.
+     * @return $this
+     */
+    public function enableAutoRender($autoRender = true)
+    {
+        $this->autoRender = $autoRender;
+
+        return $this;
+    }
+
     /**
      * Gets the request instance.
      *

diff --git a/src/Http/ActionDispatcher.php b/src/Http/ActionDispatcher.php
@@ -121,7 +121,7 @@ protected function _invoke(Controller $controller)
             throw new LogicException('Controller actions can only return Cake\Http\Response or null.');
         }
 
-        if (!$response && $controller->autoRender) {
+        if (!$response && $controller->isAutoRenderEnabled()) {
             $controller->render();
         }
 

diff --git a/tests/TestCase/Controller/ControllerTest.php b/tests/TestCase/Controller/ControllerTest.php
@@ -1154,6 +1154,23 @@ public function testResponse()
         $this->assertSame($response, $controller->getResponse());
     }
 
+    /**
+     * Test autoRender getter and setter.
+     *
+     * @return void
+     */
+    public function testAutoRender()
+    {
+        $controller = new PostsController();
+        $this->assertTrue($controller->isAutoRenderEnabled());
+
+        $this->assertSame($controller, $controller->enableAutoRender(false));
+        $this->assertFalse($controller->isAutoRenderEnabled());
+
+        $this->assertSame($controller, $controller->enableAutoRender());
+        $this->assertTrue($controller->isAutoRenderEnabled());
+    }
+
     /**
      * Tests deprecated view propertiyes work
      *