laminas / laminas-mvc-middleware / 40

pending completion

Build # 40

Build Type

Pull #3

travis-ci-com

Committed by

web-flow

Commit Message

<a href="https://github.com/laminas/laminas-mvc-middleware/commit/<a class=hub.com/laminas/laminas-mvc-middleware/commit/<a class="double-link" href="https://git"><a class=hub.com/laminas/laminas-mvc-middleware/commit/<a class="double-link" href="https://git"><a class=hub.com/laminas/laminas-mvc-middleware/commit/<a class="double-link" href="https://git"><a class=hub.com/laminas/laminas-mvc-middleware/commit/84f0b44300cefb4d8fb01549839d31732fc40069">84f0b4430">&lt;a href=&quot;https://github.com/laminas/laminas-mvc-middleware/commit/</a><a class="double-link" href="https://github.com/laminas/laminas-mvc-middleware/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/laminas/laminas-mvc-middleware/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/laminas/laminas-mvc-middleware/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/laminas/laminas-mvc-middleware/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/laminas/laminas-mvc-middleware/commit/84f0b44300cefb4d8fb01549839d31732fc40069">84f0b4430</a><a href="https://github.com/laminas/laminas-mvc-middleware/commit/84f0b44300cefb4d8fb01549839d31732fc40069">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/laminas/laminas-mvc-middleware/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/laminas/laminas-mvc-middleware/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/laminas/laminas-mvc-middleware/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/laminas/laminas-mvc-middleware/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/laminas/laminas-mvc-middleware/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/laminas/laminas-mvc-middleware/commit/84f0b44300cefb4d8fb01549839d31732fc40069&quot;&gt;84f0b4430&lt;/a&gt;&lt;a href=&quot;https://github.com/laminas/laminas-mvc-middleware/commit/84f0b44300cefb4d8fb01549839d31732fc40069&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&a... (continued)

Pull Request Pull Request #3: Update to stratigility 3 and move to PSR middlewares

Run Details

32 of 32 new or added lines in 3 files covered. (100.0%)

95 of 102 relevant lines covered (93.14%)

9.45 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

90.67

/src/MiddlewareListener.php

<?php

/**
 * @see       https://github.com/laminas/laminas-mvc-middleware for the canonical source repository
 * @copyright https://github.com/laminas/laminas-mvc-middleware/blob/master/COPYRIGHT.md
 * @license   https://github.com/laminas/laminas-mvc-middleware/blob/master/LICENSE.md New BSD License
 */

namespace Laminas\Mvc\Middleware;

use Laminas\EventManager\AbstractListenerAggregate;
use Laminas\EventManager\EventManagerInterface;
use Laminas\Http\Response;
use Laminas\Mvc\Application;
use Laminas\Mvc\Exception\InvalidMiddlewareException;
use Laminas\Mvc\MvcEvent;
use Laminas\Psr7Bridge\Psr7Response;
use Laminas\Stratigility\Middleware\RequestHandlerMiddleware;
use Laminas\Stratigility\MiddlewarePipe;
use Psr\Container\ContainerInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Throwable;

use function gettype;
use function is_object;
use function is_string;

class MiddlewareListener extends AbstractListenerAggregate
{
    /**
     * Attach listeners to an event manager
     *
     * @return void
     */
    public function attach(EventManagerInterface $events, $priority = 1) : void
    {
        $this->listeners[] = $events->attach(MvcEvent::EVENT_DISPATCH, [$this, 'onDispatch'], 1);
    }

    /**
     * Listen to the "dispatch" event
     *
     * @return null|Response
     */
    public function onDispatch(MvcEvent $event)
    {
        if (null !== $event->getResult()) {
            return null;
        }

        $routeMatch = $event->getRouteMatch();
        $middleware = $routeMatch->getParam('middleware', false);
        if (false === $middleware) {
            return null;
        }

        $request        = $event->getRequest();
        $application    = $event->getApplication();
        $response       = $application->getResponse();
        $serviceManager = $application->getServiceManager();

        try {
            $pipe = $this->createPipeFromSpec(
                $serviceManager,
                is_array($middleware) ? $middleware : [$middleware]
            );
        } catch (InvalidMiddlewareException $invalidMiddlewareException) {
            $return = $this->marshalInvalidMiddleware(
                Application::ERROR_MIDDLEWARE_CANNOT_DISPATCH,
                $invalidMiddlewareException->toMiddlewareName(),
                $event,
                $application,
                $invalidMiddlewareException
            );
            $event->setResult($return);
            return $return;
        }

        $caughtException = null;
        try {
            $return = (new MiddlewareController(
                $pipe,
                $application->getServiceManager()->get('EventManager'),
                $event
            ))->dispatch($request, $response);
        } catch (Throwable $exception) {
            $event->setName(MvcEvent::EVENT_DISPATCH_ERROR);
            $event->setError(Application::ERROR_EXCEPTION);
            $event->setParam('exception', $exception);

            $events  = $application->getEventManager();
            $results = $events->triggerEvent($event);
            $return  = $results->last();
            if (! $return) {
                $return = $event->getResult();
            }
        }

        $event->setError('');

        if (! $return instanceof ResponseInterface) {
            $event->setResult($return);
            return $return;
        }
        $response = Psr7Response::toLaminas($return);
        $event->setResult($response);
        return $response;
    }

    /**
     * Create a middleware pipe from the array spec given.
     *
     * @param mixed[] $middlewarePipeSpec
     *      List of string ids for middleware in container, instances of MiddlewareInterface
     *      or RequestHandlerInterface
     * @throws InvalidMiddlewareException
     */
    private function createPipeFromSpec(
        ContainerInterface $serviceLocator,
        array $middlewarePipeSpec
    ): RequestHandlerInterface {
        // Pipe has implicit empty pipeline handler
        $pipe = new MiddlewarePipe();
        foreach ($middlewarePipeSpec as $middlewareToBePiped) {
            if (null === $middlewareToBePiped) {
                throw InvalidMiddlewareException::fromNull();
            }

            $middlewareName = is_object($middlewareToBePiped)
                ? get_class($middlewareToBePiped)
                : gettype($middlewareToBePiped);

            if (is_string($middlewareToBePiped)) {
                $middlewareName = $middlewareToBePiped;
                if (! $serviceLocator->has($middlewareToBePiped)) {
                    // throw separately for stacktrace line hint
                    throw InvalidMiddlewareException::fromMiddlewareName($middlewareName);
                }
                $middlewareToBePiped = $serviceLocator->get($middlewareToBePiped);
            }

            if ($middlewareToBePiped instanceof MiddlewareInterface) {
                $pipe->pipe($middlewareToBePiped);
                continue;
            }
            if ($middlewareToBePiped instanceof RequestHandlerInterface) {
                $middlewareToBePiped = new RequestHandlerMiddleware($middlewareToBePiped);
                $pipe->pipe($middlewareToBePiped);
                break; // request handler will always stop pipe processing. Rest of the pipe can be ignored
            }

            throw InvalidMiddlewareException::fromMiddlewareName($middlewareName);
        }
        return $pipe;
    }

    /**
     * Marshal a middleware not callable exception event
     *
     * @param  string $type
     * @param  string $middlewareName
     * @return mixed
     */
    protected function marshalInvalidMiddleware(
        $type,
        $middlewareName,
        MvcEvent $event,
        Application $application,
        Throwable $exception = null
    ) {
        $event->setName(MvcEvent::EVENT_DISPATCH_ERROR);
        $event->setError($type);
        $event->setController($middlewareName);
        $event->setControllerClass('Middleware not callable: ' . $middlewareName);
        if ($exception !== null) {
            $event->setParam('exception', $exception);
        }

        $events  = $application->getEventManager();
        $results = $events->triggerEvent($event);
        $return  = $results->last();
        if (! $return) {
            $return = $event->getResult();
        }
        return $return;
    }
}

1	<?php
2
3	/**
4	* @see https://github.com/laminas/laminas-mvc-middleware for the canonical source repository
5	* @copyright https://github.com/laminas/laminas-mvc-middleware/blob/master/COPYRIGHT.md
6	* @license https://github.com/laminas/laminas-mvc-middleware/blob/master/LICENSE.md New BSD License
7	*/
8
9	namespace Laminas\Mvc\Middleware;
10
11	use Laminas\EventManager\AbstractListenerAggregate;
12	use Laminas\EventManager\EventManagerInterface;
13	use Laminas\Http\Response;
14	use Laminas\Mvc\Application;
15	use Laminas\Mvc\Exception\InvalidMiddlewareException;
16	use Laminas\Mvc\MvcEvent;
17	use Laminas\Psr7Bridge\Psr7Response;
18	use Laminas\Stratigility\Middleware\RequestHandlerMiddleware;
19	use Laminas\Stratigility\MiddlewarePipe;
20	use Psr\Container\ContainerInterface;
21	use Psr\Http\Message\ResponseInterface;
22	use Psr\Http\Server\MiddlewareInterface;
23	use Psr\Http\Server\RequestHandlerInterface;
24	use Throwable;
25
26	use function gettype;
27	use function is_object;
28	use function is_string;
29
30	class MiddlewareListener extends AbstractListenerAggregate
31	{
32	/**
33	* Attach listeners to an event manager
34	*
35	* @return void
36	*/
37	public function attach(EventManagerInterface $events, $priority = 1) : void
38	{
39	$this->listeners[] = $events->attach(MvcEvent::EVENT_DISPATCH, [$this, 'onDispatch'], 1);	×
40	}	×
41
42	/**
43	* Listen to the "dispatch" event
44	*
45	* @return null\|Response
46	*/
47	public function onDispatch(MvcEvent $event)
48	{
49	if (null !== $event->getResult()) {	44✔
50	return null;	22✔
51	}
52
53	$routeMatch = $event->getRouteMatch();	22✔
54	$middleware = $routeMatch->getParam('middleware', false);	22✔
55	if (false === $middleware) {	22✔
56	return null;	×
57	}
58
59	$request = $event->getRequest();	22✔
60	$application = $event->getApplication();	22✔
61	$response = $application->getResponse();	22✔
62	$serviceManager = $application->getServiceManager();	22✔
63
64	try {
65	$pipe = $this->createPipeFromSpec(	22✔
66	$serviceManager,	22✔
67	is_array($middleware) ? $middleware : [$middleware]	22✔
68	);
69	} catch (InvalidMiddlewareException $invalidMiddlewareException) {	4✔
70	$return = $this->marshalInvalidMiddleware(	4✔
71	Application::ERROR_MIDDLEWARE_CANNOT_DISPATCH,	4✔
72	$invalidMiddlewareException->toMiddlewareName(),	4✔
73	$event,
74	$application,
75	$invalidMiddlewareException
76	);
77	$event->setResult($return);	4✔
78	return $return;	4✔
79	}
80
81	$caughtException = null;	18✔
82	try {
83	$return = (new MiddlewareController(	18✔
84	$pipe,	18✔
85	$application->getServiceManager()->get('EventManager'),	18✔
86	$event
87	))->dispatch($request, $response);	18✔
88	} catch (Throwable $exception) {	4✔
89	$event->setName(MvcEvent::EVENT_DISPATCH_ERROR);	4✔
90	$event->setError(Application::ERROR_EXCEPTION);	4✔
91	$event->setParam('exception', $exception);	4✔
92
93	$events = $application->getEventManager();	4✔
94	$results = $events->triggerEvent($event);	4✔
95	$return = $results->last();	4✔
96	if (! $return) {	4✔
97	$return = $event->getResult();	×
98	}
99	}
100
101	$event->setError('');	18✔
102
103	if (! $return instanceof ResponseInterface) {	18✔
104	$event->setResult($return);	4✔
105	return $return;	4✔
106	}
107	$response = Psr7Response::toLaminas($return);	14✔
108	$event->setResult($response);	14✔
109	return $response;	14✔
110	}
111
112	/**
113	* Create a middleware pipe from the array spec given.
114	*
115	* @param mixed[] $middlewarePipeSpec
116	* List of string ids for middleware in container, instances of MiddlewareInterface
117	* or RequestHandlerInterface
118	* @throws InvalidMiddlewareException
119	*/
120	private function createPipeFromSpec(
121	ContainerInterface $serviceLocator,
122	array $middlewarePipeSpec
123	): RequestHandlerInterface {
124	// Pipe has implicit empty pipeline handler
125	$pipe = new MiddlewarePipe();	22✔
126	foreach ($middlewarePipeSpec as $middlewareToBePiped) {	22✔
127	if (null === $middlewareToBePiped) {	20✔
128	throw InvalidMiddlewareException::fromNull();	2✔
129	}
130
131	$middlewareName = is_object($middlewareToBePiped)	18✔
132	? get_class($middlewareToBePiped)	×
133	: gettype($middlewareToBePiped);	18✔
134
135	if (is_string($middlewareToBePiped)) {	18✔
136	$middlewareName = $middlewareToBePiped;	18✔
137	if (! $serviceLocator->has($middlewareToBePiped)) {	18✔
138	// throw separately for stacktrace line hint
139	throw InvalidMiddlewareException::fromMiddlewareName($middlewareName);	2✔
140	}
141	$middlewareToBePiped = $serviceLocator->get($middlewareToBePiped);	16✔
142	}
143
144	if ($middlewareToBePiped instanceof MiddlewareInterface) {	16✔
145	$pipe->pipe($middlewareToBePiped);	14✔
146	continue;	14✔
147	}
148	if ($middlewareToBePiped instanceof RequestHandlerInterface) {	2✔
149	$middlewareToBePiped = new RequestHandlerMiddleware($middlewareToBePiped);	2✔
150	$pipe->pipe($middlewareToBePiped);	2✔
151	break; // request handler will always stop pipe processing. Rest of the pipe can be ignored	2✔
152	}
153
154	throw InvalidMiddlewareException::fromMiddlewareName($middlewareName);	×
155	}
156	return $pipe;	18✔
157	}
158
159	/**
160	* Marshal a middleware not callable exception event
161	*
162	* @param string $type
163	* @param string $middlewareName
164	* @return mixed
165	*/
166	protected function marshalInvalidMiddleware(
167	$type,
168	$middlewareName,
169	MvcEvent $event,
170	Application $application,
171	Throwable $exception = null
172	) {
173	$event->setName(MvcEvent::EVENT_DISPATCH_ERROR);	4✔
174	$event->setError($type);	4✔
175	$event->setController($middlewareName);	4✔
176	$event->setControllerClass('Middleware not callable: ' . $middlewareName);	4✔
177	if ($exception !== null) {	4✔
178	$event->setParam('exception', $exception);	4✔
179	}
180
181	$events = $application->getEventManager();	4✔
182	$results = $events->triggerEvent($event);	4✔
183	$return = $results->last();	4✔
184	if (! $return) {	4✔
185	$return = $event->getResult();	×
186	}
187	return $return;	4✔
188	}
189	}

laminas / laminas-mvc-middleware / 40

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous