linio/cache

Provides a multi-layered caching abstraction

Linio Cache

, _(*1)

Linio Cache is yet another component of the Linio Framework. It aims to abstract caching by supporting multiple adapters., _(*2)

Install

The recommended way to install Linio Cache is through composer., _(*3)

{
    "require": {
        "linio/cache": "dev-master"
    }
}

Tests

To run the test suite, you need install the dependencies via composer, then run PHPUnit., _(*4)

$ composer install
$ phpunit

Cache Not Found Keys

It is now possible (v.1.0.9) to cache not found keys in upper level adapters of the adapter stack. The configuration option cache_not_found_keys can be set at the adapter level., _(*5)

Note that this option, obviously, does not apply to the last level of the cache hierarchy., _(*6)

Usage

<?php

use \Linio\Component\Cache\CacheService;

$container['cache'] = new CacheService([
    'namespace' => 'mx',
    'layers' => [
        0 => [
            'adapter_name' => 'array',
            'adapter_options' => [
                'cache_not_found_keys' => true,
                'encoder' => 'json',
            ],
        ],
        1 => [
            'adapter_name' => 'apc',
            'adapter_options' => [
                'ttl' => 3600,
            ],
        ],
        2 => [
            'adapter_name' => 'redis',
            'adapter_options' => [
                'host' => 'localhost',
                'port' => 6379,
                'ttl' => 0,
                'encoder' => 'serial',
            ],
        ],
    ],
]);

$container->setLogger($container['logger']);

Note that must provide an adapter name and an array of options. Each adapter has different configuration options., _(*7)

To start setting data:, _(*8)

<?php

$app['cache.service']->set('foo', 'bar');

Methods

get

<?php

    /**
     * @param string $key
     * @return string value
     */
    public function get($key);

    $adapter->get('foo');

getMulti

<?php

     /**
     * @param array $keys
     * @return string[]
     */
    public function getMulti(array $keys);

    $adapter->getMulti(['foo', 'nop']);

set

<?php

     /**
     * @param string $key
     * @param string $value
     * @param ?int $ttl Time To Live; store value in the cache for ttl seconds.
     * This ttl overwrites the configuration ttl of the adapter
     * @return bool
     */
    public function set(string $key, $value, ?int $ttl = null);

    $adapter->set('foo', 'bar');
    $adapter->set('foo', 'bar', 60); // store bar in the cache for 60 seconds

setMulti

<?php

     /**
     * @param array $keys
     * @return bool
     */
    public function setMulti(array $data);

    $adapter->setMulti(['foo' => 'bar', 'fooz' => 'baz']);

delete

<?php

     /**
     * @param string $key
     * @return bool
     */
    public function delete($key);

    $adapter->delete('foo');

deleteMulti

<?php

     /**
     * @param array $keys
     * @return bool
     */
    public function deleteMulti(array $keys);

    $adapter->deleteMulti(['foo', 'fooz']);

contains

<?php

     /**
     * @param string $key
     * @return bool
     */
    public function contains($key);

    $adapter->contains('foo');

flush

<?php

     /**
     * @return bool
     */
    public function flush();

    $adapter->flush();

Providers

array

This cache does not have any persistence between requests., _(*9)

Not recommended to be used in production environments., _(*10)

apc

Adapter options:, _(*11)

• ttl optional default: 0 (unlimited)
• cache_not_found_keys optional default: false

Requires APC extension or APCu extension., _(*12)

wincache

Adapter options:, _(*13)

• ttl optional default: 0 (unlimited)
• cache_not_found_keys optional default: false

Requires WinCache extension., _(*14)

memcached

Adapter options:, _(*15)

• servers array of memcache servers. format: [[, , ], [, , ], ...]
• options array of memcache options. format: [ => , => , ...]
• connection_persistent optional default: false
• pool_size optional default: 1 (only for persistent connections)
• ttl optional default: 0 (unlimited)
• cache_not_found_keys optional default: false

Requires Memcached extension., _(*16)

redis

Adapter options:, _(*17)

• host optional default: 127.0.0.1
• port optional default: 6379
• database optional default: 0 (int)
• password optional default: null (no password)
• connection_persistent optional default: false
• ttl optional default: 0 (unlimited)
• cache_not_found_keys optional default: false

More information on the available parameters at the Predis documentation., _(*18)

phpredis

Adapter options:, _(*19)

• host optional default: 127.0.0.1
• port optional default: 6379
• database optional default: 0 (int)
• password optional default: null (no password)
• connection_persistent optional default: false
• pool_size optional default: 1 (only for persistent connections)
• timeout optional default: 0 (unlimited)
• read_timeout optional default: 0 (unlimited)
• retry_interval optional default: 0 (value in milliseconds)
• ttl optional default: 0 (unlimited)
• cache_not_found_keys optional default: false
• serializer optional default: none
  • none don't serialize data
  • php use built-in serialize/unserialize
  • igbinary use igBinary serialize/unserialize (requires igbinary extension)

More information on the available parameters at the phpredis documentation., _(*20)

Requires redis extension., _(*21)

mysql

Using PDO., _(*22)

Adapter options:, _(*23)

• host
• port
• dbname
• username
• password
• table_name
• ensure_table_created optional default: false
• cache_not_found_keys optional default: false

The ensure_table_created is used to ensure the cache table exists in the database. This option has a significant performance impact., _(*24)

Not recommended to be used in production environments., _(*25)

aerospike

Adapter options:, _(*26)

• hosts
• aerospike_namespace optional default: test
• persistent optional default: true
• options optional default: []
• ttl optional default: 0 (unlimited)
• cache_not_found_keys optional default: false

For the Aerospike adapter, the aerospike_namespace property will be used as the namespace in Aerospike, and the namespace configuration in the CacheService will be used as the set in Aerospike., _(*27)

Requires Aerospike Extension., _(*28)