germania-kg/namespaced-cache

Factory classes for namespaced PSR-6 CacheItemPools

1.4.0 2021-09-07 07:53 UTC

Requires

• php: ^7.3|^8.0
• nyholm/dsn: ^2.0
• psr/cache: ^1.0|^2.0|^3.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.12
• php-coveralls/php-coveralls: ^2.0
• phpspec/prophecy-phpunit: ^2.0
• phpstan/phpstan: ^0.12.67
• phpunit/phpunit: ^9.0
• symfony/cache: ^5.2
• tedivm/stash: ^0.16

Suggests

• symfony/cache: Pretty good cache library
• tedivm/stash: Another fine cache library

MIT

• Carsten Witt

• cache
• sqlite
• psr-6
• symfony-cache
• namespaced

README

Namespaced CacheItemPool Factory

Installation

$ composer require germania-kg/namespaced-cache

One of these libraries is required to be installed manually:

• Stash PHP cache
• Symfony Cache Component

$ composer require symfony/cache
$ composer require tedivm/stash

Interfaces

Factory Interface

Classes implementing the PsrCacheItemPoolFactoryInterface are callable. Their invokation method accepts a namespace string.

<?php
Germania\NamespacedCache\PsrCacheItemPoolFactoryInterface;

interface PsrCacheItemPoolFactoryInterface
{
    public function __invoke( string $namespace) : \Psr\Cache\CacheItemPoolInterface;
}

DefaultLifeTimeAware

Define a default lifetime for cache items. It can be used on those PSR-6 libraries that support default life times on cache item pools.

<?php
use Germania\NamespacedCache\DefaultLifeTimeAware;

interface DefaultLifeTimeAware
{
    /**
     * Returns default cache item lifetime.
     *
     * @return int|null
     */
    public function getDefaultLifetime() : ?int;


    /**
     * Sets default cache item lifetime.
     *
     * @param int|null $lifetime Default cache item lifetime
     */
    public function setDefaultLifetime( ?int $lifetime);
}

Example:

<?php
use Germania\NamespacedCache\SymfonyFileCacheItemPoolFactory;
use Germania\NamespacedCache\DefaultLifeTimeAware;

$factory = new SymfonyFileCacheItemPoolFactory($directory);
if ($factory instanceOf DefaultLifeTimeAware::class) {
    $factory->setDefaultLifetime( 3600 );
}

Auto-discovering

Abstract class PsrCacheItemPoolFactory provides a static autodiscover method which will create SQLite or Filesystem cache factory, depending on if SQLite being available.

This is an experimental feature.

<?php
use Germania\NamespacedCache\PsrCacheItemPoolFactory;

$factory = PsrCacheItemPoolFactory::autodiscover($dsn_or_path);
$factory = PsrCacheItemPoolFactory::autodiscover($dsn_or_path, $default_lifetime);

Filesystem caches

Auto-discover Symfony Cache or Stash

Use this when migrating from one cache engine to another. It internally uses SymfonyFileCacheItemPoolFactory or StashFileCacheItemPoolFactory, whichever library is installed.

Callable class FileCacheItemPoolFactory implements PsrCacheItemPoolFactoryInterface.

<?php
use Germania\NamespacedCache\FileCacheItemPoolFactory;

# These are defaults
$directory = getcwd(); 
$default_lifetime = 0;

$factory = new FileCacheItemPoolFactory();
$factory = new FileCacheItemPoolFactory($directory, $default_lifetime);

// Psr\Cache\CacheItemPoolInterface
$cache = $factory("my_namespace");

echo get_class($cache);
// "Stash\Pool" or 
// "Symfony\Component\Cache\Adapter\FilesystemAdapter"

Symfony Cache Component

Callable class SymfonyFileCacheItemPoolFactory extends SymfonyCacheItemPoolFactory and implements PsrCacheItemPoolFactoryInterface and DefaultLifeTimeAware:

<?php
use Germania\NamespacedCache\SymfonyFileCacheItemPoolFactory;

# These are defaults
$directory = getcwd(); 
$default_lifetime = 0;

$factory = new SymfonyFileCacheItemPoolFactory();
$factory = new SymfonyFileCacheItemPoolFactory($directory, $default_lifetime);
$factory = (new SymfonyFileCacheItemPoolFactory($directory))
           ->setDefaultLifetime( 3600 );

// Psr\Cache\CacheItemPoolInterface
$cache = $factory("my_namespace");

Stash PHP Caching Library

Callable class StashFileCacheItemPoolFactory implements PsrCacheItemPoolFactoryInterface. Note that Stash caches do not provide setting default cache item lifetime.

<?php
use Germania\NamespacedCache\StashFileCacheItemPoolFactory;

# These are defaults
$directory = getcwd(); 

$factory = new StashFileCacheItemPoolFactory();
$factory = new StashFileCacheItemPoolFactory($directory);
  
// Psr\Cache\CacheItemPoolInterface
$cache = $factory("my_namespace");

Sqlite Caches

Auto-discover Symfony Cache or Stash

Use this when migrating from one cache engine to another. It internally uses SymfonySqliteCacheItemPoolFactory or StashSqliteCacheItemPoolFactory, whichever library is installed.

Callable class SqliteCacheItemPoolFactory implements PsrCacheItemPoolFactoryInterface.

Please note:

• Symfony/Cache requires a DSN string
• Stash/Cache requires a directory.

<?php
use Germania\NamespacedCache\SqliteCacheItemPoolFactory;

# These are defaults
$directory_or_dsn = getcwd(); 
$default_lifetime = 0;

$factory = new SqliteCacheItemPoolFactory($directory_or_dsn);
$factory = new SqliteCacheItemPoolFactory($directory_or_dsn, $default_lifetime);

// Psr\Cache\CacheItemPoolInterface
$cache = $factory("my_namespace");

echo get_class($cache);
// "Stash\Pool" or 
// "Symfony\Component\Cache\Adapter\PdoAdapter"

Symfony Cache Component

Callable class SymfonySqliteCacheItemPoolFactory extends SymfonyCacheItemPoolFactory and implements PsrCacheItemPoolFactoryInterface and DefaultLifeTimeAware.

<?php
use Germania\NamespacedCache\SymfonySqliteCacheItemPoolFactory;

# These are defaults
$dsn_or_directory = "sqlite::memory:"; 
$dsn_or_directory = "sqlite:/path/to/mydb.sq3";
$dsn_or_directory = "/tmp";
$default_lifetime = 0;

$factory = new SymfonySqliteCacheItemPoolFactory();
$factory = new SymfonySqliteCacheItemPoolFactory($dsn_or_directory, $default_lifetime);
$factory = (new SymfonySqliteCacheItemPoolFactory($dsn_or_directory))
           ->setDefaultLifetime( 3600 );

// Psr\Cache\CacheItemPoolInterface
$cache = $factory("my_namespace");

Stash PHP Caching Library

Callable class StashSqliteCacheItemPoolFactory implements PsrCacheItemPoolFactoryInterface.

Note that Stash caches do not provide setting default cache item lifetime.

<?php
use Germania\NamespacedCache\StashSqliteCacheItemPoolFactory;

# These are defaults
$directory = getcwd(); 

$factory = new StashSqliteCacheItemPoolFactory();
$factory = new StashSqliteCacheItemPoolFactory($directory);
  
// Psr\Cache\CacheItemPoolInterface
$cache = $factory("my_namespace");

Testing

$ composer phpunit