Twig_Cache_Filesystem Class Reference

Implements a cache on the filesystem. More...

Inheritance diagram for Twig_Cache_Filesystem:

Collaboration diagram for Twig_Cache_Filesystem:

Public Member Functions
	__construct ($directory, $options=0)
	generateKey ($name, $className)
	Generates a cache key for the given template class name. More...
	load ($key)
	Loads a template from the cache. More...
	write ($key, $content)
	Writes the compiled template to cache. More...
	getTimestamp ($key)
	Returns the modification timestamp of a key. More...

Data Fields
const	FORCE_BYTECODE_INVALIDATION = 1

Private Attributes
	$directory
	$options

Detailed Description

Implements a cache on the filesystem.

Author

Andrew Tch andre.nosp@m.w@no.nosp@m.op.lv

Definition at line 17 of file Filesystem.php.

Constructor & Destructor Documentation

__construct()

Twig_Cache_Filesystem::__construct	(		$directory,
			$options = 0
	)

Parameters

$directory	string The root cache directory
$options	int A set of options

Definition at line 28 of file Filesystem.php.

References $directory, and $options.

    {
        $this->directory = rtrim($directory, '\/').'/';
        $this->options = $options;
    }

Member Function Documentation

generateKey()

Twig_Cache_Filesystem::generateKey	(		$name,
			$className
	)

Generates a cache key for the given template class name.

Parameters

string	$name	The template name
string	$className	The template class name

Returns

string

Implements Twig_CacheInterface.

Definition at line 34 of file Filesystem.php.

References GuzzleHttp\Psr7\hash().

    {
        $hash = hash('sha256', $className);

        return $this->directory.$hash[0].$hash[1].'/'.$hash.'.php';
    }

Here is the call graph for this function:

getTimestamp()

Twig_Cache_Filesystem::getTimestamp

(

$key

)

Returns the modification timestamp of a key.

Parameters

string

$key

The cache key

Returns

int

Implements Twig_CacheInterface.

Definition at line 83 of file Filesystem.php.

References $key.

    {
        if (!file_exists($key)) {
            return 0;
        }

        return (int) @filemtime($key);
    }

load()

Twig_Cache_Filesystem::load

(

$key

)

Loads a template from the cache.

Parameters

string

$key

The cache key

Implements Twig_CacheInterface.

Definition at line 41 of file Filesystem.php.

References $key.

    {
        if (file_exists($key)) {
            @include_once $key;
        }
    }

write()

Twig_Cache_Filesystem::write	(		$key,
			$content
	)

Writes the compiled template to cache.

Parameters

string	$key	The cache key
string	$content	The template representation as a PHP class

Implements Twig_CacheInterface.

Definition at line 48 of file Filesystem.php.

References $key.

    {
        $dir = dirname($key);
        if (!is_dir($dir)) {
            if (false === @mkdir($dir, 0777, true)) {
                if (PHP_VERSION_ID >= 50300) {
                    clearstatcache(true, $dir);
                }
                if (!is_dir($dir)) {
                    throw new RuntimeException(sprintf('Unable to create the cache directory (%s).', $dir));
                }
            }
        } elseif (!is_writable($dir)) {
            throw new RuntimeException(sprintf('Unable to write in the cache directory (%s).', $dir));
        }

        $tmpFile = tempnam($dir, basename($key));
        if (false !== @file_put_contents($tmpFile, $content) && @rename($tmpFile, $key)) {
            @chmod($key, 0666 & ~umask());

            if (self::FORCE_BYTECODE_INVALIDATION == ($this->options & self::FORCE_BYTECODE_INVALIDATION)) {
                // Compile cached file into bytecode cache
                if (function_exists('opcache_invalidate')) {
                    opcache_invalidate($key, true);
                } elseif (function_exists('apc_compile_file')) {
                    apc_compile_file($key);
                }
            }

            return;
        }

        throw new RuntimeException(sprintf('Failed to write cache file "%s".', $key));
    }

Field Documentation

$directory

Twig_Cache_Filesystem::$directory

private

Definition at line 21 of file Filesystem.php.

Referenced by __construct().

$options

Twig_Cache_Filesystem::$options

private

Definition at line 22 of file Filesystem.php.

Referenced by __construct().

FORCE_BYTECODE_INVALIDATION

const Twig_Cache_Filesystem::FORCE_BYTECODE_INVALIDATION = 1

Definition at line 19 of file Filesystem.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/twig/twig/lib/Twig/Cache/Filesystem.php