marco476/filesystem-cache

[![Build Status](https://travis-ci.org/marco476/filesystem-cache.svg?branch=master)](https://travis-ci.org/marco476/filesystem-cache)
[![Packagist](https://img.shields.io/packagist/v/marco476/filesystem-cache.svg)](https://packagist.org/packages/marco476/filesystem-cache)
[![Code Climate](https://codeclimate.com/github/marco476/filesystem-cache/badges/gpa.svg)](https://codeclimate.com/github/marco476/filesystem-cache)
[![Issue Count](https://codeclimate.com/github/marco476/filesystem-cache/badges/issue_count.svg)](https://codeclimate.com/github/marco476/filesystem-cache)
[![PHP Version](https://img.shields.io/badge/PHP-%3E%3D5.6-blue.svg)](http://php.net/manual/en/migration56.new-features.php)
[![Packagist](https://img.shields.io/packagist/l/marco476/filesystem-cache.svg)](https://packagist.org/packages/marco476/filesystem-cache)

# PHP Filesystem cache
**Filesystem cache** is a quick, simple and secure filesystem cache service builded with [PSR-6](http://www.php-fig.org/psr/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
<?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:

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

For detail, you can see [PSR-6 documentation](http://www.php-fig.org/psr/psr-6/)

> 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
```