biurad /
php-cache
| Total Complexity | 56 |
| Total Lines | 357 |
| 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) |
||
| 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 |
||
| 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) |
||
| 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 | public function save($key, ?callable $callback = null, ?float $beta = null) |
||
| 166 | { |
||
| 167 | $key = $this->generateKey($key); |
||
| 168 | |||
| 169 | if (null === $callback) { |
||
| 170 | $this->doDelete($key); |
||
| 171 | |||
| 172 | return false; |
||
| 173 | } |
||
| 174 | |||
| 175 | if (0 > $beta = $beta ?? 1.0) { |
||
| 176 | throw new InvalidArgumentException( |
||
| 177 | \sprintf( |
||
| 178 | 'Argument "$beta" provided to "%s::get()" must be a positive number, %f given.', |
||
| 179 | static::class, |
||
| 180 | $beta |
||
| 181 | ) |
||
| 182 | ); |
||
| 183 | } |
||
| 184 | |||
| 185 | static $setExpired; |
||
| 186 | |||
| 187 | $setExpired = Closure::bind( |
||
| 188 | static function (CacheItem $item) { |
||
| 189 | if (null === $item->expiry) { |
||
| 190 | return null; |
||
| 191 | } |
||
| 192 | |||
| 193 | return (int) (0.1 + $item->expiry - \microtime(true)); |
||
| 194 | }, |
||
| 195 | null, |
||
| 196 | CacheItem::class |
||
| 197 | ); |
||
| 198 | |||
| 199 | if ($this->storage instanceof PhpCachePool) { |
||
| 200 | $setExpired = static function (PhpCacheItem $item) { |
||
| 201 | return $item->getExpirationTimestamp(); |
||
| 202 | }; |
||
| 203 | } |
||
| 204 | |||
| 205 | $callback = function (CacheItemInterface $item, bool $save) use ($key, $callback) { |
||
| 206 | // don't wrap nor save recursive calls |
||
| 207 | if (isset($this->computing[$key])) { |
||
| 208 | $value = $callback(...[&$item, &$save]); |
||
| 209 | $save = false; |
||
| 210 | |||
| 211 | return $value; |
||
| 212 | } |
||
| 213 | |||
| 214 | $this->computing[$key] = $key; |
||
| 215 | |||
| 216 | try { |
||
| 217 | return $value = $callback(...[&$item, &$save]); |
||
| 218 | } catch (Throwable $e) { |
||
| 219 | $this->doDelete($key); |
||
| 220 | |||
| 221 | throw $e; |
||
| 222 | } finally { |
||
| 223 | unset($this->computing[$key]); |
||
| 224 | } |
||
| 225 | }; |
||
| 226 | |||
| 227 | return $this->doSave($this->storage, $key, $callback, $setExpired, $beta); |
||
| 228 | } |
||
| 229 | |||
| 230 | /** |
||
| 231 | * {@inheritdoc} |
||
| 232 | */ |
||
| 233 | public function delete($key): void |
||
| 234 | { |
||
| 235 | $this->save($key, null); |
||
| 236 | } |
||
| 237 | |||
| 238 | /** |
||
| 239 | * {@inheritdoc} |
||
| 240 | */ |
||
| 241 | public function call(callable $callback) |
||
| 242 | { |
||
| 243 | $key = \func_get_args(); |
||
| 244 | |||
| 245 | if (\is_array($callback) && \is_object($callback[0])) { |
||
| 246 | $key[0][0] = \get_class($callback[0]); |
||
| 247 | } |
||
| 248 | |||
| 249 | return $this->load($key, function (CacheItemInterface $item, bool $save) use ($callback, $key) { |
||
| 250 | $dependencies = \array_merge(\array_slice($key, 1), [&$item, &$save]); |
||
| 251 | |||
| 252 | return $callback(...$dependencies); |
||
| 253 | }); |
||
| 254 | } |
||
| 255 | |||
| 256 | /** |
||
| 257 | * {@inheritdoc} |
||
| 258 | */ |
||
| 259 | public function wrap(callable $callback, ?float $beta = null): callable |
||
| 260 | { |
||
| 261 | return function () use ($callback, $beta) { |
||
| 262 | $key = [$callback, \func_get_args()]; |
||
| 263 | |||
| 264 | if (\is_array($callback) && \is_object($callback[0])) { |
||
| 265 | $key[0][0] = \get_class(\current($callback)); |
||
| 266 | } |
||
| 267 | |||
| 268 | if (null === $data = $this->load($key)) { |
||
| 269 | $data = $this->save( |
||
| 270 | $key, |
||
| 271 | function (CacheItemInterface $item, bool $save) use ($callback, $key) { |
||
| 272 | $dependencies = \array_merge($key[1], [&$item, &$save]); |
||
| 273 | |||
| 274 | return $callback(...$dependencies); |
||
| 275 | }, |
||
| 276 | $beta |
||
| 277 | ); |
||
| 278 | } |
||
| 279 | |||
| 280 | return $data; |
||
| 281 | }; |
||
| 282 | } |
||
| 283 | |||
| 284 | /** |
||
| 285 | * {@inheritdoc} |
||
| 286 | */ |
||
| 287 | public function start($key): ?OutputHelper |
||
| 288 | { |
||
| 289 | $data = $this->load($key); |
||
| 290 | |||
| 291 | if (null === $data) { |
||
| 292 | return new OutputHelper($this, $key); |
||
| 293 | } |
||
| 294 | echo $data; |
||
| 295 | |||
| 296 | return null; |
||
| 297 | } |
||
| 298 | |||
| 299 | /** |
||
| 300 | * Generates internal cache key. |
||
| 301 | * |
||
| 302 | * @param mixed $key |
||
| 303 | * |
||
| 304 | * @return string |
||
| 305 | */ |
||
| 306 | protected function generateKey($key): string |
||
| 315 | } |
||
| 316 | |||
| 317 | /** |
||
| 318 | * Save cache item. |
||
| 319 | * |
||
| 320 | * @param CacheInterface|CacheItemPoolInterface $storage |
||
| 321 | * @param string $key |
||
| 322 | * @param Closure $callback |
||
| 323 | * @param Closure $setExpired |
||
| 324 | * @param null|float $beta |
||
| 325 | * |
||
| 326 | * @return mixed The corresponding values found in the cache |
||
| 327 | */ |
||
| 328 | protected function doSave($storage, string $key, Closure $callback, Closure $setExpired, ?float $beta) |
||
| 329 | { |
||
| 330 | if ($storage instanceof CacheItemPoolInterface) { |
||
| 331 | $item = $this->storage->getItem($key); |
||
| 332 | |||
| 333 | if (!$item->isHit() || \INF === $beta) { |
||
| 334 | $save = true; |
||
| 335 | $result = $callback(...[$item, $save]); |
||
| 336 | |||
| 337 | if (true === $save) { |
||
| 338 | if (!$result instanceof CacheItemInterface) { |
||
| 339 | $item->set($result); |
||
| 340 | $this->storage->save($item); |
||
| 341 | } else { |
||
| 342 | $this->storage->save($result); |
||
| 343 | } |
||
| 344 | } |
||
| 345 | } |
||
| 346 | |||
| 347 | return $item->get(); |
||
| 348 | } |
||
| 349 | |||
| 350 | $save = true; |
||
| 351 | $item = $storage instanceof PhpCachePool ? new PhpCacheItem($key) : new CacheItem(); |
||
| 352 | $result = $callback(...[$item, $save]); |
||
| 353 | |||
| 354 | if ($result instanceof CacheItemInterface) { |
||
| 355 | $result = $result->get(); |
||
| 356 | } |
||
| 357 | |||
| 358 | $storage->set($key, $result, $setExpired($item)); |
||
| 359 | |||
| 360 | return $result; |
||
| 361 | } |
||
| 362 | |||
| 363 | /** |
||
| 364 | * Fetch cache item. |
||
| 365 | * |
||
| 366 | * @param array|string $id The cache identifier to fetch |
||
| 367 | * |
||
| 368 | * @return mixed The corresponding values found in the cache |
||
| 369 | */ |
||
| 370 | protected function doFetch($ids, bool $multiple = false) |
||
| 371 | { |
||
| 372 | if ($this->storage instanceof CacheItemPoolInterface) { |
||
| 373 | return !$multiple ? $this->storage->getItem($ids) : $this->storage->getItems($ids); |
||
| 374 | } |
||
| 375 | |||
| 376 | return !$multiple ? $this->storage->get($ids) : $this->storage->getMultiple($ids, new stdClass()); |
||
| 377 | } |
||
| 378 | |||
| 379 | /** |
||
| 380 | * Remove an item from cache. |
||
| 381 | * |
||
| 382 | * @param string $id An identifier that should be removed from cache |
||
| 383 | * |
||
| 384 | * @return bool True if the items were successfully removed, false otherwise |
||
| 385 | */ |
||
| 386 | protected function doDelete(string $id) |
||
| 393 | } |
||
| 394 | } |
||
| 395 |
Loading history...