README

PHP Filesystem cache

Filesystem cache is a quick, simple and secure filesystem cache service builded with PSR-6 rules.

Installation

You can install it with Composer:

composer require marco476/filesystem-cache

How to use it

Filesystem cache implement perfectly the PSR-6 directive. So, you can use it very easily: See an example:

<?php
require_once __DIR__ . '/../vendor/autoload.php';

use \Service\Cache\CacheDir;
use \Service\Cache\CacheItemPool;

CacheDir::setCacheDir($_SERVER["DOCUMENT_ROOT"] . '/../cache');
$itemPool = new CacheItemPool();
$itemCache = $itemPool->getItem('myArray');

if ($itemCache->isHit()) {
    echo 'Hit, hit! <br>';
    print_r( $itemCache->get() );
} else {
    $value = array(
        'name'      => 'Marco',
        'friends'   => array('Paolo','Luca')
    );

    $itemCache->set($value);
    $itemPool->save($itemCache);

    echo 'All saved! <br>';
    print_r( $value );
}

The setCacheDir static's CacheDir method accept the cache path. If you can't pass it, the default cache path will be:

$_SERVER["DOCUMENT_ROOT"] . '/cache/'

For detail, you can see PSR-6 documentation

Remember that you must create the cache directory with permission to write and read!

Unit Test

You can run unit test from document root with:

vendor/bin/phpunit