Total Complexity | 53 |
Total Lines | 345 |
Duplicated Lines | 0 % |
Changes | 0 |
Complex classes like FastCache often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use FastCache, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
36 | class FastCache implements FastCacheInterface |
||
37 | { |
||
38 | /** @internal */ |
||
39 | public const NAMESPACE_SEPARATOR = "\x00"; |
||
40 | |||
41 | public const NAMESPACE = 'CACHE_KEY[%s]'; |
||
42 | |||
43 | /** @var CacheInterface|CacheItemPoolInterface */ |
||
44 | private $storage; |
||
45 | |||
46 | /** @var string */ |
||
47 | private $namespace; |
||
48 | |||
49 | /** @var array<string,mixed> */ |
||
50 | private $computing = []; |
||
51 | |||
52 | /** |
||
53 | * @param CacheInterface|CacheItemPoolInterface $storage |
||
54 | * @param string $namespace |
||
55 | */ |
||
56 | final public function __construct($storage, string $namespace = self::NAMESPACE) |
||
57 | { |
||
58 | if ( |
||
59 | !($storage instanceof CacheInterface || $storage instanceof CacheItemPoolInterface) |
||
|
|||
60 | ) { |
||
61 | throw new CacheException('$storage can only implements psr-6 or psr-16 cache interface'); |
||
62 | } |
||
63 | |||
64 | $this->storage = $storage; |
||
65 | $this->namespace = $namespace . self::NAMESPACE_SEPARATOR; |
||
66 | } |
||
67 | |||
68 | /** |
||
69 | * {@inheritdoc} |
||
70 | */ |
||
71 | public function getStorage() |
||
72 | { |
||
73 | return $this->storage; |
||
74 | } |
||
75 | |||
76 | /** |
||
77 | * Returns cache namespace. |
||
78 | */ |
||
79 | public function getNamespace(): string |
||
80 | { |
||
81 | return \substr(\sprintf($this->namespace, ''), 0, -1); |
||
82 | } |
||
83 | |||
84 | /** |
||
85 | * {@inheritdoc} |
||
86 | */ |
||
87 | public function derive(string $namespace): FastCache |
||
88 | { |
||
89 | return new static($this->storage, $this->namespace . $namespace); |
||
90 | } |
||
91 | |||
92 | /** |
||
93 | * {@inheritdoc} |
||
94 | */ |
||
95 | public function load($key, callable $fallback = null, ?float $beta = null) |
||
96 | { |
||
97 | $data = $this->doFetch($this->generateKey($key)); |
||
98 | |||
99 | if ($data instanceof CacheItemInterface) { |
||
100 | $data = $data->isHit() ? $data->get() : null; |
||
101 | } |
||
102 | |||
103 | if (null === $data && null !== $fallback) { |
||
104 | return $this->save($key, $fallback, $beta); |
||
105 | } |
||
106 | |||
107 | return $data; |
||
108 | } |
||
109 | |||
110 | /** |
||
111 | * {@inheritDoc} |
||
112 | */ |
||
113 | public function bulkLoad(array $keys, callable $fallback = null, ?float $beta = null): array |
||
159 | ); |
||
160 | } |
||
161 | |||
162 | /** |
||
163 | * {@inheritdoc} |
||
164 | * |
||
165 | * @psalm-suppress InaccessibleProperty |
||
166 | */ |
||
167 | public function save($key, ?callable $callback = null, ?float $beta = null) |
||
168 | { |
||
169 | $key = $this->generateKey($key); |
||
170 | |||
171 | if (null === $callback) { |
||
172 | $this->doDelete($key); |
||
173 | |||
174 | return false; |
||
175 | } |
||
176 | |||
177 | if (0 > $beta = $beta ?? 1.0) { |
||
178 | throw new InvalidArgumentException( |
||
179 | \sprintf( |
||
180 | 'Argument "$beta" provided to "%s::get()" must be a positive number, %f given.', |
||
181 | static::class, |
||
182 | $beta |
||
183 | ) |
||
184 | ); |
||
185 | } |
||
186 | |||
187 | static $setExpired; |
||
188 | |||
189 | $setExpired = Closure::bind( |
||
190 | static function (CacheItem $item) { |
||
191 | if (null === $item->expiry) { |
||
192 | return null; |
||
193 | } |
||
194 | |||
195 | return (int) (0.1 + $item->expiry - \microtime(true)); |
||
196 | }, |
||
197 | null, |
||
198 | CacheItem::class |
||
199 | ); |
||
200 | |||
201 | if ($this->storage instanceof PhpCachePool) { |
||
202 | $setExpired = static function (PhpCacheItem $item) { |
||
203 | return $item->getExpirationTimestamp(); |
||
204 | }; |
||
205 | } |
||
206 | |||
207 | $callback = function (CacheItemInterface $item, bool $save) use ($key, $callback) { |
||
208 | // don't wrap nor save recursive calls |
||
209 | if (isset($this->computing[$key])) { |
||
210 | $value = $callback(...[&$item, &$save]); |
||
211 | $save = false; |
||
212 | |||
213 | return $value; |
||
214 | } |
||
215 | |||
216 | $this->computing[$key] = $key; |
||
217 | |||
218 | try { |
||
219 | return $value = $callback(...[&$item, &$save]); |
||
220 | } catch (Throwable $e) { |
||
221 | $this->doDelete($key); |
||
222 | |||
223 | throw $e; |
||
224 | } finally { |
||
225 | unset($this->computing[$key]); |
||
226 | } |
||
227 | }; |
||
228 | |||
229 | return $this->doSave($this->storage, $key, $callback, $setExpired, $beta); |
||
230 | } |
||
231 | |||
232 | /** |
||
233 | * {@inheritdoc} |
||
234 | */ |
||
235 | public function delete($key): void |
||
236 | { |
||
237 | $this->save($key, null); |
||
238 | } |
||
239 | |||
240 | /** |
||
241 | * {@inheritdoc} |
||
242 | */ |
||
243 | public function call(callable $callback, ?float $beta = null) |
||
259 | ); |
||
260 | } |
||
261 | |||
262 | /** |
||
263 | * {@inheritdoc} |
||
264 | */ |
||
265 | public function wrap(callable $callback, ?float $beta = null): callable |
||
266 | { |
||
267 | return function () use ($callback, $beta) { |
||
268 | return $this->call($callback, $beta); |
||
269 | }; |
||
270 | } |
||
271 | |||
272 | /** |
||
273 | * {@inheritdoc} |
||
274 | */ |
||
275 | public function start($key): ?OutputHelper |
||
285 | } |
||
286 | |||
287 | /** |
||
288 | * Generates internal cache key. |
||
289 | * |
||
290 | * @param mixed $key |
||
291 | * |
||
292 | * @return string |
||
293 | */ |
||
294 | protected function generateKey($key): string |
||
295 | { |
||
296 | if (\is_array($key) && \current($key) instanceof Closure) { |
||
297 | $key = \spl_object_id($key[0]); |
||
298 | } |
||
299 | |||
300 | $key = \md5(\is_scalar($key) ? (string) $key : \serialize($key)); |
||
301 | |||
302 | return \strpos($this->namespace, '%s') ? \sprintf($this->namespace, $key) : $this->namespace . $key; |
||
303 | } |
||
304 | |||
305 | /** |
||
306 | * Save cache item. |
||
307 | * |
||
308 | * @param CacheInterface|CacheItemPoolInterface $storage |
||
309 | * @param string $key |
||
310 | * @param Closure $callback |
||
311 | * @param Closure $setExpired |
||
312 | * @param null|float $beta |
||
313 | * |
||
314 | * @return mixed The corresponding values found in the cache |
||
315 | */ |
||
316 | protected function doSave($storage, string $key, Closure $callback, Closure $setExpired, ?float $beta) |
||
317 | { |
||
318 | if ($storage instanceof CacheItemPoolInterface) { |
||
319 | $item = $storage->getItem($key); |
||
320 | |||
321 | if (!$item->isHit() || \INF === $beta) { |
||
322 | $save = true; |
||
323 | $result = $callback(...[$item, $save]); |
||
324 | |||
325 | if (false !== $save) { |
||
326 | if (!$result instanceof CacheItemInterface) { |
||
327 | $item->set($result); |
||
328 | $storage->save($item); |
||
329 | } else { |
||
330 | $storage->save($result); |
||
331 | } |
||
332 | } |
||
333 | } |
||
334 | |||
335 | return $item->get(); |
||
336 | } |
||
337 | |||
338 | $save = true; |
||
339 | $item = $storage instanceof PhpCachePool ? new PhpCacheItem($key) : new CacheItem(); |
||
340 | $result = $callback(...[$item, $save]); |
||
341 | |||
342 | if ($result instanceof CacheItemInterface) { |
||
343 | $result = $result->get(); |
||
344 | } |
||
345 | |||
346 | $storage->set($key, $result, $setExpired($item)); |
||
347 | |||
348 | return $result; |
||
349 | } |
||
350 | |||
351 | /** |
||
352 | * Fetch cache item. |
||
353 | * |
||
354 | * @param string|string[] $ids The cache identifier to fetch |
||
355 | * |
||
356 | * @return mixed The corresponding values found in the cache |
||
357 | */ |
||
358 | protected function doFetch($ids) |
||
359 | { |
||
360 | if ($this->storage instanceof CacheItemPoolInterface) { |
||
361 | return !\is_array($ids) ? $this->storage->getItem($ids) : $this->storage->getItems($ids); |
||
362 | } |
||
363 | |||
364 | return !\is_array($ids) ? $this->storage->get($ids) : $this->storage->getMultiple($ids, new stdClass()); |
||
365 | } |
||
366 | |||
367 | /** |
||
368 | * Remove an item from cache. |
||
369 | * |
||
370 | * @param string $id An identifier that should be removed from cache |
||
371 | * |
||
372 | * @return bool True if the items were successfully removed, false otherwise |
||
373 | */ |
||
374 | protected function doDelete(string $id) |
||
381 | } |
||
382 | } |
||
383 |