ResponseCache::cacheResponse() - Code Metrics - Inspection of "Remove extra comma from ResponseCache class" - spatie/laravel-responsecache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#217)

unknown

created 2019-05-22 20:58 UTC

ResponseCache::cacheResponse() A

↳ Parent: ResponseCache

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	18
rs	9.6666
c	0
b	0
f	0
cc	3
nc	4
nop	3

<?php

namespace Spatie\ResponseCache;

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

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

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

    /** @var \Spatie\ResponseCache\CacheProfiles\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, $lifetimeInSeconds = null): Response
    {
        if (config('responsecache.add_cache_time_header')) {
            $response = $this->addCachedHeader($response);
        }

        $lifetimeInSeconds = $lifetimeInSeconds
            ? (int)$lifetimeInSeconds
            : $this->cacheProfile->cacheRequestUntil($request);

        $this->cache->put(

            $this->hasher->getHashFor($request),
            $response,
            $lifetimeInSeconds
        );

        return $response;
    }

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

            : false;
    }

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

    }

    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
     *
     * @return \Spatie\ResponseCache\ResponseCache
     */
    public function forget($uris): self
    {
        $uris = is_array($uris) ? $uris : func_get_args();

        collect($uris)->each(function ($uri) {
            $request = Request::create(url($uri));

            $hash = $this->hasher->getHashFor($request);

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

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

        return $this;
    }
}


1			<?php
2
3			namespace Spatie\ResponseCache;
4
5			use Illuminate\Http\Request;
6			use Spatie\ResponseCache\Hasher\DefaultHasher;
7			use Spatie\ResponseCache\Hasher\RequestHasher;
8			use Symfony\Component\HttpFoundation\Response;
9			use Spatie\ResponseCache\CacheProfiles\CacheProfile;
10
11			class ResponseCache
12			{
13			/** @var \Spatie\ResponseCache\ResponseCache */
14			protected $cache;
15
16			/** @var RequestHasher */
17			protected $hasher;
18
19			/** @var \Spatie\ResponseCache\CacheProfiles\CacheProfile */
20			protected $cacheProfile;
21
22			public function __construct(ResponseCacheRepository $cache, RequestHasher $hasher, CacheProfile $cacheProfile)
23			{
24			$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...
25			$this->hasher = $hasher;
26			$this->cacheProfile = $cacheProfile;
27			}
28
29			public function enabled(Request $request): bool
30			{
31			return $this->cacheProfile->enabled($request);
32			}
33
34			public function shouldCache(Request $request, Response $response): bool
35			{
36			if ($request->attributes->has('responsecache.doNotCache')) {
37			return false;
38			}
39
40			if (! $this->cacheProfile->shouldCacheRequest($request)) {
41			return false;
42			}
43
44			return $this->cacheProfile->shouldCacheResponse($response);
45			}
46
47			public function cacheResponse(Request $request, Response $response, $lifetimeInSeconds = null): Response
48			{
49			if (config('responsecache.add_cache_time_header')) {
50			$response = $this->addCachedHeader($response);
51			}
52
53			$lifetimeInSeconds = $lifetimeInSeconds
54			? (int)$lifetimeInSeconds
55			: $this->cacheProfile->cacheRequestUntil($request);
56
57			$this->cache->put(
			0 ignored issues – show Bug introduced 2019-05-22 20:59 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...
58			$this->hasher->getHashFor($request),
59			$response,
60			$lifetimeInSeconds
61			);
62
63			return $response;
64			}
65
66			public function hasBeenCached(Request $request): bool
67			{
68			return config('responsecache.enabled')
69			? $this->cache->has($this->hasher->getHashFor($request))
			0 ignored issues – show Bug introduced 2015-12-22 20:42 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...
70			: false;
71			}
72
73			public function getCachedResponseFor(Request $request): Response
74			{
75			return $this->cache->get($this->hasher->getHashFor($request));
			0 ignored issues – show Bug introduced 2015-12-22 20:42 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...
76			}
77
78			public function clear()
79			{
80			$this->cache->clear();
81			}
82
83			protected function addCachedHeader(Response $response): Response
84			{
85			$clonedResponse = clone $response;
86
87			$clonedResponse->headers->set('laravel-responsecache', 'cached on '.date('Y-m-d H:i:s'));
88
89			return $clonedResponse;
90			}
91
92			/**
93			* @param string\|array $uris
94			*
95			* @return \Spatie\ResponseCache\ResponseCache
96			*/
97			public function forget($uris): self
98			{
99			$uris = is_array($uris) ? $uris : func_get_args();
100
101			collect($uris)->each(function ($uri) {
102			$request = Request::create(url($uri));
			0 ignored issues – show Bug introduced 2019-05-10 13:21 UTC by Report Bug Copy Issue Report It seems like `url($uri)` targeting `url()` can also be of type `object<Illuminate\Contracts\Routing\UrlGenerator>`; however, `Symfony\Component\HttpFoundation\Request::create()` 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...
103			$hash = $this->hasher->getHashFor($request);
104
105			if ($this->cache->has($hash)) {
			0 ignored issues – show Bug introduced 2018-02-25 22:16 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...
106			$this->cache->forget($hash);
107			}
108			});
109
110			return $this;
111			}
112			}
113

spatie / laravel-responsecache

GitHub Access Token became invalid

Pull Request — master (#217)

ResponseCache::cacheResponse() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like