phossa2/cache

A PSR-6 compliant PHP caching library

phossa2/cache [ABANDONED]

Please use phoole/cache instead., _(*1)

, _(*2)

phossa2/cache is a PSR-6 compliant caching library for PHP. It supports various drivers and useful features like bypass, encrypt, stampede protection etc., _(*3)

It requires PHP 5.4, supports PHP 7.0+ and HHVM. It is compliant with PSR-1, PSR-2, PSR-3, PSR-4, PSR-6 and the proposed PSR-5., _(*4)

Installation

Install via the composer utility., _(*5)

composer require "phossa2/cache"

or add the following lines to your composer.json, _(*6)

{
    "require": {
       "phossa2/cache": "2.*"
    }
}

Features

• Fully PSR-6 compliant., _(*7)

• Support all serializable PHP datatypes., _(*8)

• Extensions included:, _(*9)

  • Bypass: If sees a trigger in URL (e.g. '?nocache=true'), bypass the cache., _(*10)

  • Stampede Protection: Whenever cached object's lifetime is less than a configurable time, by a configurable percentage, the cache will return false on 'isHit()' which will trigger re-generation of the object., _(*11)

  • Encrypt: A simple extension to encrypt the serialized content., _(*12)

  • DistributedExpiration: Even out the spikes of item misses by alter expiration time a little bit., _(*13)

• Drivers, _(*14)

  • StorageDriver

  The storage driver uses phossa2/storage local or cloud storage., _(*15)

  • NullDriver

  The blackhole driver, can be used as fallback driver for all other drivers., _(*16)

Usage

• Simple usage, _(*17)

  /*
  * cache dir default to local sys_get_temp_dir() . '/cache'
  */
  $cache = new CachePool();
  
  $item = $cache->getItem('/data.cache');
  if (!$item->isHit()) {
    $value = calcuate_data();
    $item->set($value);
    $cache->save($item);
  }
  $data = $item->get();
  

• Specify the driver, _(*18)

  use Phossa2\Cache\Driver\StorageDriver;
  use Phossa2\Storage\Storage;
  use Phossa2\Storage\Filesystem;
  use Phossa2\Storage\Driver\LocalDriver;
  
  $driver = new StorageDriver(
    new Storage('/', new Filesystem(new LocalDriver(sys_get_temp_dir()))),
    '/cache'
  );
  
  $cache = new CachePool($driver);
  

• Use extensions, _(*19)

  /*
  * DistributedExpiration extension
  */
  use Phossa2\Cache\CachePool;
  use Phossa2\Cache\Extension\DistributedExpiration;
  
  $cache = new CachePool();
  $cache->addExtension(new DistributedExpiration());
  

Change log

Please see CHANGELOG from more information., _(*20)

Testing

$ composer test

Contributing

Please see CONTRIBUTE for more information., _(*21)

Dependencies

• PHP >= 5.4.0, _(*22)

• phossa2/event >= 2.1.4, _(*23)

• phossa2/storage >= 2.0.0, _(*24)

License

MIT License, _(*25)