Develop (#5)

* controller events

* refactoring

Author: n3vrax

CHANGELOG.md

@@ -0,0 +1,15 @@
+## 0.1.0 - 2017-03-07
+
+Initial tagged release
+
+### Added
+* Everything
+
+### Deprecated
+* Nothing
+
+### Removed
+* Nothing
+
+### Fixed
+* Nothing

composer.json

@@ -10,10 +10,12 @@
     }
   ],
   "require": {
-    "php": "^5.6 || ^7.0",
+    "php": "^7.1",
     "psr/http-message": "^1.0",
     "container-interop/container-interop": "^1.1",
-    "zendframework/zend-servicemanager": "^3.0"
+    "zendframework/zend-servicemanager": "^3.0",
+
+    "dotkernel/dot-event": "~0.1"
   },
   "require-dev": {
     "zendframework/zend-expressive-template": "^1.0",
@@ -34,7 +36,7 @@
   },
   "extra": {
     "branch-alias": {
-      "dev-master": "0.6-dev"
+      "dev-master": "0.2-dev"
     }
   }
 }

src/AbstractActionController.php

@@ -7,27 +7,43 @@
  * Time: 8:24 PM
  */
 
+declare(strict_types = 1);
+
 namespace Dot\Controller;
 
+use Dot\Controller\Event\ControllerEvent;
 use Psr\Http\Message\ResponseInterface;
 
 /**
  * Class AbstractActionController
  * @package Dot\Controller
  */
-class AbstractActionController extends AbstractController
+abstract class AbstractActionController extends AbstractController
 {
     /**
      * @return ResponseInterface
      */
-    public function dispatch()
+    public function dispatch(): ResponseInterface
     {
         $request = $this->request;
-        $action = AbstractController::getMethodFromAction(
-            strtolower($request->getAttribute('action', 'index'))
-        );
+
+        $action = strtolower(trim($request->getAttribute('action', 'index')));
+        if (empty($action)) {
+            $action = 'index';
+        }
+
+        $action = AbstractController::getMethodFromAction($action);
 
         if (method_exists($this, $action)) {
+            $r = $this->dispatchEvent(ControllerEvent::EVENT_CONTROLLER_DISPATCH, [
+                'request' => $request,
+                'next' => $this->getNext(),
+                'method' => $action
+            ]);
+            if ($r instanceof ResponseInterface) {
+                return $r;
+            }
+
             return $this->$action();
         }
 

src/AbstractController.php

@@ -7,19 +7,28 @@
  * Time: 8:24 PM
  */
 
+declare(strict_types = 1);
+
 namespace Dot\Controller;
 
+use Dot\Controller\Event\DispatchControllerEventsTrait;
+use Dot\Controller\Plugin\PluginInterface;
 use Dot\Controller\Plugin\PluginManager;
 use Dot\Controller\Plugin\PluginManagerAwareInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
+use Zend\EventManager\EventManagerAwareInterface;
 
 /**
  * Class AbstractController
  * @package Dot\Controller
  */
-abstract class AbstractController implements PluginManagerAwareInterface
+abstract class AbstractController implements
+    PluginManagerAwareInterface,
+    EventManagerAwareInterface
 {
+    use DispatchControllerEventsTrait;
+
     /** @var  PluginManager */
     protected $pluginManager;
 
@@ -32,13 +41,16 @@ abstract class AbstractController implements PluginManagerAwareInterface
     /** @var  callable */
     protected $next;
 
+    /** @var bool */
+    protected $debug = false;
+
     /**
      * Transform an "action" token into a method name
      *
      * @param  string $action
      * @return string
      */
-    public static function getMethodFromAction($action)
+    public static function getMethodFromAction(string $action): string
     {
         $method = str_replace(['.', '-', '_'], ' ', $action);
         $method = ucwords($method);
@@ -58,36 +70,36 @@ public function __invoke(
         ServerRequestInterface $request,
         ResponseInterface $response,
         callable $next = null
-    ) {
+    ): ResponseInterface {
         $this->request = $request;
         $this->response = $response;
         $this->next = $next;
 
         return $this->dispatch();
     }
 
-    abstract public function dispatch();
+    abstract public function dispatch(): ResponseInterface;
 
     /**
      * @return ServerRequestInterface
      */
-    public function getRequest()
+    public function getRequest(): ServerRequestInterface
     {
         return $this->request;
     }
 
     /**
      * @return ResponseInterface
      */
-    public function getResponse()
+    public function getResponse(): ResponseInterface
     {
         return $this->response;
     }
 
     /**
      * @return callable
      */
-    public function getNext()
+    public function getNext(): callable
     {
         return $this->next;
     }
@@ -102,7 +114,7 @@ public function getNext()
      * @param  array $params
      * @return mixed
      */
-    public function __call($method, $params)
+    public function __call(string $method, array $params)
     {
         $plugin = $this->plugin($method);
         if (is_callable($plugin)) {
@@ -115,29 +127,43 @@ public function __call($method, $params)
      * Get plugin instance
      *
      * @param  string $name Name of plugin to return
-     * @param  null|array $options Options to pass to plugin constructor (if not already instantiated)
-     * @return mixed
+     * @param  array $options Options to pass to plugin constructor (if not already instantiated)
+     * @return PluginInterface|callable
      */
-    public function plugin($name, array $options = null)
+    public function plugin(string $name, array $options = []): PluginInterface
     {
         return $this->getPluginManager()->get($name, $options);
     }
 
     /**
      * @return PluginManager
      */
-    public function getPluginManager()
+    public function getPluginManager(): PluginManager
     {
         return $this->pluginManager;
     }
 
     /**
      * @param PluginManager $pluginManager
-     * @return $this
      */
     public function setPluginManager(PluginManager $pluginManager)
     {
         $this->pluginManager = $pluginManager;
-        return $this;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isDebug(): bool
+    {
+        return $this->debug;
+    }
+
+    /**
+     * @param bool $debug
+     */
+    public function setDebug(bool $debug)
+    {
+        $this->debug = $debug;
     }
 }

src/ConfigProvider.php

@@ -7,8 +7,11 @@
  * Time: 8:24 PM
  */
 
+declare(strict_types = 1);
+
 namespace Dot\Controller;
 
+use Dot\Controller\Factory\ControllerEventListenersInitializer;
 use Dot\Controller\Factory\PluginManagerAwareInitializer;
 use Dot\Controller\Factory\PluginManagerFactory;
 use Dot\Controller\Plugin\PluginManager;
@@ -19,22 +22,30 @@
  */
 class ConfigProvider
 {
-    public function __invoke()
+    public function __invoke(): array
     {
         return [
+            'dependencies' => $this->getDependenciesConfig(),
+
             'dot_controller' => [
-                'plugin_manager' => []
-            ],
 
-            'dependencies' => [
-                'factories' => [
-                    PluginManager::class => PluginManagerFactory::class,
-                ],
+                'plugin_manager' => [],
 
-                'initializers' => [
-                    PluginManagerAwareInitializer::class,
-                ],
+                'event_listeners' => [],
+            ],
+        ];
+    }
+
+    public function getDependenciesConfig(): array
+    {
+        return [
+            'factories' => [
+                PluginManager::class => PluginManagerFactory::class,
             ],
+            'initializers' => [
+                PluginManagerAwareInitializer::class,
+                ControllerEventListenersInitializer::class,
+            ]
         ];
     }
 }

src/Event/AbstractControllerEventListener.php

@@ -0,0 +1,24 @@
+<?php
+/**
+ * @copyright: DotKernel
+ * @library: dot-controller
+ * @author: n3vrax
+ * Date: 1/27/2017
+ * Time: 7:12 PM
+ */
+
+declare(strict_types = 1);
+
+namespace Dot\Controller\Event;
+
+use Zend\EventManager\AbstractListenerAggregate;
+
+/**
+ * Class AbstractControllerEventListener
+ * @package Dot\Controller\Event
+ */
+abstract class AbstractControllerEventListener extends AbstractListenerAggregate implements
+    ControllerEventListenerInterface
+{
+    use ControllerEventListenerTrait;
+}

src/Event/ControllerEvent.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * @copyright: DotKernel
+ * @library: dot-controller
+ * @author: n3vra
+ * Date: 1/27/2017
+ * Time: 4:20 PM
+ */
+
+declare(strict_types = 1);
+
+namespace Dot\Controller\Event;
+
+use Dot\Event\Event;
+
+/**
+ * Class ActionControllerEvent
+ * @package Dot\Controller\Event
+ */
+class ControllerEvent extends Event
+{
+    const EVENT_CONTROLLER_DISPATCH = 'event.controller.dispatch';
+}

src/Event/ControllerEventListenerInterface.php

@@ -0,0 +1,28 @@
+<?php
+/**
+ * @copyright: DotKernel
+ * @library: dot-controller
+ * @author: n3vra
+ * Date: 1/27/2017
+ * Time: 5:21 PM
+ */
+
+declare(strict_types = 1);
+
+namespace Dot\Controller\Event;
+
+use Zend\EventManager\ListenerAggregateInterface;
+
+/**
+ * Interface ActionControllerEventListenerInterface
+ * @package Dot\Controller\Event
+ */
+interface ControllerEventListenerInterface extends ListenerAggregateInterface
+{
+    const LISTEN_ALL = 1;
+
+    /**
+     * @param ControllerEvent $e
+     */
+    public function onDispatch(ControllerEvent $e);
+}