Using PPI::Cache¶

The most common way of using "PPI::Cache" is to provide parameters to the "use" statement at the beginning of your program.

  # Load the class but do not set a cache
  use PPI::Cache;
  
  # Use a fairly normal cache location
  use PPI::Cache path => '/var/cache/ppi-cache';

Any of the arguments that can be provided to the "new" constructor can also be provided to "use".

new param => $value, ...¶

The "new" constructor creates a new standalone cache object.

It takes a number of parameters to control the cache.

path

The "path" param sets the base directory for the cache. It must already exist, and must be writable.

readonly

The "readonly" param is a true/false flag that allows the use of an existing cache by a less-privileged user (such as the web user).

Existing documents will be retrieved from the cache, but new documents will not be written to it.

Returns a new "PPI::Cache" object, or dies on error.

path¶

The "path" accessor returns the path on the local filesystem that is the root of the cache.

readonly¶

The "readonly" accessor returns true if documents should not be written to the cache.

get_document $md5sum | \$source¶

The "get_document" method checks to see if a Document is stored in the cache and retrieves it if so.

store_document $Document¶

The "store_document" method takes a PPI::Document as argument and explicitly adds it to the cache.

Returns true if saved, or "undef" (or dies) on error.

FIXME (make this return either one or the other, not both)