<?php
declare(strict_types=1);
namespace DI\Definition\Source;
use DI\Definition\AutowireDefinition;
use DI\Definition\Definition;
use DI\Definition\ObjectDefinition;
/**
* Decorator that caches another definition source.
*
* @author Matthieu Napoli <[email protected]>
*/
class SourceCache implements DefinitionSource, MutableDefinitionSource
{
public const CACHE_KEY = 'php-di.definitions.';
public function __construct(
private DefinitionSource $cachedSource,
private string $cacheNamespace = '',
) {
}
public function getDefinition(string $name) : Definition|null
{
$definition = apcu_fetch($this->getCacheKey($name));
if ($definition === false) {
$definition = $this->cachedSource->getDefinition($name);
// Update the cache
if ($this->shouldBeCached($definition)) {
apcu_store($this->getCacheKey($name), $definition);
}
}
return $definition;
}
/**
* Used only for the compilation so we can skip the cache safely.
*/
public function getDefinitions() : array
{
return $this->cachedSource->getDefinitions();
}
public static function isSupported() : bool
{
return function_exists('apcu_fetch')
&& ini_get('apc.enabled')
&& ! ('cli' === \PHP_SAPI && ! ini_get('apc.enable_cli'));
}
public function getCacheKey(string $name) : string
{
return self::CACHE_KEY . $this->cacheNamespace . $name;
}
public function addDefinition(Definition $definition) : void
{
throw new \LogicException('You cannot set a definition at runtime on a container that has caching enabled. Doing so would risk caching the definition for the next execution, where it might be different. You can either put your definitions in a file, remove the cache or ->set() a raw value directly (PHP object, string, int, ...) instead of a PHP-DI definition.');
}
private function shouldBeCached(Definition $definition = null) : bool
{
return
// Cache missing definitions
($definition === null)
// Object definitions are used with `make()`
|| ($definition instanceof ObjectDefinition)
// Autowired definitions cannot be all compiled and are used with `make()`
|| ($definition instanceof AutowireDefinition);
}
}