CacheManager::invalidateRoute() - Code Metrics - Inspection of "Simplify test dir config" - FriendsOfSymfony/FOSHttpCacheBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d2f8aa...3f97e5 )

by David de

created 2017-02-01 21:56 UTC

CacheManager::invalidateRoute() A

↳ Parent: CacheManager

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php

/*
 * This file is part of the FOSHttpCacheBundle package.
 *
 * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FOS\HttpCacheBundle;

use FOS\HttpCache\CacheInvalidator;
use FOS\HttpCache\ProxyClient\ProxyClient;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;

/**
 * The CacheManager is a CacheInvalidator but adds symfony Route support and
 * response tagging to the framework agnostic FOS\HttpCache\CacheInvalidator.
 *
 * @author David de Boer <[email protected]>
 */
class CacheManager extends CacheInvalidator
{
    /**
     * @var UrlGeneratorInterface
     */
    private $urlGenerator;

    /**
     * What type of urls to generate.
     *
     * @var bool|string
     */
    private $generateUrlType = UrlGeneratorInterface::ABSOLUTE_PATH;

    /**
     * Constructor.
     *
     * @param ProxyClient           $cache        HTTP cache proxy client
     * @param UrlGeneratorInterface $urlGenerator Symfony route generator
     */
    public function __construct(ProxyClient $cache, UrlGeneratorInterface $urlGenerator)
    {
        parent::__construct($cache);
        $this->urlGenerator = $urlGenerator;
    }

    /**
     * Set what type of URLs to generate.
     *
     * @param bool|string $generateUrlType One of the constants in UrlGeneratorInterface
     */
    public function setGenerateUrlType($generateUrlType)
    {
        $this->generateUrlType = $generateUrlType;
    }

    /**
     * Invalidate a route.
     *
     * @param string $name       Route name
     * @param array  $parameters Route parameters (optional)
     * @param array  $headers    Extra HTTP headers to send to the caching proxy (optional)
     *
     * @return $this
     */
    public function invalidateRoute($name, array $parameters = [], array $headers = [])
    {
        $this->invalidatePath($this->urlGenerator->generate($name, $parameters, $this->generateUrlType), $headers);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return $this;
    }

    /**
     * Refresh a route.
     *
     * @param string $route      Route name
     * @param array  $parameters Route parameters (optional)
     * @param array  $headers    Extra HTTP headers to send to the caching proxy (optional)
     *
     * @return $this
     */
    public function refreshRoute($route, array $parameters = [], array $headers = [])
    {
        $this->refreshPath($this->urlGenerator->generate($route, $parameters, $this->generateUrlType), $headers);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return $this;
    }
}


1		<?php
2
3		/*
4		* This file is part of the FOSHttpCacheBundle package.
5		*
6		* (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace FOS\HttpCacheBundle;
13
14		use FOS\HttpCache\CacheInvalidator;
15		use FOS\HttpCache\ProxyClient\ProxyClient;
16		use Symfony\Component\HttpFoundation\Response;
17		use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
18
19		/**
20		* The CacheManager is a CacheInvalidator but adds symfony Route support and
21		* response tagging to the framework agnostic FOS\HttpCache\CacheInvalidator.
22		*
23		* @author David de Boer <[email protected]>
24		*/
25		class CacheManager extends CacheInvalidator
26		{
27		/**
28		* @var UrlGeneratorInterface
29		*/
30		private $urlGenerator;
31
32		/**
33		* What type of urls to generate.
34		*
35		* @var bool\|string
36		*/
37		private $generateUrlType = UrlGeneratorInterface::ABSOLUTE_PATH;
38
39		/**
40		* Constructor.
41		*
42		* @param ProxyClient $cache HTTP cache proxy client
43		* @param UrlGeneratorInterface $urlGenerator Symfony route generator
44		*/
45	9	public function __construct(ProxyClient $cache, UrlGeneratorInterface $urlGenerator)
46		{
47	9	parent::__construct($cache);
48	9	$this->urlGenerator = $urlGenerator;
49	9	}
50
51		/**
52		* Set what type of URLs to generate.
53		*
54		* @param bool\|string $generateUrlType One of the constants in UrlGeneratorInterface
55		*/
56	7	public function setGenerateUrlType($generateUrlType)
57		{
58	7	$this->generateUrlType = $generateUrlType;
59	7	}
60
61		/**
62		* Invalidate a route.
63		*
64		* @param string $name Route name
65		* @param array $parameters Route parameters (optional)
66		* @param array $headers Extra HTTP headers to send to the caching proxy (optional)
67		*
68		* @return $this
69		*/
70	1	public function invalidateRoute($name, array $parameters = [], array $headers = [])
71		{
72	1	$this->invalidatePath($this->urlGenerator->generate($name, $parameters, $this->generateUrlType), $headers);
		0 ignored issues – show Documentation introduced 2016-12-06 00:07 UTC by Report Bug Copy Issue Report `$this->generateUrlType` is of type `boolean\|string`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
73
74	1	return $this;
75		}
76
77		/**
78		* Refresh a route.
79		*
80		* @param string $route Route name
81		* @param array $parameters Route parameters (optional)
82		* @param array $headers Extra HTTP headers to send to the caching proxy (optional)
83		*
84		* @return $this
85		*/
86	1	public function refreshRoute($route, array $parameters = [], array $headers = [])
87		{
88	1	$this->refreshPath($this->urlGenerator->generate($route, $parameters, $this->generateUrlType), $headers);
		0 ignored issues – show Documentation introduced 2016-12-06 00:07 UTC by Report Bug Copy Issue Report `$this->generateUrlType` is of type `boolean\|string`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
89
90	1	return $this;
91		}
92		}
93

FriendsOfSymfony / FOSHttpCacheBundle

Push — master ( d2f8aa...3f97e5 )

CacheManager::invalidateRoute() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like