Refactor project architecture 🚀

Author: pH-7

.env.sample

@@ -1 +1,2 @@
-PRODUCTION_MODE=true
+PRODUCTION_MODE=false
+TIMEZONE="Europe/Dublin"

app/bootstrap.php

@@ -11,15 +11,19 @@
 $dotenv = Dotenv::createImmutable(dirname(__DIR__));
 $dotenv->load();
 
-$dotenv->required(['PRODUCTION_MODE']);
+$dotenv->required(['PRODUCTION_MODE', 'TIMEZONE']);
 
 // Convert "true/false" string from phpdotenv to boolean
-define('PRODUCTION_MODE', filter_var($_ENV['PRODUCTION_MODE'], FILTER_VALIDATE_BOOLEAN));
-define('DEBUG_MODE', !PRODUCTION_MODE);
+define('IS_PRODUCTION_MODE', filter_var($_ENV['PRODUCTION_MODE'], FILTER_VALIDATE_BOOLEAN));
+define('IS_DEBUG_MODE', !IS_PRODUCTION_MODE);
 
 // Set up settings
 $containerBuilder->addDefinitions(__DIR__ . '/container.php');
 
+if (IS_PRODUCTION_MODE) {
+    $containerBuilder->enableCompilation(__DIR__ . '/../var/cache');
+}
+
 // Build PHP-DI Container instance
 $container = $containerBuilder->build();
 
@@ -32,4 +36,13 @@
 // Register middleware
 (require __DIR__ . '/middleware.php')($app);
 
+// Set up repositories
+/*(require __DIR__ . '/repositories.php')($app);
+$repositories = require __DIR__ . '/repositories.php';*/
+
+// Set up dependencies
+/*(require __DIR__ . '/repositories.php')($app);
+$repositories = require __DIR__ . '/dependencies.php';*/
+
+
 return $app;

app/middleware.php

@@ -1,6 +1,5 @@
 <?php
 
-use Selective\BasePath\BasePathMiddleware;
 use Slim\App;
 use Slim\Middleware\ErrorMiddleware;
 
@@ -11,8 +10,6 @@
     // Add the Slim built-in routing middleware
     $app->addRoutingMiddleware();
 
-    $app->add(BasePathMiddleware::class);
-
     // Catch exceptions and errors
     $app->add(ErrorMiddleware::class);
 };

app/routes.php

@@ -12,16 +12,5 @@
 
 return function (App $app) {
     $app->get('/', \App\Action\HomeAction::class)->setName('home');
-
-    $app->options('/{routes:.*}', function (Request $request, Response $response) {
-        // CORS Pre-Flight OPTIONS Request Handler
-        return $response;
-    });
-
-    $app->get('/{name}', function (Request $request, Response $response, array $args) {
-        $response->getBody()->write('Hello ' . $args['name']);
-        return $response;
-    });
-
     $app->post('/users', UserCreateAction::class);
 };

app/settings.php

@@ -1,25 +1,33 @@
 <?php
-declare(strict_types=1);
-
-use App\Application\Setting\Settings;
-use App\Application\Setting\SettingsInterface;
-use DI\ContainerBuilder;
-use Monolog\Logger;
-
-return function (ContainerBuilder $containerBuilder) {
-    // Global Settings Object
-    $containerBuilder->addDefinitions([
-        SettingsInterface::class => function () {
-            return new Settings([
-                'displayErrorDetails' => PRODUCTION_MODE,
-                'logError'            => false,
-                'logErrorDetails'     => false,
-                'logger' => [
-                    'name' => 'slim-app',
-                    'path' => isset($_ENV['docker']) ? 'php://stdout' : __DIR__ . '/../logs/app.log',
-                    'level' => Logger::DEBUG,
-                ],
-            ]);
-        }
-    ]);
-};
+
+// Should be set to 0 in production
+error_reporting(E_ALL);
+
+// Should be set to '0' in production
+ini_set('display_errors', IS_DEBUG_MODE);
+
+// Timezone
+date_default_timezone_set($_ENV['TIMEZONE'] ?? 'Europe/Dublin');
+
+// Settings
+$settings = [];
+
+// Path settings
+$settings['root'] = dirname(__DIR__);
+
+// Error Handling Middleware settings
+$settings['error'] = [
+
+    // Should be set to false in production
+    'display_error_details' => IS_DEBUG_MODE,
+
+    // Parameter is passed to the default ErrorHandler
+    // View in rendered output by enabling the "displayErrorDetails" setting.
+    // For the console and unit tests we also disable it
+    'log_errors' => IS_DEBUG_MODE,
+
+    // Display error details in error log
+    'log_error_details' => IS_DEBUG_MODE,
+];
+
+return $settings;

composer.json

@@ -33,7 +33,6 @@
         "illuminate/database": "^8.61",
         "monolog/monolog": "^2.2",
         "php-di/php-di": "^6.3",
-        "shrikeh/teapot": "^2.3",
         "slim/psr7": "^1.3",
         "slim/slim": "^4.7",
         "vlucas/phpdotenv": "^5.3"

public/index.php

@@ -11,69 +11,5 @@
 
 require __DIR__ . '/../vendor/autoload.php';
 
-// Instantiate PHP-DI ContainerBuilder
-$containerBuilder = new ContainerBuilder();
-
-$settings = require __DIR__ . '/../app/bootstrap.php';
-
-if (DEBUG_MODE) {
-	$containerBuilder->enableCompilation(__DIR__ . '/../var/cache');
-}
-
 // Set up settings
-$settings($containerBuilder);
-
-// Set up dependencies
-$dependencies = require __DIR__ . '/../app/dependencies.php';
-$dependencies($containerBuilder);
-
-// Set up repositories
-$repositories = require __DIR__ . '/../app/repositories.php';
-$repositories($containerBuilder);
-
-// Build PHP-DI Container instance
-$container = $containerBuilder->build();
-
-// Instantiate the app
-AppFactory::setContainer($container);
-$app = AppFactory::create();
-$callableResolver = $app->getCallableResolver();
-
-// Register middleware
-$middleware = require __DIR__ . '/../app/middleware.php';
-$middleware($app);
-
-// Register routes
-$routes = require __DIR__ . '/../app/routes.php';
-$routes($app);
-
-/** @var SettingsInterface $settings */
-$settings = $container->get(SettingsInterface::class);
-
-$displayErrorDetails = $settings->get('displayErrorDetails');
-$logError = $settings->get('logError');
-$logErrorDetails = $settings->get('logErrorDetails');
-
-// Create Request object from globals
-$serverRequestCreator = ServerRequestCreatorFactory::create();
-$request = $serverRequestCreator->createServerRequestFromGlobals();
-
-// Create Error Handler
-$responseFactory = $app->getResponseFactory();
-$errorHandler = new HttpErrorHandler($callableResolver, $responseFactory);
-
-// Create Shutdown Handler
-$shutdownHandler = new ShutdownHandler($request, $errorHandler, $displayErrorDetails);
-register_shutdown_function($shutdownHandler);
-
-// Add Routing Middleware
-$app->addRoutingMiddleware();
-
-// Add Error Middleware
-$errorMiddleware = $app->addErrorMiddleware($displayErrorDetails, $logError, $logErrorDetails);
-$errorMiddleware->setDefaultErrorHandler($errorHandler);
-
-// Run App & Emit Response
-$response = $app->handle($request);
-$responseEmitter = new ResponseEmitter();
-$responseEmitter->emit($response);
+(require __DIR__ . '/../app/bootstrap.php')->run();

src/Application/Action/Action.php src/Action/Action.phpsrc/Application/Action/Action.php renamed to src/Action/Action.php

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace App\Application\Action;
+namespace App\Action;
 
 use App\Domain\DomainException\DomainRecordNotFoundException;
 use Psr\Http\Message\ResponseInterface as Response;

src/Application/Action/ActionError.php src/Action/ActionError.phpsrc/Application/Action/ActionError.php renamed to src/Action/ActionError.php

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace App\Application\Action;
+namespace App\Action;
 
 use JsonSerializable;
 

src/Application/Action/ActionPayload.php src/Action/ActionPayload.phpsrc/Application/Action/ActionPayload.php renamed to src/Action/ActionPayload.php

@@ -1,7 +1,7 @@
 <?php
 declare(strict_types=1);
 
-namespace App\Application\Action;
+namespace App\Action;
 
 use JsonSerializable;