Middlewares::handleMicro() - Code Metrics - Inspection of "Merge pull request #24 from adhocore/refactor-midd..." - adhocore/phalcon-ext - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4dc655...679eeb )

by Jitendra

created 2018-06-19 13:59 UTC

Middlewares::handleMicro() A

↳ Parent: Middlewares

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	1

<?php

namespace PhalconExt\Http;

use Phalcon\Di\Injectable;
filter:
    dependency_paths: ["lib/*"]
use Phalcon\Http\Request;
use Phalcon\Http\Response;
use Phalcon\Mvc\Application;
filter:
    dependency_paths: ["lib/*"]
use Phalcon\Mvc\DispatcherInterface as Dispatcher;
filter:
    dependency_paths: ["lib/*"]
use Phalcon\Mvc\Micro as MicroApplication;
filter:
    dependency_paths: ["lib/*"]
use PhalconExt\Di\ProvidesDi;

/**
 * A manager for middlewares.
 *
 * @author  Jitendra Adhikari <[email protected]>
 * @license MIT
 *
 * @link    https://github.com/adhocore/phalcon-ext
 */
class Middlewares
{
    use ProvidesDi;

    protected $middlewares = [];

    public function __construct(array $middlewares)
    {
        $this->middlewares = $middlewares;
    }

    /**
     * Wraps app with middlewares and runs the app.
     *
     * @param Injectable $app The app instance: micro or mvc
     */
    public function wrap(Injectable $app)
    {
        if ($app instanceof MicroApplication) {
            return $this->handleMicro($app);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        }

        if (!$app instanceof Application) {
            throw new \InvalidArgumentException('The app instance is not one of micro or mvc');
        }

        $this->di()->setShared('application', $app);

        $this->handleMvc($app);
    }

    /**
     * Setup before/after handers for micro app and run the app.
     *
     * @param Injectable $app
     *
     * @return void
     */
    protected function handleMicro(Injectable $app)
    {
        $app
            ->before([$this, 'beforeHandleRequest'])
            ->after([$this, 'beforeSendResponse']);

        $this->handleApp($app);
    }

    /**
     * Setup event handlers for mvc app and run the app.
     *
     * @param Injectable $app
     *
     * @return void
     */
    protected function handleMvc(Injectable $app)
    {
        $evm = $this->di('eventsManager');

        $evm->attach('application', $this);
        $evm->attach('dispatch', $this);
        $app->setEventsManager($evm);

        $this->di('dispatcher')->setEventsManager($evm);

        $this->handleApp($app);
    }

    /**
     * Handles http requests to the app.
     *
     * @param Injectable $app
     *
     * @return mixed Whatever is given by $app->handle().
     */
    protected function handleApp(Injectable $app)
    {
        $return = $app->handle();

        $response = $this->di('response');

        if (!$response->isSent()) {
            $response->send();
        }

        return $return;
    }

    public function beforeHandleRequest(): bool
    {
        return $this->relay('before');
    }

    public function beforeSendResponse(): bool
    {
        return $this->relay('after');
    }

    /**
     * Sends events to all the middlewares. Aborts if one fails with falsy return value.
     *
     * @param string $event
     *
     * @return bool
     */
    protected function relay(string $event): bool
    {
        foreach ($this->middlewares as $middleware) {
            if (!$this->call($event, $middleware)) {
                return false;
            }
        }

        return true;
    }

    /**
     * Call event method on middleware.
     *
     * @param string $event
     * @param mixed  $middleware
     *
     * @return bool
     */
    protected function call(string $event, $middleware): bool
    {
        if (\is_string($middleware)) {
            $middleware = $this->di($middleware);
        }

        if (!\method_exists($middleware, $event)) {
            return true;
        }

        return $middleware->$event($this->di('request'), $this->di('response'));
    }
}


1			<?php
2
3			namespace PhalconExt\Http;
4
5			use Phalcon\Di\Injectable;
			0 ignored issues – show Bug introduced 2018-06-19 13:34 UTC by Report Bug Copy Issue Report The type `Phalcon\Di\Injectable` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
6			use Phalcon\Http\Request;
7			use Phalcon\Http\Response;
8			use Phalcon\Mvc\Application;
			0 ignored issues – show Bug introduced 2018-06-19 13:34 UTC by Report Bug Copy Issue Report The type `Phalcon\Mvc\Application` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
9			use Phalcon\Mvc\DispatcherInterface as Dispatcher;
			0 ignored issues – show Bug introduced 2018-06-11 22:40 UTC by Report Bug Copy Issue Report The type `Phalcon\Mvc\DispatcherInterface` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
10			use Phalcon\Mvc\Micro as MicroApplication;
			0 ignored issues – show Bug introduced 2018-06-11 22:40 UTC by Report Bug Copy Issue Report The type `Phalcon\Mvc\Micro` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
11			use PhalconExt\Di\ProvidesDi;
12
13			/**
14			* A manager for middlewares.
15			*
16			* @author Jitendra Adhikari <[email protected]>
17			* @license MIT
18			*
19			* @link https://github.com/adhocore/phalcon-ext
20			*/
21			class Middlewares
22			{
23			use ProvidesDi;
24
25			protected $middlewares = [];
26
27			public function __construct(array $middlewares)
28			{
29			$this->middlewares = $middlewares;
30			}
31
32			/**
33			* Wraps app with middlewares and runs the app.
34			*
35			* @param Injectable $app The app instance: micro or mvc
36			*/
37			public function wrap(Injectable $app)
38			{
39			if ($app instanceof MicroApplication) {
40			return $this->handleMicro($app);
			0 ignored issues – show Bug introduced 2018-06-19 13:56 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->handleMicro($app)` targeting `PhalconExt\Http\Middlewares::handleMicro()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
41			}
42
43			if (!$app instanceof Application) {
44			throw new \InvalidArgumentException('The app instance is not one of micro or mvc');
45			}
46
47			$this->di()->setShared('application', $app);
48
49			$this->handleMvc($app);
50			}
51
52			/**
53			* Setup before/after handers for micro app and run the app.
54			*
55			* @param Injectable $app
56			*
57			* @return void
58			*/
59			protected function handleMicro(Injectable $app)
60			{
61			$app
62			->before([$this, 'beforeHandleRequest'])
63			->after([$this, 'beforeSendResponse']);
64
65			$this->handleApp($app);
66			}
67
68			/**
69			* Setup event handlers for mvc app and run the app.
70			*
71			* @param Injectable $app
72			*
73			* @return void
74			*/
75			protected function handleMvc(Injectable $app)
76			{
77			$evm = $this->di('eventsManager');
78
79			$evm->attach('application', $this);
80			$evm->attach('dispatch', $this);
81			$app->setEventsManager($evm);
82
83			$this->di('dispatcher')->setEventsManager($evm);
84
85			$this->handleApp($app);
86			}
87
88			/**
89			* Handles http requests to the app.
90			*
91			* @param Injectable $app
92			*
93			* @return mixed Whatever is given by $app->handle().
94			*/
95			protected function handleApp(Injectable $app)
96			{
97			$return = $app->handle();
98
99			$response = $this->di('response');
100
101			if (!$response->isSent()) {
102			$response->send();
103			}
104
105			return $return;
106			}
107
108			public function beforeHandleRequest(): bool
109			{
110			return $this->relay('before');
111			}
112
113			public function beforeSendResponse(): bool
114			{
115			return $this->relay('after');
116			}
117
118			/**
119			* Sends events to all the middlewares. Aborts if one fails with falsy return value.
120			*
121			* @param string $event
122			*
123			* @return bool
124			*/
125			protected function relay(string $event): bool
126			{
127			foreach ($this->middlewares as $middleware) {
128			if (!$this->call($event, $middleware)) {
129			return false;
130			}
131			}
132
133			return true;
134			}
135
136			/**
137			* Call event method on middleware.
138			*
139			* @param string $event
140			* @param mixed $middleware
141			*
142			* @return bool
143			*/
144			protected function call(string $event, $middleware): bool
145			{
146			if (\is_string($middleware)) {
147			$middleware = $this->di($middleware);
148			}
149
150			if (!\method_exists($middleware, $event)) {
151			return true;
152			}
153
154			return $middleware->$event($this->di('request'), $this->di('response'));
155			}
156			}
157

adhocore / phalcon-ext

Push — master ( 4dc655...679eeb )

Middlewares::handleMicro() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like