2017 © Pedro Peláez
 

library cache

A library to provide cache interface access to different backend caches

image

pluggit/cache

A library to provide cache interface access to different backend caches

  • Monday, February 13, 2017
  • by qu1m
  • Repository
  • 18 Watchers
  • 1 Stars
  • 516 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 14 Versions
  • 102 % Grown

The README.md

Pluggit - Cache

Build Status Scrutinizer Code Quality Code Coverage, (*1)

Provides an abstracion over most common user caches, (*2)

TLDR;

/** @var \Cmp\Cache\Cache $cache */
$cache = (new CacheBuilder)
  ->withLogging($psrLogger)
  ->withoutExceptions()
  ->withArrayCache()
  ->withRedisCacheFromParams($host, $port, $dbNumber)
  ->build();

// Set an item
$cache->set('foo', 'bar');

// Demand an item, throws an exception if not present
$bar = $cache->demand('foo');

// Get an item, if not present in any cache it will return the given default
$default = $cache->get('not found', 'default');

// Delete an item
$cache->delete('foo');

// Empty the cache
$cache->flush();

//Create a tagged cache
$taggedCache = $cache->tag('myTag');

//Set a tagged item
$taggedCache->set('key','value');

//Remove all tagged items
$taggedCache->flush();

The Cache interface

The cache interface allows access to 10 methods: * set * setAll * has * get * getAll * demand * delete * deleteAll * flush * tag * appendList * increase, (*3)

Set

Use it to store values in the cache. You can make an item expire after a certain time by passing the $timeToLive parameter bigger than zero, (*4)

Note: Time to live must be an integer representing seconds, (*5)

SetAll

Use it to store multiple values at one, (*6)

Has

Checks if an item is in the cache and has not expired, (*7)

Get

Tries to get an item from the cache, and if it's not there, it return a given default value, (*8)

GetAll

Tries to get multiple items from the cache, if an item is not found, the key will be returned with a null, (*9)

Demand

Tries to retrieve an item from the cache, if it's not present, it throws a NotFoundException, (*10)

Delete

Deletes an item from the cache, (*11)

Delete All

Deletes multiple items at once, (*12)

Flush

It empties the cache, (*13)

Tag

Creates a tagged cache instance. It works as a normal cache, but all the entries are put in a special bucket which you can flush., (*14)

Cache backends provided

These are the current backend implementations: * Redis * Array (in memory) * ChainCache, (*15)

Note: You can use the CacheFactory to easily build a cache object with one of the provided backends, (*16)

ChainCache

The chain cache will accept one or more cache and tries all caches before failing, (*17)

Cache backend decorator provided

  • LoggerCache

Logger Cache

It allows to log any exception thrown from the decorated cache. You can choose the silent mode to avoid throwing exceptions from the cache, (*18)

Note: This decorator is used always when building a cache trough the builder, as it ensures that all exceptions thrown extend the base CacheException, (*19)

Tags

It is possible to use tags for grouping related objects. All three provided backends have this ability. To use it just request a new tagged cache instance using the tag() method, and then you'll be able to use it in the same way you use any other cache backend:, (*20)

// Store one photo in the cache
$cache->set('photo.1', $photoOne);

// Store a set of photos and tag them
$cache->tag('photos')->set('photo.1', $taggedPhotoOne);
$cache->tag('photos')->set('photo.2', $taggedPhotoTwo);

// The photos are into different buckets
$cache->has('photo.1');                // true 
$cache->has('photo.2')                 // false
$cache->tag('photos')->has('photo.1'); // true
$cache->tag('photos')->has('photo.2')  // true

// You can flush all items with the same tag at once
$cache->tag('photos')->flush();
$cache->has('photo.1');                // true 
$cache->tag('photos')->has('photo.1'); // false

Pimple service provider

The library includes a service provider for Pimple ^3.0 (included on Silex ^2.0) to easily register a cache, (*21)

By default it will register an ArrayCache on the key cache, (*22)

$pimple->register(new CacheServiceProvider());

/** @var LoggerCache $cache */
$cache = $pimple['cache'];

/** @var ArrayCache $cache */
$arrayCache = $pimple['cache']->getDecoratedCache();

Options

  • cache.backends: an array of backends caches to use, if more than one is provided, the ChainCache will be used to wrap them all. Each backend option must have the key backend, the available options are:, (*23)

    • array: It will create an ArrayCache (same as default)
    • redis: If you already have a redis connection, it can be passed on the key connection_ (if a string is used, the provider will try to get the service from the container. If the _connection is not given, the provider will try to build a connection reading from the options array:
      • host: 127.0.0.1 by default
      • port: 6379 by default
      • db: 0 by default
      • timeout: 0.0 by default
    • string: If a string is given, the provider will try to get the service from the container, the service must implement then Cmp\Cache\Cache interface
    • Cmp\Cache\Cache: If an object implementing the Cache interface is given, it will be used directly

  • cache.exceptions: a boolean, true by default. If is set to true, the cache will be throw exceptions, if false, no exceptions will be thrown., (*24)

  • cache.logging: It allows to log exceptions thrown by the cache system. it accepts an array, with the following options:
    • logger: And instance of an logger implementing the Psr\LoggerInterface
    • log_level: The log level to use for logging the exceptions, 'alert' by default. Must be one of the valid levels defined at Psr\LogLevel

Examples:, (*25)

// Redis from parameters
$pimple->register(new PimpleCacheProvider(), ['cache.backends' => [
    ['backend' => 'redis', 'host' => '127.0.0.1', 'port' => 6379, 'db' => 1, 'timeout' => 2.5]
]]);

// ArrayCache + Redis from existing connection
$pimple->register(new PimpleCacheProvider(), ['cache.backends' => [
    ['backend' => 'array']
    ['backend' => 'redis', 'connection' => $redisConnection,]
]]);

// ArrayCache + Redis from a service registered in the container
$pimple->register(new PimpleCacheProvider(), ['cache.backends' => [
    ['backend' => 'array']
    ['backend' => 'redis', 'connection' => 'redis.connection']
]]);

// Chain caches with logging and muted exceptions
$pimple->register(new PimpleCacheProvider(), [
    'cache.backends'   => [
        ['backend' => 'array'],
        ['backend' => 'custom_cache_service_key'],
    ],
    'cache.exceptions' => false,
    'cache.logging'    => ['logger' => $psrLogger, 'log_level' => PsrLevel::CRITICAL],
]);

The Versions

13/02 2017

dev-master

9999999-dev

A library to provide cache interface access to different backend caches

  Sources   Download

MIT

The Requires

 

The Development Requires

by Hilari Moragrega

13/02 2017

2.3.1

2.3.1.0

A library to provide cache interface access to different backend caches

  Sources   Download

MIT

The Requires

 

The Development Requires

by Hilari Moragrega

24/12 2016

2.3.0

2.3.0.0

A library to provide cache interface access to different backend caches

  Sources   Download

The Requires

 

The Development Requires

by Hilari Moragrega

12/12 2016

dev-feature/WQR-2200

dev-feature/WQR-2200

A library to provide cache interface access to different backend caches

  Sources   Download

The Requires

 

The Development Requires

by Hilari Moragrega

12/12 2016

2.2.1

2.2.1.0

A library to provide cache interface access to different backend caches

  Sources   Download

The Requires

 

The Development Requires

by Hilari Moragrega

12/08 2016

2.2.0

2.2.0.0

A library to provide cache interface access to different backend caches

  Sources   Download

The Requires

 

The Development Requires

by Hilari Moragrega

25/07 2016

dev-interfaceNaming

dev-interfaceNaming

A library to provide cache interface access to different backend caches

  Sources   Download

The Requires

 

The Development Requires

by Hilari Moragrega

24/07 2016

2.1.1

2.1.1.0

A library to provide cache interface access to different backend caches

  Sources   Download

The Requires

 

The Development Requires

by Hilari Moragrega

23/07 2016

2.1.0

2.1.0.0

A library to provide cache interface access to different backend caches

  Sources   Download

The Requires

 

The Development Requires

by Hilari Moragrega

22/07 2016

2.0.0

2.0.0.0

A library to provide cache interface access to different backend caches

  Sources   Download

The Requires

 

The Development Requires

by Hilari Moragrega

22/07 2016

2.0.0-beta-1

2.0.0.0-beta1

A library to provide cache interface access to different backend caches

  Sources   Download

The Requires

 

The Development Requires

by Hilari Moragrega

22/07 2016

2.0.0-beta

2.0.0.0-beta

A library to provide cache interface access to different backend caches

  Sources   Download

The Requires

 

The Development Requires

by Hilari Moragrega

19/07 2016

1.1.0

1.1.0.0

A library to provide cache interface access to different backend caches

  Sources   Download

The Requires

  • php >=5.5

 

The Development Requires

by Hilari Moragrega

18/07 2016

1.0.0

1.0.0.0

A library to provide cache interface access to different backend caches

  Sources   Download

The Requires

  • php >=5.5

 

The Development Requires

by Hilari Moragrega