Assetic\Cache\ConfigCache Class Reference

A config cache stores values using var_export() and include. More...

Collaboration diagram for Assetic\Cache\ConfigCache:

Public Member Functions
	__construct ($dir)
	Construct. More...
	has ($resource)
	Checks of the cache has a file. More...
	set ($resource, $value)
	Writes a value to a file. More...
	get ($resource)
	Loads and returns the value for the supplied cache key. More...
	getTimestamp ($resource)
	Returns a timestamp for when the cache was created. More...

Private Member Functions
	getSourcePath ($resource)
	Returns the path where the file corresponding to the supplied cache key can be included from. More...

Private Attributes
	$dir

Detailed Description

A config cache stores values using var_export() and include.

Author

Kris Wallsmith kris..nosp@m.wall.nosp@m.smith.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Definition at line 19 of file ConfigCache.php.

Constructor & Destructor Documentation

__construct()

Assetic\Cache\ConfigCache::__construct

(

$dir

)

Construct.

Parameters

string

$dir

The cache directory

Definition at line 28 of file ConfigCache.php.

References Assetic\Cache\ConfigCache\$dir.

    {
        $this->dir = $dir;
    }

Member Function Documentation

get()

Assetic\Cache\ConfigCache::get

(

$resource

)

Loads and returns the value for the supplied cache key.

Parameters

string

$resource

A cache key

Returns

mixed The cached value

Definition at line 75 of file ConfigCache.php.

References $path, and Assetic\Cache\ConfigCache\getSourcePath().

    {
        $path = $this->getSourcePath($resource);

        if (!file_exists($path)) {
            throw new \RuntimeException('There is no cached value for '.$resource);
        }

        return include $path;
    }

Here is the call graph for this function:

getSourcePath()

Assetic\Cache\ConfigCache::getSourcePath (   $resource )

private

Returns the path where the file corresponding to the supplied cache key can be included from.

Parameters

string

$resource

A cache key

Returns

string A file path

Definition at line 117 of file ConfigCache.php.

Referenced by Assetic\Cache\ConfigCache\get(), Assetic\Cache\ConfigCache\getTimestamp(), Assetic\Cache\ConfigCache\has(), and Assetic\Cache\ConfigCache\set().

    {
        $key = md5($resource);

        return $this->dir.'/'.$key[0].'/'.$key.'.php';
    }

Here is the caller graph for this function:

getTimestamp()

Assetic\Cache\ConfigCache::getTimestamp

(

$resource

)

Returns a timestamp for when the cache was created.

Parameters

string

$resource

A cache key

Returns

integer A UNIX timestamp

Definition at line 93 of file ConfigCache.php.

References $path, and Assetic\Cache\ConfigCache\getSourcePath().

    {
        $path = $this->getSourcePath($resource);

        if (!file_exists($path)) {
            throw new \RuntimeException('There is no cached value for '.$resource);
        }

        if (false === $mtime = @filemtime($path)) {
            // @codeCoverageIgnoreStart
            throw new \RuntimeException('Unable to determine file mtime for '.$path);
            // @codeCoverageIgnoreEnd
        }

        return $mtime;
    }

Here is the call graph for this function:

has()

Assetic\Cache\ConfigCache::has

(

$resource

)

Checks of the cache has a file.

Parameters

string

$resource

A cache key

Returns

Boolean True if a file exists

Definition at line 40 of file ConfigCache.php.

References Assetic\Cache\ConfigCache\getSourcePath().

    {
        return file_exists($this->getSourcePath($resource));
    }

Here is the call graph for this function:

set()

Assetic\Cache\ConfigCache::set	(		$resource,
			$value
	)

Writes a value to a file.

Parameters

string	$resource	A cache key
mixed	$value	A value to cache

Definition at line 51 of file ConfigCache.php.

References Assetic\Cache\ConfigCache\$dir, $path, and Assetic\Cache\ConfigCache\getSourcePath().

    {
        $path = $this->getSourcePath($resource);

        if (!is_dir($dir = dirname($path)) && false === @mkdir($dir, 0777, true)) {
            // @codeCoverageIgnoreStart
            throw new \RuntimeException('Unable to create directory '.$dir);
            // @codeCoverageIgnoreEnd
        }

        if (false === @file_put_contents($path, sprintf("<?php\n\n// $resource\nreturn %s;\n", var_export($value, true)))) {
            // @codeCoverageIgnoreStart
            throw new \RuntimeException('Unable to write file '.$path);
            // @codeCoverageIgnoreEnd
        }
    }

Here is the call graph for this function:

Field Documentation

$dir

Assetic\Cache\ConfigCache::$dir

private

Definition at line 21 of file ConfigCache.php.

Referenced by Assetic\Cache\ConfigCache\__construct(), and Assetic\Cache\ConfigCache\set().

---

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

• libs/composer/vendor/kriswallsmith/assetic/src/Assetic/Cache/ConfigCache.php