Merge pull request #14 from SebKay/container-improvements

Container improvements

Author: SebKay

composer.json

@@ -24,7 +24,7 @@
         "slim/slim": "^4.6",
         "slim/psr7": "^1.2",
         "vlucas/phpdotenv": "^5.2",
-        "php-di/slim-bridge": "^3.0",
+        "php-di/slim-bridge": "^3.1",
         "twig/twig": "^3.1",
         "slim/csrf": "^1.0",
         "illuminate/database": "^8.27",
@@ -38,7 +38,7 @@
     },
     "scripts": {
         "build": "git clean -xff -e .env && composer install && yarn install && yarn run dev",
-        "build:prod": "git clean -xffd -e .env && composer install --no-dev && yarn install && yarn run prod",
+        "build:prod": "git clean -xffd -e .env && composer install --no-dev && yarn install --prod && yarn run prod",
         "lint:php": "./vendor/bin/phpcs --standard=PSR12 src",
         "fix:php": "./vendor/bin/phpcbf --standard=PSR12 src",
         "analyse:php": "./vendor/bin/psalm --show-info=true",

composer.lock

@@ -1,12 +1,16 @@
 <?php
 
+/**
+ * @var App\App $this
+ */
+
 use App\Controllers\HomeController;
 use Slim\Routing\RouteCollectorProxy;
 
 /**
  * Home
  */
 $this->slim->group('', function (RouteCollectorProxy $group) {
-    $group->get('/', HomeController::class . ':index')->setName('home');
-    $group->post('/', HomeController::class . ':update');
+    $group->get('/', [HomeController::class, 'index'])->setName('home');
+    $group->post('/', [HomeController::class, 'update']);
 });

inc/routes/web.php

@@ -3,14 +3,15 @@
 namespace App;
 
 use App\Container\Container;
+use App\Container\ContainerCreator;
 use App\Database\Database;
 use App\Middleware\ExampleMiddleware;
 use App\Handlers\HttpErrorHandler;
 use App\Handlers\ShutdownHandler;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 use Slim\App as SlimApp;
-use Slim\Factory\AppFactory;
+use DI\Bridge\Slim\Bridge as AppFactory;
 use Slim\Factory\ServerRequestCreatorFactory;
 
 class App
@@ -21,9 +22,9 @@ class App
     public $dev_mode;
 
     /**
-     * @var Container
+     * @var ContainerCreator
      */
-    protected $container;
+    protected $container_creator;
 
     /**
      * @var SlimApp
@@ -47,10 +48,10 @@ public function __construct()
     {
         $this->dev_mode = $this->isDevelopmentMode();
 
-        $this->container = new Container($this);
-        $this->slim      = AppFactory::createFromContainer($this->container()->get());
+        $this->container_creator = new ContainerCreator($this);
+        $this->slim              = AppFactory::create($this->container());
 
-        $this->container()->setup();
+        $this->container_creator->setup();
         $this->setupSlim();
 
         $this->database = new Database();
@@ -69,11 +70,11 @@ public function isDevelopmentMode(): bool
     /**
      * Get the container
      *
-     * @return Container
+     * @return \DI\Container
      */
-    public function container(): Container
+    public function container(): \DI\Container
     {
-        return $this->container;
+        return $this->container_creator->container();
     }
 
     /**
@@ -97,7 +98,7 @@ protected function addMiddleware(): void
             ->addErrorMiddleware($this->dev_mode, false, false)
             ->setDefaultErrorHandler($this->error_handler);
 
-        $this->slim()->add('csrf');
+        $this->slim()->add($this->container()->get('csrf'));
         // $this->slim()->add(ExampleMiddleware::class);
     }
 
@@ -115,7 +116,7 @@ protected function addRoutes(): void
     protected function addErrorHandler(): void
     {
         $this->error_handler = new HttpErrorHandler(
-            $this->container()->get(),
+            $this->container(),
             $this->slim()->getCallableResolver(),
             $this->slim()->getResponseFactory()
         );

src/App.php

@@ -9,7 +9,7 @@
 
 class CSRFService extends Service
 {
-    public function name(): string
+    public static function name(): string
     {
         return 'csrf';
     }

src/Container/CSRFService.php

@@ -3,8 +3,9 @@
 namespace App\Container;
 
 use App\App;
+use App\Controllers\HomeController;
 
-class Container
+class ContainerCreator
 {
     /**
      * @var App
@@ -30,7 +31,7 @@ protected function services(): array
         ];
     }
 
-    public function addServices(): void
+    protected function addServices(): void
     {
         foreach ($this->services() as $service) {
             $this->container->set(
@@ -40,12 +41,30 @@ public function addServices(): void
         }
     }
 
+    protected function controllers(): array
+    {
+        return [
+            HomeController::class
+        ];
+    }
+
+    protected function addControllers(): void
+    {
+        foreach ($this->controllers() as $controller) {
+            $this->container->set(
+                $controller,
+                new $controller($this->container())
+            );
+        }
+    }
+
     public function setup(): void
     {
         $this->addServices();
+        $this->addControllers();
     }
 
-    public function get(): \DI\Container
+    public function container(): \DI\Container
     {
         return $this->container;
     }

src/Container/Container.php src/Container/ContainerCreator.phpsrc/Container/Container.php renamed to src/Container/ContainerCreator.php

@@ -28,7 +28,7 @@ public function __construct(\DI\Container $container, App $app)
         $this->dev_mode  = $this->app->dev_mode;
     }
 
-    abstract public function name(): string;
+    abstract public static function name(): string;
 
     abstract public function config();
 }

src/Container/Service.php

@@ -6,7 +6,7 @@
 
 class ViewService extends Service
 {
-    public function name(): string
+    public static function name(): string
     {
         return 'view';
     }

src/Container/ViewService.php

@@ -13,17 +13,16 @@ class HomeController extends Controller
      *
      * @param ServerRequestInterface $request
      * @param ResponseInterface $response
-     * @param array $args
      * @return ResponseInterface
      */
-    public function index(ServerRequestInterface $request, ResponseInterface $response, array $args): ResponseInterface
+    public function index(ServerRequestInterface $request, ResponseInterface $response): ResponseInterface
     {
         return $this->view->respond(
             $response,
             'layouts/home.twig',
             [
-                'name'   => 'Jim',
-                'csrf'   => Helpers::generateCSRFData($this->csrf, $request)
+                'name' => 'Jim',
+                'csrf' => Helpers::generateCSRFData($this->csrf, $request)
             ]
         );
     }
@@ -33,10 +32,9 @@ public function index(ServerRequestInterface $request, ResponseInterface $respon
      *
      * @param ServerRequestInterface $request
      * @param ResponseInterface $response
-     * @param array $args
      * @return ResponseInterface
      */
-    public function update(ServerRequestInterface $request, ResponseInterface $response, array $args): ResponseInterface
+    public function update(ServerRequestInterface $request, ResponseInterface $response): ResponseInterface
     {
         return $this->view->respond(
             $response,

src/Controllers/HomeController.php

@@ -66,6 +66,8 @@ protected function respond(): ResponseInterface
         $type        = self::SERVER_ERROR;
         $description = 'An internal error has occurred while processing your request.';
 
+        // ray($exception);
+
         if ($exception instanceof HttpException) {
             $statusCode  = (int) $exception->getCode();
             $description = $exception->getMessage();