AnnotationsCacheWarmer
class AnnotationsCacheWarmer extends AbstractPhpFileCacheWarmer
Warms up annotation caches for classes found in composer's autoload class map and declared in DI bundle extensions using the addAnnotatedClassesToCache method.
Methods
| __construct(Reader $annotationReader, string $phpArrayFile, CacheItemPoolInterface $fallbackPool, string $excludeRegexp = null, bool $debug = false) | ||
| bool | isOptional() Checks whether this warmer is optional or not. | from AbstractPhpFileCacheWarmer |
| warmUp(string $cacheDir) Warms up the cache. | from AbstractPhpFileCacheWarmer | |
| warmUpPhpArrayAdapter(PhpArrayAdapter $phpArrayAdapter, array $values) | from AbstractPhpFileCacheWarmer | |
| bool | doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter) |
Details
__construct(Reader $annotationReader, string $phpArrayFile, CacheItemPoolInterface $fallbackPool, string $excludeRegexp = null, bool $debug = false)
Parameters
| Reader | $annotationReader | |
| string | $phpArrayFile | The PHP file where metadata are cached |
| CacheItemPoolInterface | $fallbackPool | The pool where runtime-discovered metadata are cached |
| string | $excludeRegexp | |
| bool | $debug |
bool isOptional()
Checks whether this warmer is optional or not.
Optional warmers can be ignored on certain conditions.
A warmer should return true if the cache can be generated incrementally and on-demand.
Return Value
| bool | true if the warmer is optional, false otherwise |
warmUp(string $cacheDir)
Warms up the cache.
Parameters
| string | $cacheDir | The cache directory |
protected warmUpPhpArrayAdapter(PhpArrayAdapter $phpArrayAdapter, array $values)
Parameters
| PhpArrayAdapter | $phpArrayAdapter | |
| array | $values |
protected bool doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter)
Parameters
| string | $cacheDir | |
| ArrayAdapter | $arrayAdapter |
Return Value
| bool | false if there is nothing to warm-up |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Bundle/FrameworkBundle/CacheWarmer/AnnotationsCacheWarmer.html