FilterIfPjax::setVersionHeader() - Code Metrics - Inspection of "Fix a bug where the version header would be sent w..." - spatie/laravel-pjax - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5f151d...30e150 )

by Freek

created 2016-02-18 15:16 UTC

FilterIfPjax::setVersionHeader() A

↳ Parent: FilterIfPjax

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
c	2
b	1
f	0
dl	0
loc	11
rs	9.4285
cc	2
eloc	6
nc	2
nop	2

<?php

namespace Spatie\Pjax\Middleware;

use Closure;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Symfony\Component\DomCrawler\Crawler;

class FilterIfPjax
{
    /**
     * The DomCrawler instance.
     *
     * @var \Symfony\Component\DomCrawler\Crawler
     */
    protected $crawler;

    /**
     * Handle an incoming request.
     *
     * @param \Illuminate\Http\Request $request
     * @param \Closure                 $next
     *
     * @return mixed
     */
    public function handle(Request $request, Closure $next)
    {
        $response = $next($request);

        if (!$request->pjax() || $response->isRedirection()) {
            return $response;
        }

        $this->filterResponse($response, $request->header('X-PJAX-Container'))

            ->setUriHeader($response, $request)
            ->setVersionHeader($response, $request);

        return $response;
    }

    /**
     * @param \Illuminate\Http\Response $response
     * @param string                    $container
     *
     * @return $this
     */
    protected function filterResponse(Response $response, $container)
    {
        $crawler = $this->getCrawler($response);

        $response->setContent(
            $this->makeTitle($crawler).
            $this->fetchContainer($crawler, $container)
        );

        return $this;
    }

    /**
     * @param \Symfony\Component\DomCrawler\Crawler $crawler
     *
     * @return null|string
     */
    protected function makeTitle(Crawler $crawler)
    {
        $pageTitle = $crawler->filter('head > title');

        if (!$pageTitle->count()) {
            return;
        }

        return "<title>{$pageTitle->html()}</title>";
    }

    /**
     * @param \Symfony\Component\DomCrawler\Crawler $crawler
     * @param string                                $container
     *
     * @return string
     */
    protected function fetchContainer(Crawler $crawler, $container)
    {
        $content = $crawler->filter($container);

        if (!$content->count()) {
            abort(422);
        }

        return $content->html();
    }

    /**
     * @param \Illuminate\Http\Response $response
     * @param \Illuminate\Http\Request  $request
     *
     * @return $this
     */
    protected function setUriHeader(Response $response, Request $request)
    {
        $response->header('X-PJAX-URL', $request->getRequestUri());

        return $this;
    }

    /**
     * @param \Illuminate\Http\Response $response
     * @param \Illuminate\Http\Request  $request
     *
     * @return $this
     */
    protected function setVersionHeader(Response $response, Request $request)

    {
        $crawler = $this->getCrawler($this->createReponseWithLowerCaseContent($response));
        $node = $crawler->filter('head > meta[http-equiv="x-pjax-version"]');

        if ($node->count()) {
            $response->header('x-pjax-version', $node->attr('content'));
        }

        return $this;
    }

    /**
     * Get the DomCrawler instance.
     *
     * @param \Illuminate\Http\Response $response
     *
     * @return \Symfony\Component\DomCrawler\Crawler
     */
    protected function getCrawler(Response $response)
    {
        if ($this->crawler) {
            return $this->crawler;
        }

        return $this->crawler = new Crawler($response->getContent());
    }

    /**
     * Make the content of the given response lowercase.
     *
     * @param \Illuminate\Http\Response $response
     *
     * @return \Illuminate\Http\Response
     */
    protected function createReponseWithLowerCaseContent(Response $response)
    {
        $lowercaseContent = strtolower($response->getContent());

        return Response::create($lowercaseContent);
    }
}


1			<?php
2
3			namespace Spatie\Pjax\Middleware;
4
5			use Closure;
6			use Illuminate\Http\Request;
7			use Illuminate\Http\Response;
8			use Symfony\Component\DomCrawler\Crawler;
9
10			class FilterIfPjax
11			{
12			/**
13			* The DomCrawler instance.
14			*
15			* @var \Symfony\Component\DomCrawler\Crawler
16			*/
17			protected $crawler;
18
19			/**
20			* Handle an incoming request.
21			*
22			* @param \Illuminate\Http\Request $request
23			* @param \Closure $next
24			*
25			* @return mixed
26			*/
27			public function handle(Request $request, Closure $next)
28			{
29			$response = $next($request);
30
31			if (!$request->pjax() \|\| $response->isRedirection()) {
32			return $response;
33			}
34
35			$this->filterResponse($response, $request->header('X-PJAX-Container'))
			0 ignored issues – show Bug introduced 2016-01-13 18:26 UTC by Report Bug Copy Issue Report It seems like `$request->header('X-PJAX-Container')` targeting `Illuminate\Http\Request::header()` can also be of type `array`; however, `Spatie\Pjax\Middleware\F...fPjax::filterResponse()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
36			->setUriHeader($response, $request)
37			->setVersionHeader($response, $request);
38
39			return $response;
40			}
41
42			/**
43			* @param \Illuminate\Http\Response $response
44			* @param string $container
45			*
46			* @return $this
47			*/
48			protected function filterResponse(Response $response, $container)
49			{
50			$crawler = $this->getCrawler($response);
51
52			$response->setContent(
53			$this->makeTitle($crawler).
54			$this->fetchContainer($crawler, $container)
55			);
56
57			return $this;
58			}
59
60			/**
61			* @param \Symfony\Component\DomCrawler\Crawler $crawler
62			*
63			* @return null\|string
64			*/
65			protected function makeTitle(Crawler $crawler)
66			{
67			$pageTitle = $crawler->filter('head > title');
68
69			if (!$pageTitle->count()) {
70			return;
71			}
72
73			return "<title>{$pageTitle->html()}</title>";
74			}
75
76			/**
77			* @param \Symfony\Component\DomCrawler\Crawler $crawler
78			* @param string $container
79			*
80			* @return string
81			*/
82			protected function fetchContainer(Crawler $crawler, $container)
83			{
84			$content = $crawler->filter($container);
85
86			if (!$content->count()) {
87			abort(422);
88			}
89
90			return $content->html();
91			}
92
93			/**
94			* @param \Illuminate\Http\Response $response
95			* @param \Illuminate\Http\Request $request
96			*
97			* @return $this
98			*/
99			protected function setUriHeader(Response $response, Request $request)
100			{
101			$response->header('X-PJAX-URL', $request->getRequestUri());
102
103			return $this;
104			}
105
106			/**
107			* @param \Illuminate\Http\Response $response
108			* @param \Illuminate\Http\Request $request
109			*
110			* @return $this
111			*/
112			protected function setVersionHeader(Response $response, Request $request)
			0 ignored issues – show Unused Code introduced 2016-01-11 17:49 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
113			{
114			$crawler = $this->getCrawler($this->createReponseWithLowerCaseContent($response));
115			$node = $crawler->filter('head > meta[http-equiv="x-pjax-version"]');
116
117			if ($node->count()) {
118			$response->header('x-pjax-version', $node->attr('content'));
119			}
120
121			return $this;
122			}
123
124			/**
125			* Get the DomCrawler instance.
126			*
127			* @param \Illuminate\Http\Response $response
128			*
129			* @return \Symfony\Component\DomCrawler\Crawler
130			*/
131			protected function getCrawler(Response $response)
132			{
133			if ($this->crawler) {
134			return $this->crawler;
135			}
136
137			return $this->crawler = new Crawler($response->getContent());
138			}
139
140			/**
141			* Make the content of the given response lowercase.
142			*
143			* @param \Illuminate\Http\Response $response
144			*
145			* @return \Illuminate\Http\Response
146			*/
147			protected function createReponseWithLowerCaseContent(Response $response)
148			{
149			$lowercaseContent = strtolower($response->getContent());
150
151			return Response::create($lowercaseContent);
152			}
153			}
154

spatie / laravel-pjax

GitHub Access Token became invalid

Push — master ( 5f151d...30e150 )

FilterIfPjax::setVersionHeader() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like