joefallon/phpcache

This package contains a tag-based cache (APC only).

v3.0.0 2016-08-22 03:56 UTC

This package is not auto-updated.

Last update: 2020-05-25 05:40:46 UTC


README

By Joe Fallon

Normally, cache entries are invalidated using one of three methods:

  1. The cache entry is explicitly removed via a call to a remove() method of some sort.
  2. The cache entry is removed due to time-based expiration.
  3. The cache entry is removed due to being ejected to make room for newer entries.

Unfortunately, this does not allow a whole group of cache entries to be removed because they are dependent on a common factor. For example, let's assume we have a blog and the blog has many posts. Additionally, let's assume that a list of all of the posts has been added to the cache. Let's set the cache key for the group of posts to all_posts. Additionally, let's add a tag to this cache entry called posts_table.

Then, let's say we cache a single post. Let's give it a key of post_id_45. Also, let's give it a tag of posts_table. So now we have all the posts as a cache entry and the post with an ID of 45 as a cache entry. If we delete the post with id of 45, then of course remove it from the cache. However, we should also delete by tag every cache entry with the tag posts_table. This will remove the list of all posts from the previous paragraph. There could be many cache entries that are dependent on the contents of the posts table not changing. Using one or more tags to clear groups of cache entries make cache management much easier and less prone to error.

Installation

The easiest way to install Joe's PHP Cache is with Composer. Create the following composer.json file and run the php composer.phar install command to install it.

{
    "require": {
        "joefallon/phpcache": "*"
    }
}

TaggedCache Class

The TaggedCache class allows the usage of simple key/value cache as a cache back-end. In fact, any class that implements Cacheable can be used as a cache back-end for TaggedCache. Currently, only APC is implemented. However, it is super easy to add more and I look forward to pull requests.

In addition to tags, TaggedCache supports several additional features:

  1. The cache can be namespaced to allow more than one cache to be segregated within a back-end.
  2. A default expires time in seconds is available to allow more aggressive cache expiration than the back-end default expires time. This can be useful for data retrieved from external web services (e.g. feeds).
  3. Each cache entry can have a custom expires time.

Available Methods

Here is a list of methods available in TaggedCache:

store($key, $value, array $tags = null, $expiresInSeconds = null);
retrieve($key);
exists($key);
remove($key);
removeByTag($tag);
removeAll();

Add and Retrieve a Value From the Cache

Here is an example of adding a plain non-tagged value to the tagged cache:

use JoeFallon\Cache\ApcCache;
use JoeFallon\Cache\TaggedCache;

$cache = new TaggedCache(new ApcCache());   // use default namespace and expires

$key1   = 'key1';
$value1 = 'value1';

$cache->store($key1, $value1);

$key1Exists = $cache->exists($key1);
$value = null;

if($key1Exists)
{
    $value = $cache->retrieve($key1);
}
else
{
    $value = expensiveMethod();
}

Add and Remove a Tagged Value From the Cache

Here is an example of adding a cache entry to the cache that has a tag associated with it and then deleting that cache entry by tag instead of by key:

use JoeFallon\Cache\ApcCache;
use JoeFallon\Cache\TaggedCache;

$cache = new TaggedCache(new ApcCache());   // use default namespace and expires

$key1   = 'key1';
$value1 = 'value1';

$cache->store($key1, $value1, array('tag1', 'tag2'));
$cache->removeByTag('tag2');  // the cache entry for 'key1' is deleted

NOTE: In the previous example, all entries that have the tag 'tag2' would be deleted.