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; |
|
|
|
|
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( |
|
|
|
|
52
|
|
|
$this->hasher->getHashFor($request), |
53
|
|
|
$response, |
54
|
|
|
($lifetimeInMinutes) ? intval($lifetimeInMinutes) : $this->cacheProfile->cacheRequestUntil($request) |
55
|
|
|
); |
56
|
|
|
|
57
|
|
|
return $response; |
58
|
|
|
} |
59
|
|
|
|
60
|
|
|
public function hasBeenCached(Request $request): bool |
61
|
|
|
{ |
62
|
|
|
return config('responsecache.enabled') |
63
|
|
|
? $this->cache->has($this->hasher->getHashFor($request)) |
|
|
|
|
64
|
|
|
: false; |
65
|
|
|
} |
66
|
|
|
|
67
|
|
|
public function getCachedResponseFor(Request $request): Response |
68
|
|
|
{ |
69
|
|
|
return $this->cache->get($this->hasher->getHashFor($request)); |
|
|
|
|
70
|
|
|
} |
71
|
|
|
|
72
|
|
|
/** |
73
|
|
|
* @deprecated Use the new clear method, this is just an alias. |
74
|
|
|
*/ |
75
|
|
|
public function flush() |
76
|
|
|
{ |
77
|
|
|
$this->clear(); |
78
|
|
|
} |
79
|
|
|
|
80
|
|
|
public function clear() |
81
|
|
|
{ |
82
|
|
|
$this->cache->clear(); |
83
|
|
|
} |
84
|
|
|
|
85
|
|
|
protected function addCachedHeader(Response $response): Response |
86
|
|
|
{ |
87
|
|
|
$clonedResponse = clone $response; |
88
|
|
|
|
89
|
|
|
$clonedResponse->headers->set('laravel-responsecache', 'cached on '.date('Y-m-d H:i:s')); |
90
|
|
|
|
91
|
|
|
return $clonedResponse; |
92
|
|
|
} |
93
|
|
|
} |
94
|
|
|
|
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..