comodojo / dispatcher.framework

src/Comodojo/Dispatcher/Dispatcher.php

Doc Comments +3 added lines

@@ -207,6 +207,9 @@
 
     }
 
+    /**
+     * @param string $name
+     */
     private function createServiceSpecializedEvents($name) {
 
         $this->logger->debug("Emitting $name service-event");

Spacing +17 added lines, -17 removed lines

@@ -78,7 +78,7 @@ 
 
         // init core components
         // create new configuration object and merge configuration
-        $configuration_object = new Configuration( DefaultConfiguration::get() );
+        $configuration_object = new Configuration(DefaultConfiguration::get());
         $configuration_object->merge($configuration);
 
         $logger = is_null($logger) ? LogManager::createFromConfiguration($configuration_object)->getLogger() : $logger;
@@ -102,7 +102,7 @@ 
 
         } catch (Exception $e) {
 
-            $this->logger->critical($e->getMessage(),$e->getTrace());
+            $this->logger->critical($e->getMessage(), $e->getTrace());
 
             throw $e;
 
@@ -122,9 +122,9 @@ 
         $logger->debug("Starting to dispatch.");
 
         $logger->debug("Emitting global dispatcher event.");
-        $events->emit( new DispatcherEvent($this) );
+        $events->emit(new DispatcherEvent($this));
 
-        if ( $configuration->get('enabled') === false ) {
+        if ($configuration->get('enabled') === false) {
 
             $logger->debug("Dispatcher disabled, shutting down gracefully.");
 
@@ -140,11 +140,11 @@ 
 
         $cache = new ServerCache($this->getCache());
 
-        $events->emit( $this->createServiceSpecializedEvents('dispatcher.request') );
-        $events->emit( $this->createServiceSpecializedEvents('dispatcher.request.'.$this->request->method->get()) );
-        $events->emit( $this->createServiceSpecializedEvents('dispatcher.request.#') );
+        $events->emit($this->createServiceSpecializedEvents('dispatcher.request'));
+        $events->emit($this->createServiceSpecializedEvents('dispatcher.request.'.$this->request->method->get()));
+        $events->emit($this->createServiceSpecializedEvents('dispatcher.request.#'));
 
-        if ( $cache->read($this->request, $this->response) ) {
+        if ($cache->read($this->request, $this->response)) {
             // we have a cache!
             // shutdown immediately
             return $this->shutdown();
@@ -170,10 +170,10 @@ 
 
         $logger->debug("Route acquired, type $route_type directed to $route_service");
 
-        $events->emit( $this->createServiceSpecializedEvents('dispatcher.route') );
-        $events->emit( $this->createServiceSpecializedEvents('dispatcher.route.'.$route_type) );
-        $events->emit( $this->createServiceSpecializedEvents('dispatcher.route.'.$route_service) );
-        $events->emit( $this->createServiceSpecializedEvents('dispatcher.route.#') );
+        $events->emit($this->createServiceSpecializedEvents('dispatcher.route'));
+        $events->emit($this->createServiceSpecializedEvents('dispatcher.route.'.$route_type));
+        $events->emit($this->createServiceSpecializedEvents('dispatcher.route.'.$route_service));
+        $events->emit($this->createServiceSpecializedEvents('dispatcher.route.#'));
 
         // translate route to service
         $logger->debug("Running $route_service service");
@@ -201,8 +201,8 @@ 
 
         $params = $route->getParameter('headers');
 
-        if ( !empty($params) && is_array($params) ) {
-            foreach($params as $name => $value) $this->getResponse()->getHeaders()->set($name, $value);
+        if (!empty($params) && is_array($params)) {
+            foreach ($params as $name => $value) $this->getResponse()->getHeaders()->set($name, $value);
         }
 
     }
@@ -247,9 +247,9 @@ 
 
         $response->consolidate($request, $this->route);
 
-        $events->emit( $this->createServiceSpecializedEvents('dispatcher.response') );
-        $events->emit( $this->createServiceSpecializedEvents('dispatcher.response.' . $response->getStatus()->get()) );
-        $events->emit( $this->createServiceSpecializedEvents('dispatcher.response.#') );
+        $events->emit($this->createServiceSpecializedEvents('dispatcher.response'));
+        $events->emit($this->createServiceSpecializedEvents('dispatcher.response.'.$response->getStatus()->get()));
+        $events->emit($this->createServiceSpecializedEvents('dispatcher.response.#'));
 
         $this->logger->debug("Composing return value");
 

Braces +3 added lines, -1 removed lines

@@ -202,7 +202,9 @@
         $params = $route->getParameter('headers');
 
         if ( !empty($params) && is_array($params) ) {
-            foreach($params as $name => $value) $this->getResponse()->getHeaders()->set($name, $value);
+            foreach($params as $name => $value) {
+                $this->getResponse()->getHeaders()->set($name, $value);
+            }
         }
 
     }

src/Comodojo/Dispatcher/Response/Model.php

Doc Comments +3 added lines

@@ -95,6 +95,9 @@
 
     }
 
+    /**
+     * @return string
+     */
     public function getContent() {
 
         return $this->content;

Spacing +15 added lines, -15 removed lines

@@ -35,7 +35,7 @@ 
 
     use TimingTrait;
 
-    const NO_CONTENT_STATUSES = [100,101,102,204,304];
+    const NO_CONTENT_STATUSES = [100, 101, 102, 204, 304];
 
     const CACHEABLE_METHODS = ['GET', 'HEAD', 'POST', 'PUT'];
 
@@ -137,7 +137,7 @@ 
 
     public function export() {
 
-        return (object) [
+        return (object)[
             'headers' => $this->getHeaders(),
             'cookies' => $this->getCookies()->getAll(),
             'status' => $this->getStatus(),
@@ -149,12 +149,12 @@ 
 
     public function import($data) {
 
-        if ( isset($data->headers) ) $this->setHeaders($data->headers);
-        if ( isset($data->status) ) $this->setStatus($data->status);
-        if ( isset($data->content) ) $this->setContent($data->content);
-        if ( isset($data->location) ) $this->setLocation($data->location);
+        if (isset($data->headers)) $this->setHeaders($data->headers);
+        if (isset($data->status)) $this->setStatus($data->status);
+        if (isset($data->content)) $this->setContent($data->content);
+        if (isset($data->location)) $this->setLocation($data->location);
 
-        if ( isset($data->cookies) && is_array($data->cookies) ) {
+        if (isset($data->cookies) && is_array($data->cookies)) {
             $cookies = $this->getCookies();
             foreach ($data->cookies as $name => $cookie) $cookies->add($cookie);
         }
@@ -168,7 +168,7 @@ 
         $output_class_name = "\\Comodojo\\Dispatcher\\Response\\Preprocessor\\Status".$status;
 
         // @TODO: this condition will be removed when all preprocessors ready
-        if ( class_exists($output_class_name) ) {
+        if (class_exists($output_class_name)) {
             $output = new $output_class_name($this);
         } else {
             $output = new \Comodojo\Dispatcher\Response\Preprocessor\Status200($this);
@@ -176,7 +176,7 @@ 
 
         $output->consolidate();
 
-        if ( $route != null ) {
+        if ($route != null) {
             $this->setClientCache($request, $route);
         }
 
@@ -184,7 +184,7 @@ 
         $content = $this->getContent();
         $headers = $this->getHeaders();
 
-        if ( (string) $request->getMethod() == 'HEAD' && !in_array($status, self::NO_CONTENT_STATUSES) ) {
+        if ((string)$request->getMethod() == 'HEAD' && !in_array($status, self::NO_CONTENT_STATUSES)) {
             $length = $content->length();
             $content->set(null);
             if ($length) $headers->set('Content-Length', $length);
@@ -194,7 +194,7 @@ 
             $headers->delete('Content-Length');
         }
 
-        if ( (string) $request->getVersion() == '1.0' && false !== strpos($headers->get('Cache-Control'), 'no-cache')) {
+        if ((string)$request->getVersion() == '1.0' && false !== strpos($headers->get('Cache-Control'), 'no-cache')) {
             $headers->set('pragma', 'no-cache');
             $headers->set('expires', -1);
         }
@@ -204,20 +204,20 @@ 
     private function setClientCache(Request $request, Route $route) {
 
         $cache = strtoupper($route->getParameter('cache'));
-        $ttl = (int) $route->getParameter('ttl');
+        $ttl = (int)$route->getParameter('ttl');
 
         if (
             ($cache == 'CLIENT' || $cache == 'BOTH') &&
-            in_array((string) $request->getMethod(), self::CACHEABLE_METHODS) &&
+            in_array((string)$request->getMethod(), self::CACHEABLE_METHODS) &&
             in_array($this->getStatus()->get(), self::CACHEABLE_STATUSES)
             // @TODO: here we should also check for Cache-Control no-store or private;
             //        the cache layer will be improoved in future versions.
         ) {
 
             $headers = $this->getHeaders();
-            $timestamp = (int) $this->getTime()->format('U') + $ttl;
+            $timestamp = (int)$this->getTime()->format('U')+$ttl;
 
-            if ( $ttl > 0 ) {
+            if ($ttl > 0) {
 
                 $headers->set("Cache-Control", "max-age=".$ttl.", must-revalidate");
                 $headers->set("Expires", gmdate("D, d M Y H:i:s", $timestamp)." GMT");

Braces +18 added lines, -6 removed lines

@@ -149,14 +149,24 @@ 
 
     public function import($data) {
 
-        if ( isset($data->headers) ) $this->setHeaders($data->headers);
-        if ( isset($data->status) ) $this->setStatus($data->status);
-        if ( isset($data->content) ) $this->setContent($data->content);
-        if ( isset($data->location) ) $this->setLocation($data->location);
+        if ( isset($data->headers) ) {
+            $this->setHeaders($data->headers);
+        }
+        if ( isset($data->status) ) {
+            $this->setStatus($data->status);
+        }
+        if ( isset($data->content) ) {
+            $this->setContent($data->content);
+        }
+        if ( isset($data->location) ) {
+            $this->setLocation($data->location);
+        }
 
         if ( isset($data->cookies) && is_array($data->cookies) ) {
             $cookies = $this->getCookies();
-            foreach ($data->cookies as $name => $cookie) $cookies->add($cookie);
+            foreach ($data->cookies as $name => $cookie) {
+                $cookies->add($cookie);
+            }
         }
 
     }
@@ -187,7 +197,9 @@ 
         if ( (string) $request->getMethod() == 'HEAD' && !in_array($status, self::NO_CONTENT_STATUSES) ) {
             $length = $content->length();
             $content->set(null);
-            if ($length) $headers->set('Content-Length', $length);
+            if ($length) {
+                $headers->set('Content-Length', $length);
+            }
         }
 
         if ($headers->get('Transfer-Encoding') != null) {

src/Comodojo/Dispatcher/Traits/HeadersTrait.php

Spacing +9 added lines, -9 removed lines

@@ -28,9 +28,9 @@ 
 
     public function get($header = null) {
 
-        if ( is_null($header) ) return $this->headers;
+        if (is_null($header)) return $this->headers;
 
-        else if ( array_key_exists($header, $this->headers) ) return $this->headers[$header];
+        else if (array_key_exists($header, $this->headers)) return $this->headers[$header];
 
         else return null;
 
@@ -38,14 +38,14 @@ 
 
     public function getAsString($header = null) {
 
-        if ( is_null($header) ) {
+        if (is_null($header)) {
 
-            return array_map( [$this, 'headerToString'],
+            return array_map([$this, 'headerToString'],
                 array_keys($this->headers),
                 array_values($this->headers)
             );
 
-        } else if ( array_key_exists($header, $this->headers) ) {
+        } else if (array_key_exists($header, $this->headers)) {
 
             return self::headerToString($header, $this->headers[$header]);
 
@@ -53,9 +53,9 @@ 
 
     }
 
-    public function set($header, $value=null) {
+    public function set($header, $value = null) {
 
-        if ( is_null($value) ) {
+        if (is_null($value)) {
 
             $header = explode(":", $header, 2);
 
@@ -73,13 +73,13 @@ 
 
     public function delete($header = null) {
 
-        if ( is_null($header) ) {
+        if (is_null($header)) {
 
             $this->headers = array();
 
             return true;
 
-        } else if ( array_key_exists($header, $this->headers) ) {
+        } else if (array_key_exists($header, $this->headers)) {
 
             unset($this->headers[$header]);
 

src/Comodojo/Dispatcher/Service/AbstractService.php

Spacing +7 added lines, -7 removed lines

@@ -48,7 +48,7 @@ 
     use ResponseTrait;
     use ExtraTrait;
 
-    const SUPPORTED_METHODS = ['GET','PUT','POST','DELETE','OPTIONS','HEAD','TRACE','CONNECT','PURGE'];
+    const SUPPORTED_METHODS = ['GET', 'PUT', 'POST', 'DELETE', 'OPTIONS', 'HEAD', 'TRACE', 'CONNECT', 'PURGE'];
 
     public function __construct(
         Configuration $configuration,
@@ -81,9 +81,9 @@ 
 
         $supported_methods = $this->getConfiguration()->get('supported-http-methods');
 
-        if ( is_null($supported_methods) ) $supported_methods = self::SUPPORTED_METHODS;
+        if (is_null($supported_methods)) $supported_methods = self::SUPPORTED_METHODS;
 
-        if ( method_exists($this, 'any') ) {
+        if (method_exists($this, 'any')) {
 
             return $supported_methods;
 
@@ -91,9 +91,9 @@ 
 
         $implemented_methods = [];
 
-        foreach ( $supported_methods as $method ) {
+        foreach ($supported_methods as $method) {
 
-            if ( method_exists($this, strtolower($method)) ) array_push($implemented_methods, $method);
+            if (method_exists($this, strtolower($method))) array_push($implemented_methods, $method);
 
         }
 
@@ -109,11 +109,11 @@ 
 
         $method = strtolower($method);
 
-        if ( method_exists($this, $method) ) {
+        if (method_exists($this, $method)) {
 
             return $method;
 
-        } else if ( method_exists($this, 'any') ) {
+        } else if (method_exists($this, 'any')) {
 
             return 'any';
 

Braces +6 added lines, -2 removed lines

@@ -81,7 +81,9 @@ 
 
         $supported_methods = $this->getConfiguration()->get('supported-http-methods');
 
-        if ( is_null($supported_methods) ) $supported_methods = self::SUPPORTED_METHODS;
+        if ( is_null($supported_methods) ) {
+            $supported_methods = self::SUPPORTED_METHODS;
+        }
 
         if ( method_exists($this, 'any') ) {
 
@@ -93,7 +95,9 @@ 
 
         foreach ( $supported_methods as $method ) {
 
-            if ( method_exists($this, strtolower($method)) ) array_push($implemented_methods, $method);
+            if ( method_exists($this, strtolower($method)) ) {
+                array_push($implemented_methods, $method);
+            }
 
         }
 

src/Comodojo/Dispatcher/Router/Route.php

Spacing +4 added lines, -4 removed lines

@@ -201,13 +201,13 @@ 
         // Because of the nature of the global regular expression, all the bits of the matched route are associated with a parameter key
         foreach ($this->query as $key => $value) {
 
-            if ( isset($path[$key]) ) {
+            if (isset($path[$key])) {
                 /* if it's available a bit associated with the parameter name, it is compared against
                  * it's regular expression in order to extrect backreferences
                  */
-                if ( preg_match('/^' . $value['regex'] . '$/', $path[$key], $matches) ) {
+                if (preg_match('/^'.$value['regex'].'$/', $path[$key], $matches)) {
 
-                    if ( count($matches) == 1 ) $matches = $matches[0]; // This is the case where no backreferences are present or available.
+                    if (count($matches) == 1) $matches = $matches[0]; // This is the case where no backreferences are present or available.
 
                     // The extracted value (with any backreference available) is added to the query parameters.
                     $this->setRequestParameter($key, $matches);
@@ -233,7 +233,7 @@ 
      */
     public function serialize() {
 
-        return serialize( (object) [
+        return serialize((object)[
             'classname' => $this->classname,
             'type' => $this->type,
             'service' => $this->service,

Braces +4 added lines, -1 removed lines

@@ -207,7 +207,10 @@
                  */
                 if ( preg_match('/^' . $value['regex'] . '$/', $path[$key], $matches) ) {
 
-                    if ( count($matches) == 1 ) $matches = $matches[0]; // This is the case where no backreferences are present or available.
+                    if ( count($matches) == 1 ) {
+                        $matches = $matches[0];
+                    }
+                    // This is the case where no backreferences are present or available.
 
                     // The extracted value (with any backreference available) is added to the query parameters.
                     $this->setRequestParameter($key, $matches);

src/Comodojo/Dispatcher/Router/Table.php

Spacing +7 added lines, -7 removed lines

@@ -136,9 +136,9 @@ 
 
     public function load($routes) {
 
-        if ( !empty($routes) ) {
+        if (!empty($routes)) {
 
-            foreach( $routes as $name => $route ) {
+            foreach ($routes as $name => $route) {
 
                 $this->add($route['route'], $route['type'], $route['class'], $route['parameters']);
                 // $this->add($name, $route['type'], $route['class'], $route['parameters']);
@@ -156,11 +156,11 @@ 
 
     private function readCache() {
 
-        if ( $this->configuration->get('routing-table-cache') !== true ) return;
+        if ($this->configuration->get('routing-table-cache') !== true) return;
 
         $data = $this->cache->read();
 
-        if ( is_null($data) ) {
+        if (is_null($data)) {
 
             $this->routes = [];
 
@@ -176,11 +176,11 @@ 
 
     private function dumpCache() {
 
-        if ( $this->configuration->get('routing-table-cache') !== true ) return;
+        if ($this->configuration->get('routing-table-cache') !== true) return;
 
         $ttl = $this->configuration->get('routing-table-ttl');
 
-        if ( $this->cache->dump($this->routes, $ttl) ) {
+        if ($this->cache->dump($this->routes, $ttl)) {
             $this->logger->debug("Routing table saved to cache");
         } else {
             $this->logger->warning("Cannot save routing table to cache");
@@ -198,7 +198,7 @@ 
             ->setClassName($class) // Class to be invoked
             ->setParameters($parameters); // Parameters passed via the composer.json configuration (cache, ttl, etc...)
 
-        $this->logger->debug("Route table - route: " . implode("/", $folders));
+        $this->logger->debug("Route table - route: ".implode("/", $folders));
 
         // This method generate a global regular expression which will be able to match all the URI supported by the route
         $regex = $this->parser->read($folders, $route);

Braces +6 added lines, -2 removed lines

@@ -156,7 +156,9 @@ 
 
     private function readCache() {
 
-        if ( $this->configuration->get('routing-table-cache') !== true ) return;
+        if ( $this->configuration->get('routing-table-cache') !== true ) {
+            return;
+        }
 
         $data = $this->cache->read();
 
@@ -176,7 +178,9 @@ 
 
     private function dumpCache() {
 
-        if ( $this->configuration->get('routing-table-cache') !== true ) return;
+        if ( $this->configuration->get('routing-table-cache') !== true ) {
+            return;
+        }
 
         $ttl = $this->configuration->get('routing-table-ttl');
 

src/Comodojo/Dispatcher/Router/Parser.php

Spacing +2 added lines, -2 removed lines

@@ -105,7 +105,7 @@ 
                 return $this->read(
                     $folders,
                     $value,
-                    $regex.'(?:\/'.$param_regex.')'. (($param_required)?'{1}':'?')
+                    $regex.'(?:\/'.$param_regex.')'.(($param_required) ? '{1}' : '?')
                 );
 
             } else {
@@ -161,7 +161,7 @@ 
          * If the field is required, the regular expression is completed with a '{1}' (which make it compulsory),
          * otherwise a '?' is added.
          */
-        return '(?P<' . $key . '>' . $string . ')' . (($field_required)?'{1}':'?');
+        return '(?P<'.$key.'>'.$string.')'.(($field_required) ? '{1}' : '?');
 
     }
 

Braces +3 added lines, -1 removed lines

@@ -96,7 +96,9 @@
                      */
                     $param_regex .= $this->param($key, $string, $value);
 
-                    if ($value->isQueryRequired($key)) $param_required = true;
+                    if ($value->isQueryRequired($key)) {
+                        $param_required = true;
+                    }
 
                     $this->logger->debug("Route parser - parameter regex: $param_regex");
 

src/Comodojo/Dispatcher/Router/Model.php

Spacing +12 added lines, -12 removed lines

@@ -106,23 +106,23 @@ 
 
     public function route(Request $request) {
 
-        $method = (string) $request->getMethod();
+        $method = (string)$request->getMethod();
 
         $methods = $this->configuration->get('allowed-http-methods');
 
-        if ( !empty($methods) && in_array($method, $methods) === false ) {
+        if (!empty($methods) && in_array($method, $methods) === false) {
 
             throw new DispatcherException("Method not allowed", 0, null, 405, array(
-                "Allow" => implode(",",$methods)
+                "Allow" => implode(",", $methods)
             ));
 
         }
 
         $this->setRequest($request);
 
-        if ( $this->bypass_routing === false ) {
+        if ($this->bypass_routing === false) {
 
-            if ( !$this->parse() ) throw new DispatcherException("Unable to find a valid route for the specified uri", 0, null, 404);
+            if (!$this->parse()) throw new DispatcherException("Unable to find a valid route for the specified uri", 0, null, 404);
 
         }
 
@@ -134,7 +134,7 @@ 
 
         $class = $this->route->getClassName();
 
-        if ( class_exists($class) ) {
+        if (class_exists($class)) {
 
             // All the route parameters are also added to the query parameters
             foreach ($this->route->getRequestParameters() as $parameter => $value) {
@@ -162,13 +162,13 @@ 
 
         $this->setResponse($response);
 
-        if ( is_null($this->route) ) {
+        if (is_null($this->route)) {
 
             throw new DispatcherException("Route has not been loaded!");
 
         }
 
-        if ( $this->bypass_service ) {
+        if ($this->bypass_service) {
 
             return;
 
@@ -176,15 +176,15 @@ 
 
         $service = $this->getServiceInstance();
 
-        if ( !is_null($service) ) {
+        if (!is_null($service)) {
 
             $result = "";
 
-            $method = (string) $this->getRequest()->getMethod();
+            $method = (string)$this->getRequest()->getMethod();
 
             $methods = $service->getImplementedMethods();
 
-            if ( in_array($method, $methods) ) {
+            if (in_array($method, $methods)) {
 
                 $callable = $service->getMethod($method);
 
@@ -227,7 +227,7 @@ 
         foreach ($this->table->getRoutes() as $regex => $value) {
 
             // The current uri is checked against all the global regular expressions associated with the routes
-            if ( preg_match("/" . $regex . "/", $path, $matches) ) {
+            if (preg_match("/".$regex."/", $path, $matches)) {
 
                 /* If a route is matched, all the bits of the route string are evalued in order to create
                  * new query parameters which will be available for the service class

Braces +3 added lines, -1 removed lines

@@ -122,7 +122,9 @@
 
         if ( $this->bypass_routing === false ) {
 
-            if ( !$this->parse() ) throw new DispatcherException("Unable to find a valid route for the specified uri", 0, null, 404);
+            if ( !$this->parse() ) {
+                throw new DispatcherException("Unable to find a valid route for the specified uri", 0, null, 404);
+            }
 
         }
 

src/Comodojo/Dispatcher/Cache/ServerCache.php

Spacing +5 added lines, -5 removed lines

@@ -47,7 +47,7 @@ 
 
         $cache_object = $this->getCache()->setNamespace(self::CACHE_NAMESPACE)->get($name);
 
-        if ( is_null($cache_object) ) return false;
+        if (is_null($cache_object)) return false;
 
         $response->import($cache_object);
 
@@ -67,15 +67,15 @@ 
 
         $name = self::getCacheName($request);
 
-        $method = (string) $request->getMethod();
+        $method = (string)$request->getMethod();
 
         $status = $response->getStatus()->get();
 
         if (
-            ( $cache == 'SERVER' || $cache == 'BOTH' ) &&
+            ($cache == 'SERVER' || $cache == 'BOTH') &&
             in_array($method, self::CACHABLE_METHODS) &&
             in_array($status, self::CACHABLE_STATUSES)
-        ){
+        ) {
 
             $this->getCache()
                 ->setNamespace(self::CACHE_NAMESPACE)
@@ -87,7 +87,7 @@ 
 
     private static function getCacheName(Request $request) {
 
-        return md5( (string) $request->getMethod() . (string) $request->getUri() );
+        return md5((string)$request->getMethod().(string)$request->getUri());
 
     }
 

Braces +3 added lines, -1 removed lines

@@ -47,7 +47,9 @@
 
         $cache_object = $this->getCache()->setNamespace(self::CACHE_NAMESPACE)->get($name);
 
-        if ( is_null($cache_object) ) return false;
+        if ( is_null($cache_object) ) {
+            return false;
+        }
 
         $response->import($cache_object);