Code::TidyAll::CacheModel->new(%params)¶

The constructor accepts the following attributes:

• full_path

  The full path to the cache file on disk. This is required.

• path

  The local path to the file (i.e. what the cache system will consider the canonical name of the file).

• cache_engine

  A "Code::TidyAll::Cache" compatible instance. This can be omitted if no caching is actually being done.

• base_sig

  A base signature. This defaults to an empty string.

• file_contents

  The contents of the file being cached. This can be omitted, in which case it will be loaded as needed.

• is_cached

  A boolean indicating if this file is cached. By default this is computed by checking that the cache key and cache value match what is in the cache.

$model->full_path¶

The value passed to the constructor.

$model->path¶

The value passed to the constructor.

$model->cache_engine¶

The value passed to the constructor.

$model->base_sig¶

The value passed to the constructor or the default value, an empty string.

$model->file_contents¶

The file contents, which will be loaded from the file system if needed.

$model->is_cached¶

A boolean indicating whether the path is currently in the cache.

$model->cache_key¶

The computed cache key for the file.

$model->cache_value¶

The computed cache value for the file.

$model->update¶

Updates the cache.

$model->remove¶

Attempts to remove the value from the cache.