Comodojo\Dispatcher\Router\Table

Complexity

Total Complexity

21

Size/Duplication

Total Lines	185
Duplicated Lines	25.41 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	1
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	1
A	put()	13	13	2
A	set()	13	13	2
A	add()	0	15	2
A	get()	12	12	2
A	remove()	9	9	2
A	routes()	0	15	2
A	defaultRoute()	0	5	1
A	load()	0	17	3
A	readCache()	0	13	2
A	dumpCache()	0	11	1
B	register()	0	25	1

<?php namespace Comodojo\Dispatcher\Router;

use \Comodojo\Dispatcher\Components\Model as DispatcherClassModel;
use \Comodojo\Dispatcher\Router\Parser;
use \Monolog\Logger;
use \Comodojo\Dispatcher\Components\Configuration;
use \Comodojo\Cache\CacheManager;
use \Comodojo\Exception\DispatcherException;
use \Exception;

/**
 * @package     Comodojo Dispatcher
 * @author      Marco Giovinazzi <marco.giovinazzi@comodojo.org>
 * @author      Marco Castiello <marco.castiello@gmail.com>
 * @license     GPL-3.0+
 *
 * LICENSE:
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

class Table extends DispatcherClassModel {

    private $routes = array();
    
    private $parser;
    
    private $cache;

    public function __construct(
        CacheManager $cache,
        Configuration $configuration,
        Logger $logger
    ) {

        parent::__construct($configuration, $logger);

        $this->parser = new Parser($configuration, $logger);
        
        $this->cache = $cache;
        
        $this->readCache();

    }

    public function put($route, $type, $class, $parameters = array()) {

This method seems to be duplicated in your project.

        $folders = explode("/", $route);

        $regex = $this->parser->read($folders);

        if (!isset($this->routes[$regex])) {

            $this->register($folders, $type, $class, $parameters);

        }

    }

    public function set($route, $type, $class, $parameters = array()) {

This method seems to be duplicated in your project.

        $folders = explode("/", $route);

        $regex = $this->parser->read($folders);

        if (isset($this->routes[$regex])) {

            $this->register($folders, $type, $class, $parameters);

        }

    }

    public function add($route, $type, $class, $parameters = array()) {

        $routeData = $this->get($route);

        if (is_null($routeData)) {

            $this->put($route, $type, $class, $parameters);

        } else {

            $this->set($route, $type, $class, $parameters);

        }

    }

    public function get($route) {

This method seems to be duplicated in your project.

        $folders = explode("/", $route);

        $regex = $this->parser->read($folders);

        if (isset($this->routes[$regex]))
            return $this->routes[$regex];
        else
            return null;

    }

    public function remove($route) {

This method seems to be duplicated in your project.

        $folders = explode("/", $route);

        $regex = $this->parser->read($folders);

        if (isset($this->routes[$regex])) unset($this->routes[$regex]);

    }

    public function routes($routes = null) {

        if (is_null($routes)) {
            
            return $this->routes;
            
        } else {
            
            $this->routes = $routes;
            
            return $this;
            
        }

    }

    public function defaultRoute() {

        return $this->get('/');

    }

    public function load($routes) {

        if ( !empty($routes) ) {

            foreach( $routes as $name => $route ) {

                $this->add($route['route'], $route['type'], $route['class'], $route['parameters']);

            }

        }
        
        $this->logger->debug("Routing table loaded");

        return $this->dumpCache();

    }
    
    private function readCache() {
        
        $routes = $this->cache->get("dispatcher_routes");
        
        if (is_null($routes)) return null;
        
        $this->routes($routes);
        
        $this->logger->debug("Routing table loaded from cache");
        
        return $this;
        
    }
    
    private function dumpCache() {
        
        $routes = $this->routes();
        
        $this->cache->set("dispatcher_routes", $routes, 24 * 60 * 60);
        
        $this->logger->debug("Routing table saved to cache");
        
        return $this;
        
    }

    // This method add a route to the supported list
    private function register($folders, $type, $class, $parameters) {

        // The values associated with a route are as follows:
        $value   = array(
            "type"       => $type,       // Type of route
            "class"      => $class,      // Class to be invoked
            "service"    => array(),     // Service name (it can be a list of namespaces plus a final service name)
            "parameters" => $parameters, // Parameters passed via the composer.json configuration (cache, ttl, etc...)
            "query"      => array()      // List of parameters with their regular expression that must be added among the query parameters
        );

        $this->logger->debug("ROUTE: " . implode("/", $folders));

        //$this->logger->debug("PARAMETERS: " . var_export($value, true));

64% of this comment could be valid code. Did you maybe forget this after debugging?

        // 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, $value);

        $this->logger->debug("ROUTE: " . $regex);

        //$this->logger->debug("PARAMETERS: " . var_export($value, true));

64% of this comment could be valid code. Did you maybe forget this after debugging?

        $this->routes[$regex] = $value;

    }

}