FilterIfPjax::requiredFilter() - Code Metrics - Inspection of "[WIP] Make extending easier" - spatie/laravel-pjax - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#7)

unknown

created 2016-01-26 15:19 UTC

FilterIfPjax::requiredFilter() A

↳ Parent: FilterIfPjax

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	8
rs	9.4285
cc	1
eloc	5
nc	1
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;
    
    /**
     * Whether the required filters have been applied.
     *
     * @var bool
     */
    private $filtered = false;

    /**
     * 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->filter($response, $request, function($response, $request) {
            $this->requiredFilter($response, $request);
        });

        if (! $this->isFiltered()) {
            $this->requiredFilter($response, $request);
        }

        return $response;
    }
    
    /**
     * Easily add extra filters for PJAX requests.
     *
     * @param \Illuminate\Http\Response $response
     * @param \Illuminate\Http\Request  $request
     */
    protected function filter(Response $response, Request $request, Closure $filter)
    {
        $filter($response, $request);
    }

    /**
     * Run the required filters.
     *
     * @return $this
     */
    private function requiredFilter(Response $response, Request $request)
    {
        $this->filterResponse($response, $request->header('X-PJAX-Container'))

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

        $this->filtered = true;
    }
    
    /**
     * Checks if the default PJAX filters have been applied.
     *
     * @return bool
     */
    private function isFiltered()
    {
        return $this->filtered;
    }

    /**
     * @param \Illuminate\Http\Response $response
     * @param string                    $container
     *
     * @return $this
     */
    private 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
     */
    private 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
     */
    private 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
     */
    private 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
     */
    private function setVersionHeader(Response $response, Request $request)

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

        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());
    }
}


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			* Whether the required filters have been applied.
21			*
22			* @var bool
23			*/
24			private $filtered = false;
25
26			/**
27			* Handle an incoming request.
28			*
29			* @param \Illuminate\Http\Request $request
30			* @param \Closure $next
31			*
32			* @return mixed
33			*/
34			public function handle(Request $request, Closure $next)
35			{
36			$response = $next($request);
37
38			if (!$request->pjax() \|\| $response->isRedirection()) {
39			return $response;
40			}
41
42			$this->filter($response, $request, function($response, $request) {
43			$this->requiredFilter($response, $request);
44			});
45
46			if (! $this->isFiltered()) {
47			$this->requiredFilter($response, $request);
48			}
49
50			return $response;
51			}
52
53			/**
54			* Easily add extra filters for PJAX requests.
55			*
56			* @param \Illuminate\Http\Response $response
57			* @param \Illuminate\Http\Request $request
58			*/
59			protected function filter(Response $response, Request $request, Closure $filter)
60			{
61			$filter($response, $request);
62			}
63
64			/**
65			* Run the required filters.
66			*
67			* @return $this
68			*/
69			private function requiredFilter(Response $response, Request $request)
70			{
71			$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...
72			->setUriHeader($response, $request)
73			->setVersionHeader($response, $request);
74
75			$this->filtered = true;
76			}
77
78			/**
79			* Checks if the default PJAX filters have been applied.
80			*
81			* @return bool
82			*/
83			private function isFiltered()
84			{
85			return $this->filtered;
86			}
87
88			/**
89			* @param \Illuminate\Http\Response $response
90			* @param string $container
91			*
92			* @return $this
93			*/
94			private function filterResponse(Response $response, $container)
95			{
96			$crawler = $this->getCrawler($response);
97
98			$response->setContent(
99			$this->makeTitle($crawler).
100			$this->fetchContainer($crawler, $container)
101			);
102
103			return $this;
104			}
105
106			/**
107			* @param \Symfony\Component\DomCrawler\Crawler $crawler
108			*
109			* @return null\|string
110			*/
111			private function makeTitle(Crawler $crawler)
112			{
113			$pageTitle = $crawler->filter('head > title');
114
115			if (!$pageTitle->count()) {
116			return;
117			}
118
119			return "<title>{$pageTitle->html()}</title>";
120			}
121
122			/**
123			* @param \Symfony\Component\DomCrawler\Crawler $crawler
124			* @param string $container
125			*
126			* @return string
127			*/
128			private function fetchContainer(Crawler $crawler, $container)
129			{
130			$content = $crawler->filter($container);
131
132			if (!$content->count()) {
133			abort(422);
134			}
135
136			return $content->html();
137			}
138
139			/**
140			* @param \Illuminate\Http\Response $response
141			* @param \Illuminate\Http\Request $request
142			*/
143			private function setUriHeader(Response $response, Request $request)
144			{
145			$response->header('X-PJAX-URL', $request->getRequestUri());
146
147			return $this;
148			}
149
150			/**
151			* @param \Illuminate\Http\Response $response
152			* @param \Illuminate\Http\Request $request
153			*/
154			private function setVersionHeader(Response $response, Request $request)
			0 ignored issues – show Unused Code introduced 2016-01-26 15:42 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...
155			{
156			$crawler = $this->getCrawler($response);
157			$node = $crawler->filter('head > meta[http-equiv]');
158
159			if ($node->count()) {
160			$response->header('X-PJAX-Version', $node->attr('content'));
161			}
162
163			return $this;
164			}
165
166			/**
167			* Get the DomCrawler instance.
168			*
169			* @param \Illuminate\Http\Response $response
170			*
171			* @return \Symfony\Component\DomCrawler\Crawler
172			*/
173			protected function getCrawler(Response $response)
174			{
175			if ($this->crawler) {
176			return $this->crawler;
177			}
178
179			return $this->crawler = new Crawler($response->getContent());
180			}
181			}
182

spatie / laravel-pjax

GitHub Access Token became invalid

Pull Request — master (#7)

FilterIfPjax::requiredFilter() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like