ResponseCache::forgetByPrefix() - Code Metrics - Inspection of "It makes possible to delete all prefix based cache..." - spatie/laravel-responsecache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#153)

unknown

created 2018-12-26 11:23 UTC

ResponseCache::forgetByPrefix() A

↳ Parent: ResponseCache

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

namespace Spatie\ResponseCache;

use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;
use Spatie\ResponseCache\CacheProfiles\CacheProfile;

class ResponseCache
{
    /** @var ResponseCache */
    protected $cache;

    /** @var RequestHasher */
    protected $hasher;

    /** @var CacheProfile */
    protected $cacheProfile;

    public function __construct(ResponseCacheRepository $cache, RequestHasher $hasher, CacheProfile $cacheProfile)
    {
        $this->cache = $cache;

        $this->hasher = $hasher;
        $this->cacheProfile = $cacheProfile;
    }

    public function enabled(Request $request): bool
    {
        return $this->cacheProfile->enabled($request);
    }

    public function shouldCache(Request $request, Response $response): bool
    {
        if ($request->attributes->has('responsecache.doNotCache')) {
            return false;
        }

        if (! $this->cacheProfile->shouldCacheRequest($request)) {
            return false;
        }

        return $this->cacheProfile->shouldCacheResponse($response);
    }

    public function cacheResponse(Request $request, Response $response, $lifetimeInMinutes = null): Response
    {
        if (config('responsecache.add_cache_time_header')) {
            $response = $this->addCachedHeader($response);
        }

        $this->cache->put(

        $this->cacheProfile->cacheNameSuffix($request),
        $this->hasher->getHashFor($request),
            $response,
            ($lifetimeInMinutes) ? intval($lifetimeInMinutes) : $this->cacheProfile->cacheRequestUntil($request)
        );

        return $response;
    }

    public function hasBeenCached(Request $request): bool
    {
        return config('responsecache.enabled')
            ? $this->cache->has($this->hasher->getHashFor($request), $this->cacheProfile->cacheNameSuffix($request))

            : false;
    }

    public function getCachedResponseFor(Request $request): Response
    {
        return $this->cache->get($this->hasher->getHashFor($request), $this->cacheProfile->cacheNameSuffix($request));

    }

    /**
     * @deprecated Use the new clear method, this is just an alias.
     */
    public function flush()
    {
        $this->clear();
    }

    public function clear()
    {
        $this->cache->clear();
    }

    protected function addCachedHeader(Response $response): Response
    {
        $clonedResponse = clone $response;

        $clonedResponse->headers->set('laravel-responsecache', 'cached on '.date('Y-m-d H:i:s'));

        return $clonedResponse;
    }

    /**
     * @param string|array $uris
     */
    public function forget($uris): self
    {
        $uris = is_array($uris) ? $uris : func_get_args();

        collect($uris)->each(function ($uri) {
            $request = Request::create($uri);
            $hash = $this->hasher->getHashFor($request);
            $prefix = $this->cacheProfile->cacheNameSuffix($request);

            if ($this->cache->has($hash, $prefix)) {

                $this->cache->forget($hash, $prefix);
            }
        });

        return $this;
    }

    /**
     * @param string|array $uris
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function forgetByPrefix($prefix): self
    {
       \Cache::tags(['responsecache', $prefix])->flush();

        return $this;
    }
}


1			<?php
2
3			namespace Spatie\ResponseCache;
4
5			use Illuminate\Http\Request;
6			use Symfony\Component\HttpFoundation\Response;
7			use Spatie\ResponseCache\CacheProfiles\CacheProfile;
8
9			class ResponseCache
10			{
11			/** @var ResponseCache */
12			protected $cache;
13
14			/** @var RequestHasher */
15			protected $hasher;
16
17			/** @var CacheProfile */
18			protected $cacheProfile;
19
20			public function __construct(ResponseCacheRepository $cache, RequestHasher $hasher, CacheProfile $cacheProfile)
21			{
22			$this->cache = $cache;
			0 ignored issues – show Documentation Bug introduced 2015-12-22 20:42 UTC by Report Bug Copy Issue Report It seems like `$cache` of type `object<Spatie\ResponseCa...esponseCacheRepository>` is incompatible with the declared type `object<Spatie\ResponseCache\ResponseCache>` of property `$cache`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
23			$this->hasher = $hasher;
24			$this->cacheProfile = $cacheProfile;
25			}
26
27			public function enabled(Request $request): bool
28			{
29			return $this->cacheProfile->enabled($request);
30			}
31
32			public function shouldCache(Request $request, Response $response): bool
33			{
34			if ($request->attributes->has('responsecache.doNotCache')) {
35			return false;
36			}
37
38			if (! $this->cacheProfile->shouldCacheRequest($request)) {
39			return false;
40			}
41
42			return $this->cacheProfile->shouldCacheResponse($response);
43			}
44
45			public function cacheResponse(Request $request, Response $response, $lifetimeInMinutes = null): Response
46			{
47			if (config('responsecache.add_cache_time_header')) {
48			$response = $this->addCachedHeader($response);
49			}
50
51			$this->cache->put(
			0 ignored issues – show Bug introduced 2017-03-16 09:10 UTC by Report Bug Copy Issue Report The method `put()` does not seem to exist on `object<Spatie\ResponseCache\ResponseCache>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
52			$this->cacheProfile->cacheNameSuffix($request),
53			$this->hasher->getHashFor($request),
54			$response,
55			($lifetimeInMinutes) ? intval($lifetimeInMinutes) : $this->cacheProfile->cacheRequestUntil($request)
56			);
57
58			return $response;
59			}
60
61			public function hasBeenCached(Request $request): bool
62			{
63			return config('responsecache.enabled')
64			? $this->cache->has($this->hasher->getHashFor($request), $this->cacheProfile->cacheNameSuffix($request))
			0 ignored issues – show Bug introduced 2018-12-26 11:24 UTC by Report Bug Copy Issue Report The method `has()` does not seem to exist on `object<Spatie\ResponseCache\ResponseCache>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
65			: false;
66			}
67
68			public function getCachedResponseFor(Request $request): Response
69			{
70			return $this->cache->get($this->hasher->getHashFor($request), $this->cacheProfile->cacheNameSuffix($request));
			0 ignored issues – show Bug introduced 2018-12-26 11:24 UTC by Report Bug Copy Issue Report The method `get()` does not seem to exist on `object<Spatie\ResponseCache\ResponseCache>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
71			}
72
73			/**
74			* @deprecated Use the new clear method, this is just an alias.
75			*/
76			public function flush()
77			{
78			$this->clear();
79			}
80
81			public function clear()
82			{
83			$this->cache->clear();
84			}
85
86			protected function addCachedHeader(Response $response): Response
87			{
88			$clonedResponse = clone $response;
89
90			$clonedResponse->headers->set('laravel-responsecache', 'cached on '.date('Y-m-d H:i:s'));
91
92			return $clonedResponse;
93			}
94
95			/**
96			* @param string\|array $uris
97			*/
98			public function forget($uris): self
99			{
100			$uris = is_array($uris) ? $uris : func_get_args();
101
102			collect($uris)->each(function ($uri) {
103			$request = Request::create($uri);
104			$hash = $this->hasher->getHashFor($request);
105			$prefix = $this->cacheProfile->cacheNameSuffix($request);
106
107			if ($this->cache->has($hash, $prefix)) {
			0 ignored issues – show Bug introduced 2018-12-26 11:24 UTC by Report Bug Copy Issue Report The method `has()` does not seem to exist on `object<Spatie\ResponseCache\ResponseCache>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
108			$this->cache->forget($hash, $prefix);
109			}
110			});
111
112			return $this;
113			}
114
115			/**
116			* @param string\|array $uris
			0 ignored issues – show Bug introduced 2018-12-26 11:24 UTC by Report Bug Copy Issue Report There is no parameter named `$uris`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
117			*/
118			public function forgetByPrefix($prefix): self
119			{
120			\Cache::tags(['responsecache', $prefix])->flush();
121
122			return $this;
123			}
124			}
125

spatie / laravel-responsecache

GitHub Access Token became invalid

Pull Request — master (#153)

ResponseCache::forgetByPrefix() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like