Merge pull request #206 from agungaprianto/add-settings-interface

add settings interface

app/dependencies.php

@@ -1,6 +1,7 @@
 <?php
 declare(strict_types=1);
 
+use App\Application\Settings\SettingsInterface;
 use DI\ContainerBuilder;
 use Monolog\Handler\StreamHandler;
 use Monolog\Logger;
@@ -11,9 +12,9 @@
 return function (ContainerBuilder $containerBuilder) {
     $containerBuilder->addDefinitions([
         LoggerInterface::class => function (ContainerInterface $c) {
-            $settings = $c->get('settings');
+            $settings = $c->get(SettingsInterface::class);
 
-            $loggerSettings = $settings['logger'];
+            $loggerSettings = $settings->get('logger');
             $logger = new Logger($loggerSettings['name']);
 
             $processor = new UidProcessor();

app/settings.php

@@ -1,19 +1,24 @@
 <?php
 declare(strict_types=1);
 
+use App\Application\Settings\Settings;
+use App\Application\Settings\SettingsInterface;
 use DI\ContainerBuilder;
 use Monolog\Logger;
 
 return function (ContainerBuilder $containerBuilder) {
+
     // Global Settings Object
     $containerBuilder->addDefinitions([
-        'settings' => [
-            'displayErrorDetails' => true, // Should be set to false in production
-            'logger' => [
-                'name' => 'slim-app',
-                'path' => isset($_ENV['docker']) ? 'php://stdout' : __DIR__ . '/../logs/app.log',
-                'level' => Logger::DEBUG,
-            ],
-        ],
+        SettingsInterface::class => function () {
+            return new Settings([
+                'displayErrorDetails' => true, // Should be set to false in production
+                'logger' => [
+                    'name' => 'slim-app',
+                    'path' => isset($_ENV['docker']) ? 'php://stdout' : __DIR__ . '/../logs/app.log',
+                    'level' => Logger::DEBUG,
+                ],
+            ]);
+        }
     ]);
 };

public/index.php

@@ -4,6 +4,7 @@
 use App\Application\Handlers\HttpErrorHandler;
 use App\Application\Handlers\ShutdownHandler;
 use App\Application\ResponseEmitter\ResponseEmitter;
+use App\Application\Settings\SettingsInterface;
 use DI\ContainerBuilder;
 use Slim\Factory\AppFactory;
 use Slim\Factory\ServerRequestCreatorFactory;
@@ -46,7 +47,7 @@
 $routes($app);
 
 /** @var bool $displayErrorDetails */
-$displayErrorDetails = $container->get('settings')['displayErrorDetails'];
+$displayErrorDetails = $container->get(SettingsInterface::class)->get('displayErrorDetails');
 
 // Create Request object from globals
 $serverRequestCreator = ServerRequestCreatorFactory::create();

src/Application/Actions/Action.php

@@ -41,14 +41,14 @@ public function __construct(LoggerInterface $logger)
     }
 
     /**
-     * @param Request  $request
+     * @param Request $request
      * @param Response $response
-     * @param array    $args
+     * @param array $args
      * @return Response
      * @throws HttpNotFoundException
      * @throws HttpBadRequestException
      */
-    public function __invoke(Request $request, Response $response, $args): Response
+    public function __invoke(Request $request, Response $response, array $args): Response
     {
         $this->request = $request;
         $this->response = $response;
@@ -98,7 +98,8 @@ protected function resolveArg(string $name)
     }
 
     /**
-     * @param  array|object|null $data
+     * @param array|object|null $data
+     * @param int $statusCode
      * @return Response
      */
     protected function respondWithData($data = null, int $statusCode = 200): Response

src/Application/Actions/User/UserAction.php

@@ -16,10 +16,11 @@ abstract class UserAction extends Action
 
     /**
      * @param LoggerInterface $logger
-     * @param UserRepository  $userRepository
+     * @param UserRepository $userRepository
      */
-    public function __construct(LoggerInterface $logger, UserRepository $userRepository)
-    {
+    public function __construct(LoggerInterface $logger,
+                                UserRepository $userRepository
+    ) {
         parent::__construct($logger);
         $this->userRepository = $userRepository;
     }

src/Application/Settings/Settings.php

@@ -0,0 +1,30 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Application\Settings;
+
+class Settings implements SettingsInterface
+{
+    /**
+     * @var array
+     */
+    private $settings;
+
+    /**
+     * Settings constructor.
+     * @param array $settings
+     */
+    public function __construct(array $settings)
+    {
+        $this->settings = $settings;
+    }
+
+    /**
+     * @param string $key
+     * @return mixed
+     */
+    public function get(string $key = '')
+    {
+        return (empty($key)) ? $this->settings : $this->settings[$key];
+    }
+}

src/Application/Settings/SettingsInterface.php

@@ -0,0 +1,13 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Application\Settings;
+
+interface SettingsInterface
+{
+    /**
+     * @param string $key
+     * @return mixed
+     */
+    public function get(string $key = '');
+}

tests/Application/Actions/ActionTest.php

@@ -25,7 +25,7 @@ public function __construct(
                 parent::__construct($loggerInterface);
             }
 
-            public function action() :Response
+            public function action(): Response
             {
                 return $this->respond(
                     new ActionPayload(
@@ -58,7 +58,7 @@ public function __construct(
                 parent::__construct($loggerInterface);
             }
 
-            public function action() :Response
+            public function action(): Response
             {
                 return $this->respondWithData(
                     [