Renderer::getData() - Code Metrics - slickframework/mvc - Measure and Improve Code Quality continuously with Scrutinizer

Renderer::getData() A
last analyzed 2017-06-28 15:50 UTC

↳ Parent: Renderer

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	5
ccs	0
cts	3
cp	0
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	0
crap	2

<?php

/**
 * This file is part of slick/mvc package
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Slick\Mvc;

use Aura\Router\Route;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Slick\Http\Server\AbstractMiddleware;
use Slick\Http\Server\MiddlewareInterface;
use Slick\Http\Stream;
use Slick\Mvc\Renderer\HtmlExtension;
use Slick\Template\Template;

/**
 * Request Renderer
 *
 * @package Slick\Mvc
 * @author  Filipe Silva <[email protected]>
 */
class Renderer extends AbstractMiddleware implements MiddlewareInterface
{

    /**
     * @var ServerRequestInterface
     */
    protected $request;

    /**
     * Handles a Request and updated the response
     *
     * @param ServerRequestInterface $request
     * @param ResponseInterface $response
     *
     * @return ResponseInterface
     */
    public function handle(
        ServerRequestInterface $request, ResponseInterface $response
    )
    {
        $this->request = $request;
        $render = $this->request->getAttribute('render', true);
        if ($render) {
            $response = $this->render($response);
        }
        return $this->executeNext($request, $response);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * Adds a template path
     *
     * @param $path
     */
    public function addTemplatePath($path)
    {
        Template::addPath($path);
    }

    /**
     * Processes and renders the response
     *
     * @param ResponseInterface $response
     * @return ResponseInterface|static
     */
    protected function render(ResponseInterface $response)
    {
        $stream = new Stream('php://memory', 'rw+');
        $content = $this->getEngine()
            ->parse($this->getTemplate())
            ->process($this->getData())
        ;
        $stream->write($content);

        $response = $response->withBody($stream);
        return $response;
    }

    /**
     * Creates the engine for this rendering
     *
     * @return \Slick\Template\TemplateEngineInterface
     */
    protected function getEngine()
    {
        Template::addPath(dirname(__DIR__).'/templates');
        $template = new Template();
        $template->addExtension(HtmlExtension::class);
        return $template->initialize();
    }

    /**
     * Gets the template file for current request
     * 
     * @return string
     */
    protected function getTemplate()
    {
        $template = $this->request
            ->getAttribute('template', $this->getDefaultTemplate());
        return $template.'.twig';
    }

    /**
     * Gets data to be processed
     *
     * @return array
     */
    protected function getData()
    {
        $index = ControllerInterface::REQUEST_ATTR_VIEW_DATA;
        return $this->request->getAttribute($index, []);
    }

    /**
     * Returns the default template from current request route
     * 
     * @return string
     */
    protected function getDefaultTemplate()
    {
        /** @var Route $route */
        $route = $this->request->getAttribute('route');
        $values = $route->attributes;
        return "{$values['controller']}/{$values['action']}";
    }
}

1			<?php
2
3			/**
4			* This file is part of slick/mvc package
5			*
6			* For the full copyright and license information, please view the LICENSE
7			* file that was distributed with this source code.
8			*/
9
10			namespace Slick\Mvc;
11
12			use Aura\Router\Route;
13			use Psr\Http\Message\ResponseInterface;
14			use Psr\Http\Message\ServerRequestInterface;
15			use Slick\Http\Server\AbstractMiddleware;
16			use Slick\Http\Server\MiddlewareInterface;
17			use Slick\Http\Stream;
18			use Slick\Mvc\Renderer\HtmlExtension;
19			use Slick\Template\Template;
20
21			/**
22			* Request Renderer
23			*
24			* @package Slick\Mvc
25			* @author Filipe Silva <[email protected]>
26			*/
27			class Renderer extends AbstractMiddleware implements MiddlewareInterface
28			{
29
30			/**
31			* @var ServerRequestInterface
32			*/
33			protected $request;
34
35			/**
36			* Handles a Request and updated the response
37			*
38			* @param ServerRequestInterface $request
39			* @param ResponseInterface $response
40			*
41			* @return ResponseInterface
42			*/
43			public function handle(
44			ServerRequestInterface $request, ResponseInterface $response
45			)
46			{
47			$this->request = $request;
48			$render = $this->request->getAttribute('render', true);
49			if ($render) {
50			$response = $this->render($response);
51			}
52			return $this->executeNext($request, $response);
			0 ignored issues – show Bug introduced 2016-08-05 17:55 UTC by Report Bug Copy Issue Report It seems like `$response` defined by `$this->render($response)` on line `50` can also be of type `object<Slick\Mvc\Renderer>`; however, `Slick\Http\Server\Abstra...ddleware::executeNext()` does only seem to accept `object<Psr\Http\Message\ResponseInterface>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
53			}
54
55			/**
56			* Adds a template path
57			*
58			* @param $path
59			*/
60			public function addTemplatePath($path)
61			{
62			Template::addPath($path);
63			}
64
65			/**
66			* Processes and renders the response
67			*
68			* @param ResponseInterface $response
69			* @return ResponseInterface\|static
70			*/
71			protected function render(ResponseInterface $response)
72			{
73			$stream = new Stream('php://memory', 'rw+');
74			$content = $this->getEngine()
75			->parse($this->getTemplate())
76			->process($this->getData())
77			;
78			$stream->write($content);
79
80			$response = $response->withBody($stream);
81			return $response;
82			}
83
84			/**
85			* Creates the engine for this rendering
86			*
87			* @return \Slick\Template\TemplateEngineInterface
88			*/
89			protected function getEngine()
90			{
91			Template::addPath(dirname(__DIR__).'/templates');
92			$template = new Template();
93			$template->addExtension(HtmlExtension::class);
94			return $template->initialize();
95			}
96
97			/**
98			* Gets the template file for current request
99			*
100			* @return string
101			*/
102			protected function getTemplate()
103			{
104			$template = $this->request
105			->getAttribute('template', $this->getDefaultTemplate());
106			return $template.'.twig';
107			}
108
109			/**
110			* Gets data to be processed
111			*
112			* @return array
113			*/
114			protected function getData()
115			{
116			$index = ControllerInterface::REQUEST_ATTR_VIEW_DATA;
117			return $this->request->getAttribute($index, []);
118			}
119
120			/**
121			* Returns the default template from current request route
122			*
123			* @return string
124			*/
125			protected function getDefaultTemplate()
126			{
127			/** @var Route $route */
128			$route = $this->request->getAttribute('route');
129			$values = $route->attributes;
130			return "{$values['controller']}/{$values['action']}";
131			}
132			}

slickframework / mvc

Renderer::getData() A last analyzed 2017-06-28 15:50 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Renderer::getData() A
last analyzed 2017-06-28 15:50 UTC