Dispatcher::events() - Code Metrics - Inspection of "remove old classes, new configuration" - comodojo/dispatcher.framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 4.0 ( 1bebd1...1533b9 )

by Marco

created 2016-01-29 19:36 UTC

Dispatcher::events() A

↳ Parent: Dispatcher

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	5
rs	9.4285
cc	1
eloc	2
nc	1
nop	0

<?php namespace Comodojo\Dispatcher;

use \Monolog\Logger;
use \Comodojo\Dispatcher\Components\Configuration;
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\Cache\CacheManager;
use \League\Event\Emitter;

/**
 *
 * @package     Comodojo dispatcher
 * @author      Marco Giovinazzi <[email protected]>
 * @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 $events = null,
        CacheManager $cache = null,
        Logger $logger = null
    ) {

        ob_start();

        $this->setTimestamp();

        $this->configuration = new Configuration($configuration);
        
        $this->events = is_null($events) ? new Emitter() : $emitter;

        
        $this->logger = is_null($logger) ? DispatcherLogger::create($this->configuration) : $logger;
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        
        $this->cache = is_null($cache) ? DispatcherCache::create($this->configuration, $this->logger) : $cache;
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        
        $this->request = new Request($this->configuration, $this->logger);
        
        $this->router = new RouteCollector($this->configuration, $this->logger, $this->cache);
        
        $this->response = new Response($this->configuration, $this->logger);
        
        $this->extra = new Extra($this->logger);

        
        $this->router->load( $routing_table );


    }

    public function configuration() {

        return $this->configuration;

    }

    public function events() {

        return $this->events;

    }

    public function cache() {

        return $this->cache;

    }

    public function request() {

        return $this->request;

    }

    public function router() {

        return $this->router;

    }

    public function response() {

        return $this->response;

    }
    
    public function extra() {

        return $this->extra;

    }

    public function dispatch() {

        $this->events->emit( new DispatcherEvent($this) );
        
        if ( $this->configuration()->get('dispatcher-enabled') === false ) {
            
            $status = $this->configuration()->get('dispatcher-disabled-status');
            
            $content = $this->configuration()->get('dispatcher-disabled-message');
            
            $this->response()->status()->set($status);
            
            $this->response()->content()->set($content);
            
        } else {
            
            $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->router->route($this->request);
    
            $this->events->emit( $this->emitServiceSpecializedEvents('dispatcher.route') );
    
            $this->events->emit( $this->emitServiceSpecializedEvents('dispatcher.route.'.$this->router->getType()) );
    
            $this->events->emit( $this->emitServiceSpecializedEvents('dispatcher.route.'.$this->router->getService()) );
    
            $this->events->emit( $this->emitServiceSpecializedEvents('dispatcher.route.#') );
    
            // translate route to service
    
            $this->router->compose($this->response);
    
            $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.#') );
            
        }

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

        ob_end_clean();

        return $return;

    }

    private function emitServiceSpecializedEvents($name) {

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

    }

}


1			<?php namespace Comodojo\Dispatcher;
2
3			use \Monolog\Logger;
4			use \Comodojo\Dispatcher\Components\Configuration;
5			use \Comodojo\Dispatcher\Request\Model as Request;
6			use \Comodojo\Dispatcher\Router\Collector as RouteCollector;
7			use \Comodojo\Dispatcher\Response\Model as Response;
8			use \Comodojo\Dispatcher\Extra\Model as Extra;
9			use \Comodojo\Dispatcher\Components\Timestamp as TimestampTrait;
10			use \Comodojo\Dispatcher\Output\Processor;
11			use \Comodojo\Dispatcher\Events\DispatcherEvent;
12			use \Comodojo\Dispatcher\Events\ServiceEvent;
13			use \Comodojo\Dispatcher\Router\RoutingTableInterface;
14			use \Comodojo\Dispatcher\Log\DispatcherLogger;
15			use \Comodojo\Dispatcher\Cache\DispatcherCache;
16			use \Comodojo\Cache\CacheManager;
17			use \League\Event\Emitter;
18
19			/**
20			*
21			* @package Comodojo dispatcher
22			* @author Marco Giovinazzi <[email protected]>
23			* @license GPL-3.0+
24			*
25			* LICENSE:
26			*
27			* This program is free software: you can redistribute it and/or modify
28			* it under the terms of the GNU Affero General Public License as
29			* published by the Free Software Foundation, either version 3 of the
30			* License, or (at your option) any later version.
31			*
32			* This program is distributed in the hope that it will be useful,
33			* but WITHOUT ANY WARRANTY; without even the implied warranty of
34			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
35			* GNU Affero General Public License for more details.
36			*
37			* You should have received a copy of the GNU Affero General Public License
38			* along with this program. If not, see <http://www.gnu.org/licenses/>.
39			*/
40
41			class Dispatcher {
42
43			use TimestampTrait;
44
45			private $configuration;
46
47			private $request;
48
49			private $router;
50
51			private $response;
52
53			private $extra;
54
55			private $logger;
56
57			private $cache;
58
59			private $events;
60
61			public function __construct(
62			$configuration = array(),
63			Emitter $events = null,
64			CacheManager $cache = null,
65			Logger $logger = null
66			) {
67
68			ob_start();
69
70			$this->setTimestamp();
71
72			$this->configuration = new Configuration($configuration);
73
74			$this->events = is_null($events) ? new Emitter() : $emitter;
			0 ignored issues – show Bug introduced 2016-01-28 23:00 UTC by Report Bug Copy Issue Report The variable `$emitter` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
75
76			$this->logger = is_null($logger) ? DispatcherLogger::create($this->configuration) : $logger;
			0 ignored issues – show Documentation introduced 2016-01-29 19:50 UTC by Report Bug Copy Issue Report `$this->configuration` is of type `object<Comodojo\Dispatch...mponents\Configuration>`, but the function expects a `object<Comodojo\Dispatcher\Log\Configuration>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
77
78			$this->cache = is_null($cache) ? DispatcherCache::create($this->configuration, $this->logger) : $cache;
			0 ignored issues – show Documentation introduced 2016-01-29 19:50 UTC by Report Bug Copy Issue Report `$this->configuration` is of type `object<Comodojo\Dispatch...mponents\Configuration>`, but the function expects a `object<Comodojo\Dispatcher\Cache\Configuration>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
79
80			$this->request = new Request($this->configuration, $this->logger);
81
82			$this->router = new RouteCollector($this->configuration, $this->logger, $this->cache);
83
84			$this->response = new Response($this->configuration, $this->logger);
85
86			$this->extra = new Extra($this->logger);
			0 ignored issues – show Unused Code introduced 2016-01-28 23:00 UTC by Report Bug Copy Issue Report The call to `Model::__construct()` has too many arguments starting with `$this->logger`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
87
88			$this->router->load( $routing_table );
			0 ignored issues – show Bug introduced 2016-01-28 23:00 UTC by Report Bug Copy Issue Report The variable `$routing_table` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
89
90			}
91
92			public function configuration() {
93
94			return $this->configuration;
95
96			}
97
98			public function events() {
99
100			return $this->events;
101
102			}
103
104			public function cache() {
105
106			return $this->cache;
107
108			}
109
110			public function request() {
111
112			return $this->request;
113
114			}
115
116			public function router() {
117
118			return $this->router;
119
120			}
121
122			public function response() {
123
124			return $this->response;
125
126			}
127
128			public function extra() {
129
130			return $this->extra;
131
132			}
133
134			public function dispatch() {
135
136			$this->events->emit( new DispatcherEvent($this) );
137
138			if ( $this->configuration()->get('dispatcher-enabled') === false ) {
139
140			$status = $this->configuration()->get('dispatcher-disabled-status');
141
142			$content = $this->configuration()->get('dispatcher-disabled-message');
143
144			$this->response()->status()->set($status);
145
146			$this->response()->content()->set($content);
147
148			} else {
149
150			$this->events->emit( $this->emitServiceSpecializedEvents('dispatcher.request') );
151
152			$this->events->emit( $this->emitServiceSpecializedEvents('dispatcher.request.'.$this->request->method()->get()) );
153
154			$this->events->emit( $this->emitServiceSpecializedEvents('dispatcher.request.#') );
155
156			$this->router->route($this->request);
157
158			$this->events->emit( $this->emitServiceSpecializedEvents('dispatcher.route') );
159
160			$this->events->emit( $this->emitServiceSpecializedEvents('dispatcher.route.'.$this->router->getType()) );
161
162			$this->events->emit( $this->emitServiceSpecializedEvents('dispatcher.route.'.$this->router->getService()) );
163
164			$this->events->emit( $this->emitServiceSpecializedEvents('dispatcher.route.#') );
165
166			// translate route to service
167
168			$this->router->compose($this->response);
169
170			$this->events->emit( $this->emitServiceSpecializedEvents('dispatcher.response') );
171
172			$this->events->emit( $this->emitServiceSpecializedEvents('dispatcher.response.'.$this->response->status()->get()) );
173
174			$this->events->emit( $this->emitServiceSpecializedEvents('dispatcher.response.#') );
175
176			}
177
178			$return = Processor::parse($this->configuration, $this->logger, $this->response);
179
180			ob_end_clean();
181
182			return $return;
183
184			}
185
186			private function emitServiceSpecializedEvents($name) {
187
188			return new ServiceEvent(
189			$name,
190			$this->logger,
191			$this->request,
192			$this->router,
193			$this->response,
194			$this->extra
195			);
196
197			}
198
199			}
200

comodojo / dispatcher.framework

Push — 4.0 ( 1bebd1...1533b9 )

Dispatcher::events() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like