Comodojo\Dispatcher\Router\Table

Complexity

Total Complexity

19

Size/Duplication

Total Lines	166
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

58.1%

Importance

Changes	3
Bugs	1	Features	1

10 Methods

Rating	Name	Duplication	Size	Complexity
A	defaultRoute()	0	5	1
A	regex()	0	7	1
A	__construct()	0	15	1
A	add()	0	21	2
A	get()	0	10	2
A	remove()	0	19	2
A	load()	0	17	3
A	readCache()	0	19	3
A	dumpCache()	0	13	3
B	register()	0	24	1

<?php namespace Comodojo\Dispatcher\Router;

use \Comodojo\Dispatcher\Components\AbstractModel;
use \Comodojo\Dispatcher\Cache\RouterCache;
use \Comodojo\Dispatcher\Router\Parser;
use \Comodojo\Dispatcher\Router\Route;
use \Comodojo\Dispatcher\Router\Model as Router;
use \Comodojo\Foundation\Base\Configuration;
use \Comodojo\Cache\Cache;
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 AbstractModel {

    protected $mode = self::PROTECTDATA;

    public function __construct(
        Cache $cache,
        Router $router
    ) {

        parent::__construct($router->configuration, $router->logger);

The property configuration does not exist on object<Comodojo\Dispatcher\Router\Model>. Since you implemented __get, maybe consider adding a @property annotation.

The property logger does not exist on object<Comodojo\Dispatcher\Router\Model>. Since you implemented __get, maybe consider adding a @property annotation.

        $this->setRaw('routes', []);
        $this->setRaw('router', $router);
        $this->setRaw('parser', new Parser($this->logger));

The property logger does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __get, maybe consider adding a @property annotation.

        $this->setRaw('cache', new RouterCache($cache));

        $this->readCache();

    }

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

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

        if (!is_null($routeData)) {

            $routeData->setType($type)
                ->setClassName($class)
                ->setParameters($parameters);

        } else {

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

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

        }

        return $this;

    }

    public function get($route) {

        $regex = $this->regex($route);

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

The property routes does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __get, maybe consider adding a @property annotation.

            return $this->routes[$regex];

The property routes does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __get, maybe consider adding a @property annotation.

        else
            return null;

    }

    public function regex($route) {

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

        return $this->parser->read($folders);

The property parser does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    public function remove($route) {

        $regex = $this->regex($route);

        $routes = $this->routes;

The property routes does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __set, maybe consider adding a @property annotation.

        if (isset($routes[$regex])) {

            unset($routes[$regex]);

            $this->routes = $routes;

The property routes does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __set, maybe consider adding a @property annotation.

            return true;

        }

        return false;

    }

    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");

The property logger does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __get, maybe consider adding a @property annotation.

        $this->dumpCache();

    }

    private function readCache() {

        if ( $this->configuration->get('routing-table-cache') !== true ) return;

The property configuration does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __get, maybe consider adding a @property annotation.

        $data = $this->cache->read();

The property cache does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __get, maybe consider adding a @property annotation.

        if ( is_null($data) ) {

            $this->routes = [];

The property routes does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __set, maybe consider adding a @property annotation.

            return;

        }

        $this->routes = $data;

The property routes does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __set, maybe consider adding a @property annotation.

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

The property logger does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    private function dumpCache() {

        if ( $this->configuration->get('routing-table-cache') !== true ) return;

The property configuration does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __get, maybe consider adding a @property annotation.

        $ttl = $this->configuration->get('routing-table-ttl');

The property configuration does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __get, maybe consider adding a @property annotation.

        if ( $this->cache->dump($this->routes, $ttl) ) {

The property cache does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __get, maybe consider adding a @property annotation.

The property routes does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __get, maybe consider adding a @property annotation.

            $this->logger->debug("Routing table saved to cache");

The property logger does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __get, maybe consider adding a @property annotation.

        } else {
            $this->logger->warning("Cannot save routing table to cache");

The property logger does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __get, maybe consider adding a @property annotation.

        }

    }

    // 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:
        $route = new Route($this->router);

The property router does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __get, maybe consider adding a @property annotation.

The call to Route::__construct() has too many arguments starting with $this->router.

        $route->setType($type) // Type of route
            ->setClassName($class) // Class to be invoked
            ->setParameters($parameters); // Parameters passed via the composer.json configuration (cache, ttl, etc...)

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

The property logger does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __get, maybe consider adding a @property annotation.

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

The property parser does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __get, maybe consider adding a @property annotation.

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

The property logger does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __get, maybe consider adding a @property annotation.

        //$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 = array_merge($this->routes, array(

The property routes does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __set, maybe consider adding a @property annotation.

The property routes does not exist on object<Comodojo\Dispatcher\Router\Table>. Since you implemented __get, maybe consider adding a @property annotation.

            $regex => $route
        ));

    }

}