Comodojo\Dispatcher\Dispatcher

Complexity

Total Complexity

24

Size/Duplication

Total Lines	255
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	16

Test Coverage

Coverage

58.88%

Importance

Changes	35
Bugs	8	Features	4

8 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	38	4
B	dumpCache()	0	26	5
A	processConfigurationParameters()	0	10	4
B	dispatch()	0	91	5
A	readCache()	0	13	2
A	emitServiceSpecializedEvents()	0	14	1
A	processDispatcherException()	0	15	1
A	shutdown()	0	22	2

<?php namespace Comodojo\Dispatcher;

use \Psr\Log\LoggerInterface;
use \Comodojo\Dispatcher\Components\DataAccess as DataAccessTrait;
use \Comodojo\Dispatcher\Components\Configuration;
use \Comodojo\Dispatcher\Components\DefaultConfiguration;
use \Comodojo\Dispatcher\Components\EventsManager;
use \Comodojo\Dispatcher\Components\Timestamp as TimestampTrait;
use \Comodojo\Dispatcher\Components\CacheManager as DispatcherCache;
use \Comodojo\Dispatcher\Components\LogManager;
use \Comodojo\Dispatcher\Request\Model as Request;
use \Comodojo\Dispatcher\Router\Model as Router;
use \Comodojo\Dispatcher\Response\Model as Response;
use \Comodojo\Dispatcher\Extra\Model as Extra;
use \Comodojo\Dispatcher\Output\Processor;
use \Comodojo\Dispatcher\Events\DispatcherEvent;
use \Comodojo\Dispatcher\Events\ServiceEvent;
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 Dispatcher {

    use DataAccessTrait;
    use TimestampTrait;

    /**
     * The main dispatcher constructor.
     *
     * @property Configuration $configuration
     * @property LoggerInterface $logger
     * @property EventsManager $events
     * @property Cache $cache
     * @property Extra $extra
     * @property Request $request
     * @property Router $router
     * @property Response $response
     */
    public function __construct(
        $configuration = array(),
        EventsManager $events = null,
        Cache $cache = null,
        LoggerInterface $logger = null
    ) {

        // starting output buffer
        ob_start();

        // fix current timestamp
        $this->setTimestamp();

        // parsing configuration
        $this->configuration = new Configuration( DefaultConfiguration::get() );

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

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

        // init core components
        $this->logger = is_null($logger) ? LogManager::create($this->configuration) : $logger;

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

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

        $this->events = is_null($events) ? new EventsManager($this->logger) : $events;

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

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

        $this->cache = is_null($cache) ? DispatcherCache::create($this->configuration, $this->logger) : $cache;

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

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

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

        // init models
        $this->extra = new Extra($this->logger);

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

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

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

        $this->request = new Request($this->configuration, $this->logger);

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

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

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

        $this->router = new Router($this->configuration, $this->logger, $this->cache, $this->extra);

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

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

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

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

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

        $this->response = new Response($this->configuration, $this->logger);

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

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

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

        // we're ready!
        $this->logger->debug("Dispatcher ready, current date ".date('c', $this->getTimestamp()));

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

    }

    public function dispatch() {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

            return $this->shutdown();

        }

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

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

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

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

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

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

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

        if ( $this->readCache() ) {

            return $this->shutdown();

        }

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

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

        try {

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

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

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

            $this->route = $route;

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

        } catch (DispatcherException $de) {

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

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

            $this->processDispatcherException($de);

            return $this->shutdown();

        }

        $route_type = $route->getType();

        $route_service = $route->getServiceName();

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

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

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

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

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

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

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

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

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

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

        // translate route to service

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

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

        try {

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

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

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

        } catch (DispatcherException $de) {

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

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

            $this->processDispatcherException($de);

        }

        $this->processConfigurationParameters($route);

        $this->dumpCache($route);

        return $this->shutdown();

    }

    private function readCache() {

        $name = (string) $this->request->uri;

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

        $cache = $this->cache->setNamespace('dispatcherservice')->get($name);

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

        if ( is_null($cache) ) return false;

        $this->response->import($cache);

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

        return true;

    }

    private function dumpCache($route) {

        $cache = strtoupper($route->getParameter('cache'));

        $ttl = $route->getParameter('ttl');

        $name = (string) $this->request->uri;

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

        $method = $this->request->method->get();

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

        $status = $this->response->status->get();

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

        // @NOTE: Server cache will not consider cacheable POST or PUT requests
        //        because of dispatcher internal structure: if post request is cached
        //        subsequent requests will never reach the service.
        if (
            ( $cache == 'SERVER' || $cache == 'BOTH' ) &&
            in_array($method, array('GET', 'HEAD')) &&
            in_array($status, array(200, 203, 300, 301, 302, 404, 410))
        ){

            $this->cache->setNamespace('dispatcherservice')->set($name, $this->response->export(), $ttl);

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

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

        }

    }

    private function processConfigurationParameters($route) {

        $params = $route->getParameter('headers');

        if ( !empty($params) && is_array($params) ) {

            foreach($params as $name=>$value) $this->response->headers->set($name, $value);

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

        }

    }

    private function emitServiceSpecializedEvents($name) {

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

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

        return new ServiceEvent(
            $name,
            $this->logger,

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

            $this->request,

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

            $this->router,

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

            $this->response,

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

            $this->extra

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

        );

    }

    private function processDispatcherException(DispatcherException $de) {

        $status = $de->getStatus();

        $message = $de->getMessage();

        $headers = $de->getHeaders();

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

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

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

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

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

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

    }

    private function shutdown() {

        $this->response->consolidate($this->request, $this->route);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        if ( function_exists('fastcgi_finish_request') ) fastcgi_finish_request();
        else ob_end_clean();

        return $return;

    }

}