Implemented RouterCallViewEvent

This event gets called right before defaultCallable() invokes the requested method on the requested view. This allows other classes to intervene when required. Currently used by the WebComponent to suppress CSRF Exceptions.

src/FuzeWorks/Event/RouterCallViewEvent.php

@@ -0,0 +1,101 @@
+<?php
+/**
+ * FuzeWorks Framework MVCR Component.
+ *
+ * The FuzeWorks PHP FrameWork
+ *
+ * Copyright (C) 2013-2019 TechFuze
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ * @author    TechFuze
+ * @copyright Copyright (c) 2013 - 2019, TechFuze. (http://techfuze.net)
+ * @license   https://opensource.org/licenses/MIT MIT License
+ *
+ * @link  http://techfuze.net/fuzeworks
+ * @since Version 1.2.0
+ *
+ * @version Version 1.2.0
+ */
+
+namespace FuzeWorks\Event;
+
+use FuzeWorks\Controller;
+use FuzeWorks\Event;
+use FuzeWorks\View;
+
+/**
+ * Event that gets fired when a view is about to be called by the defaultCallable() in the Router.
+ *
+ * Use this to cancel the calling of a view method.
+ *
+ * Currently only used by Router::defaultCallable();
+ *
+ * This event is currently used in the WebComponent project. It allows the component to stop loading when
+ * a CSRFException is thrown, and the view has no method of handling this request
+ *
+ * @author    Abel Hoogeveen <abel@techfuze.net>
+ * @copyright Copyright (c) 2013 - 2019, TechFuze. (http://techfuze.net)
+ */
+class RouterCallViewEvent extends Event
+{
+    /**
+     * The function that will be loaded in the view
+     *
+     * @var string
+     */
+    public $viewMethod;
+
+    /**
+     * The parameters that will be provided to the function in the view
+     *
+     * @var string
+     */
+    public $viewParameters;
+
+    /**
+     * The route that resulted in this controller and view
+     *
+     * @var string
+     */
+    public $route;
+
+    /**
+     * The view the method will be called on
+     *
+     * @var View
+     */
+    public $view;
+
+    /**
+     * The controller that's associated with this View
+     *
+     * @var Controller
+     */
+    public $controller;
+
+    public function init(View $view, Controller $controller, string $viewMethod, string $viewParameters, string $route)
+    {
+        $this->view = $view;
+        $this->controller = $controller;
+        $this->viewMethod = $viewMethod;
+        $this->viewParameters = $viewParameters;
+        $this->route = $route;
+    }
+}

src/FuzeWorks/Router.php

@@ -36,6 +36,7 @@
 
 namespace FuzeWorks;
 
+use FuzeWorks\Event\RouterCallViewEvent;
 use FuzeWorks\Event\RouterLoadCallableEvent;
 use FuzeWorks\Event\RouterLoadViewAndControllerEvent;
 use FuzeWorks\Exception\ConfigException;
@@ -339,6 +340,28 @@ class Router
             return false;
         }
 
+        // Fire routerCallViewEvent
+        try {
+            /** @var RouterCallViewEvent $event */
+            $event = Events::fireEvent('routerCallViewEvent',
+                $this->view,
+                $this->controller,
+                $event->viewMethod,
+                $event->viewParameters,
+                $event->route
+            );
+
+            // Reset vars
+            $this->view = $event->view;
+            $this->controller = $event->controller;
+        } catch (EventException $e) {
+            throw new RouterException("Could not load view. routerCallViewEvent threw exception: '".$e->getMessage()."'");
+        }
+
+        // Cancel if requested to do so
+        if ($event->isCancelled())
+            throw new HaltException("Will not load view. Cancelled by routerCallViewEvent");
+
         // If the view does not want a function to be loaded, provide a halt parameter
         if (isset($this->view->halt))
             throw new HaltException("Will not load view. Cancelled by 'halt' attribute in view.");
@@ -347,7 +370,10 @@ class Router
         if (method_exists($this->view, $event->viewMethod) || method_exists($this->view, '__call'))
         {
             // Execute the function on the view
-            return $this->view->{$event->viewMethod}($event->viewParameters);
+            Logger::newLevel("Calling method '{$event->viewMethod}' on " . get_class($this->view) . ' with ' . get_class($this->controller));
+            $output = $this->view->{$event->viewMethod}($event->viewParameters);
+            Logger::stopLevel();
+            return $output;
         }
         else
         {