Add typed controller properties and simplify layout handling

Author: ilhooq

src/Controller.php

@@ -40,7 +40,7 @@ abstract class Controller implements RequestHandlerInterface
      *
      * @var string
      */
-    public $id = '';
+    public string $id = '';
 
     /**
      * The name of the layout to be applied to this controller's views.
@@ -49,28 +49,28 @@ abstract class Controller implements RequestHandlerInterface
      * Defaults to null, meaning the actual layout value should inherit that from module's layout value.
      * If false, no layout will be applied.
      *
-     * @var null|string|false
+     * @var string|false
      */
-    public $layout;
+    public string|false $layout = false;
 
     /**
      * The root directory that contains view files for this controller.
      *
      * @var string
      */
-    public $viewPath;
+    public string $viewPath;
 
     /**
      * The module that this controller belongs to.
      *
      * @var Module
      */
-    public $module;
+    public Module $module;
 
     /**
-     * @var ViewInterface
+     * @var ViewInterface|null
      */
-    protected $view;
+    protected ?ViewInterface $view = null;
 
     /**
      * The dependency injection container, injected by Module::createController().
@@ -90,13 +90,13 @@ abstract class Controller implements RequestHandlerInterface
      *
      * @var ServerRequestInterface
      */
-    protected $request;
+    protected ServerRequestInterface $request;
 
     /**
      *
      * @var ResponseInterface
      */
-    protected $response;
+    protected ResponseInterface $response;
 
     public function handle(ServerRequestInterface $request): ResponseInterface
     {
@@ -140,15 +140,12 @@ private function runAction(string $id, array $params = []): ResponseInterface
 
             $view = $this->getView();
 
-            if ($view instanceof View) {
+            if ($view instanceof View && $this->layout !== false) {
                 $app = $this->module->getApplication();
-
-                if ($this->layout !== false) {
-                    $layout = $this->layout === null ? $app->defaultLayout : $this->layout;
-                    $path = $this->module->layoutPath ?? $app->defaultLayoutPath ;
-                    $view->paths[] = $path;
-                    $response = $view->render($layout, ['content' => $response]);
-                }
+                $layout = $this->layout == false ? $app->defaultLayout : $this->layout;
+                $path = $this->module->layoutPath ?? $app->defaultLayoutPath ;
+                $view->paths[] = $path;
+                $response = $view->render($layout, ['content' => $response]);
             }
 
             $response = $this->response->withBody((new StreamFactory())->createStream($response));
@@ -172,7 +169,7 @@ private function getMethodArguments(string $methodName, array $data = []): array
         $actionParams = [];
 
         foreach ($method->getParameters() as $param) {
-            /* @var $param \ReflectionParameter */
+            /** @var \ReflectionParameter $param */
             $name = (string) $param->getName();
 
             if (isset($data[$name])) {
@@ -265,8 +262,10 @@ protected function getView(): ?ViewInterface
 
             try {
                 $view = $container->get(View::class);
-                assert($view instanceof View);
-                $view->attachBehavior('getUrl', [$this, 'getUrl']);
+
+                if ($view instanceof View) {
+                    $view->attachBehavior('getUrl', [$this, 'getUrl']);
+                }
             } catch (NotFoundExceptionInterface $e) {
                 try {
                     $view = $container->get(ViewInterface::class);
@@ -275,8 +274,9 @@ protected function getView(): ?ViewInterface
                 }
             }
 
-            assert($view instanceof ViewInterface);
-            $this->view = $view;
+            if ($view instanceof ViewInterface) {
+                $this->view = $view;
+            }
         }
 
         return $this->view;

tests/modules/test/controllers/DefaultController.php

@@ -3,7 +3,7 @@
 
 class DefaultController extends \Piko\Controller
 {
-    public $layout = false;
+    public string|false $layout = false;
 
     public function indexAction()
     {
@@ -14,4 +14,4 @@ public function errorAction($exception)
     {
         return $exception->getMessage();
     }
-}
+}

tests/modules/test/controllers/IndexController.php

@@ -5,7 +5,7 @@
 
 class IndexController extends \Piko\Controller
 {
-    public $layout = false;
+    public string|false $layout = false;
 
     public function setRequest(ServerRequestInterface $request): void
     {

tests/modules/test/controllers/TestController.php

@@ -8,7 +8,7 @@
 
 class TestController extends \Piko\Controller
 {
-    public $layout = false;
+    public string|false $layout = false;
 
     protected \PDO $db;
 

tests/modules/test/controllers/User2Controller.php

@@ -5,7 +5,7 @@
 
 class User2Controller extends \Piko\Controller
 {
-    public $layout = false;
+    public string|false $layout = false;
 
     public function __construct(protected ?UserService $user = null)
     {

tests/modules/test/sub/controllers/TestController.php

@@ -4,10 +4,10 @@
 
 class TestController extends \Piko\Controller
 {
-    public $layout = false;
+    public string|false $layout = false;
 
     public function indexAction()
     {
         return 'TestModule::SubModule::TestController::indexAction';
     }
-}
+}

tests/modules/test/sub/til/controllers/TestController.php

@@ -3,10 +3,10 @@
 
 class TestController extends \Piko\Controller
 {
-    public $layout = false;
+    public string|false $layout = false;
 
     public function indexAction()
     {
         return 'TestModule::SubModule::SubtilModule::TestController::indexAction';
     }
-}
+}