Comodojo\Dispatcher\Dispatcher

Complexity

Total Complexity

27

Size/Duplication

Total Lines	284
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	16

Importance

Changes	25
Bugs	7	Features	4

13 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	32	4
A	configuration()	0	11	2
A	events()	0	11	2
A	cache()	0	11	2
A	request()	0	11	2
A	router()	0	11	2
A	response()	0	11	2
A	extra()	0	11	2
A	logger()	0	13	2
B	dispatch()	0	79	4
A	emitServiceSpecializedEvents()	0	14	1
A	processDispatcherException()	0	16	1
A	shutdown()	0	19	1

<?php namespace Comodojo\Dispatcher;

use \Monolog\Logger;
use \Comodojo\Dispatcher\Components\Configuration;
use \Comodojo\Dispatcher\Components\DefaultConfiguration;
use \Comodojo\Dispatcher\Request\Model as Request;
use \Comodojo\Dispatcher\Router\Collector as RouteCollector;
use \Comodojo\Dispatcher\Response\Model as Response;
use \Comodojo\Dispatcher\Extra\Model as Extra;
use \Comodojo\Dispatcher\Components\Timestamp as TimestampTrait;
use \Comodojo\Dispatcher\Output\Processor;
use \Comodojo\Dispatcher\Events\DispatcherEvent;
use \Comodojo\Dispatcher\Events\ServiceEvent;
use \Comodojo\Dispatcher\Router\RoutingTableInterface;
use \Comodojo\Dispatcher\Log\DispatcherLogger;
use \Comodojo\Dispatcher\Cache\DispatcherCache;
use \Comodojo\Dispatcher\Events\EventsManager;
use \Comodojo\Cache\CacheManager;
use \League\Event\Emitter;
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 Dispatcher {

    use TimestampTrait;

    private $configuration;

    private $request;

    private $router;

    private $response;

    private $extra;

    private $logger;

    private $cache;

    private $events;

    public function __construct(
        $configuration = array(),
        Emitter $emitter = null,
        CacheManager $cache = null,
        Logger $logger = null
    ) {

        ob_start();

        $this->setTimestamp();

        $this->configuration()->merge($configuration);

        if (!is_null($emitter)) {
            
            $this->events = $emitter;
            
        }

        if (!is_null($logger)) {
            
            $this->logger = $logger;
            
        }

        if (!is_null($cache)) {
            
            $this->cache = $cache;
            
        }
        
    }

    public function configuration() {
        
        if (empty($this->configuration)) {
            
            $this->configuration = new Configuration( DefaultConfiguration::get() );
            
        }

        return $this->configuration;

    }

    public function events() {
        
        if (empty($this->events)) {
            
            $this->events = new EventsManager();
            
        }

        return $this->events;

    }

    public function cache() {
        
        if (empty($this->cache)) {
            
            $this->cache = DispatcherCache::create($this->configuration(), $this->logger());
            
        }
        
        return $this->cache;

    }

    public function request() {
        
        if (empty($this->request)) {
            
            $this->request = new Request($this->configuration(), $this->logger());
            
        }

        return $this->request;

    }

    public function router() {
        
        if (empty($this->router)) {
            
            $this->router = new RouteCollector($this->configuration(), $this->logger(), $this->cache(), $this->extra());
            
        }

        return $this->router;

    }

    public function response() {
        
        if (empty($this->response)) {
            
            $this->response = new Response($this->configuration(), $this->logger());
            
        }

        return $this->response;

    }

    public function extra() {
        
        if (empty($this->extra)) {
            
            $this->extra = new Extra($this->logger());

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

            
        }

        return $this->extra;

    }

    public function logger() {
        
        if (empty($this->logger)) {
            
            $this->logger = DispatcherLogger::create($this->configuration());
            
            $this->logger()->debug("Dispatcher ready, current date ".date('c', $this->getTimestamp()));
            
        }

        return $this->logger;

    }

    public function dispatch() {

        $this->logger()->debug("Starting to dispatch.");

        $this->logger()->debug("Emitting global dispatcher event.");

        $this->events()->emit( new DispatcherEvent($this) );

        if ( $this->configuration()->get('enabled') === false ) {

            $this->logger()->debug("Dispatcher disabled, shutting down gracefully.");

            $status = $this->configuration()->get('disabled-status');

            $content = $this->configuration()->get('disabled-message');

            $this->response()->status()->set($status);

            $this->response()->content()->set($content);

            return $this->shutdown();

        }

        $this->events()->emit( $this->emitServiceSpecializedEvents('dispatcher.request') );

        $this->events()->emit( $this->emitServiceSpecializedEvents('dispatcher.request.'.$this->request()->method()->get()) );

        $this->events()->emit( $this->emitServiceSpecializedEvents('dispatcher.request.#') );

        $this->logger()->debug("Starting router.");

        try {

            $this->router()->route($this->request());

        } catch (DispatcherException $de) {

            $this->logger()->debug("Route error (".$de->getStatus()."), shutting down dispatcher.");

            $this->processDispatcherException($de);

            return $this->shutdown();

        }

        $route_type = $this->router()->getType();

        $route_service = $this->router()->getService();

        $this->logger()->debug("Route acquired, type $route_type directed to $route_service.");

        $this->events()->emit( $this->emitServiceSpecializedEvents('dispatcher.route') );

        $this->events()->emit( $this->emitServiceSpecializedEvents('dispatcher.route.'.$route_type) );

        $this->events()->emit( $this->emitServiceSpecializedEvents('dispatcher.route.'.$route_service) );

        $this->events()->emit( $this->emitServiceSpecializedEvents('dispatcher.route.#') );

        // translate route to service

        $this->logger()->debug("Running $route_service service.");

        try {

            $this->router()->compose($this->response());

        } catch (DispatcherException $de) {

            $this->logger()->debug("Service exception (".$de->getStatus()."), shutting down dispatcher.");

            $this->processDispatcherException($de);

        }

        return $this->shutdown();

    }

    private function emitServiceSpecializedEvents($name) {

        $this->logger()->debug("Emitting $name service-event.");

        return new ServiceEvent(
            $name,
            $this->logger(),
            $this->request(),
            $this->router(),
            $this->response(),
            $this->extra()
        );

    }

    private function processDispatcherException(DispatcherException $de) {

        $status = $de->getStatus();

        $message = $de->getMessage();

        //$headers = $de->getHeaders();

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

        $headers = array();

        $this->response()->status()->set($status);

        $this->response()->content()->set($message);

        $this->response()->headers()->merge($headers);

    }

    private function shutdown() {

        $this->events()->emit( $this->emitServiceSpecializedEvents('dispatcher.response') );

        $this->events()->emit( $this->emitServiceSpecializedEvents('dispatcher.response.'.$this->response()->status()->get()) );

        $this->events()->emit( $this->emitServiceSpecializedEvents('dispatcher.response.#') );

        $this->logger()->debug("Composing return value.");

        $return = Processor::parse($this->configuration(), $this->logger(), $this->response());

        $this->logger()->debug("Dispatcher run-cycle ends.");

        ob_end_clean();

        return $return;

    }

}