ConfigCache

class ConfigCache extends ResourceCheckerConfigCache

ConfigCache caches arbitrary content in files on disk.

When in debug mode, those metadata resources that implement \Symfony\Component\Config\Resource\SelfCheckingResourceInterface will be used to check cache freshness.

During a transition period, also instances of \Symfony\Component\Config\Resource\ResourceInterface will be checked by means of the isFresh() method. This behaviour is deprecated since 2.8 and will be removed in 3.0.

Methods

__construct(string $file, bool $debug)
string getPath()

Gets the cache file path.

from ResourceCheckerConfigCache
bool isFresh()

Checks if the cache is still fresh.

write(string $content, array $metadata = null)

Writes cache.

from ResourceCheckerConfigCache
string __toString() deprecated

Gets the cache file path.

Details

__construct(string $file, bool $debug)

Parameters

string $file The absolute cache path
bool $debug Whether debugging is enabled or not

string getPath()

Gets the cache file path.

Return Value

string The cache file path

bool isFresh()

Checks if the cache is still fresh.

This implementation always returns true when debug is off and the cache file exists.

Return Value

bool Whether the cache is still fresh.

write(string $content, array $metadata = null)

Writes cache.

Parameters

string $content The content to write into the cache
array $metadata An array of ResourceInterface instances

Exceptions

RuntimeException When cache file can't be written

string __toString() deprecated

deprecated

since 2.7, to be removed in 3.0. Use getPath() instead.

Gets the cache file path.

Return Value

string The cache file path

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Config/ConfigCache.html