Merge pull request #455 from Geolim4/final

 Merge branch 'v6' into final

Author: Geolim4

.travis.yml

@@ -14,19 +14,20 @@ language: php
 
 services:
   - memcached
-  # - redis-server
+  - redis-server
+  - couchdb
 before_script:
   - |
     if [[ $TRAVIS_PHP_VERSION = "hhv"* ]]; then
-      cat var/php/conf/phpfastcache.ini >> /etc/hhvm/php.ini
+      cat bin/ci/php-phpfastcache.ini >> /etc/hhvm/php.ini
     else
-      phpenv config-add var/php/conf/phpfastcache.ini
+      phpenv config-add bin/ci/php-phpfastcache.ini
     fi
 
 php:
   # - 5.3
   # - 5.4
-  - 5.5
+  # - 5.5
   - 5.6
   - 7.0
   - nightly

README.md

@@ -1,6 +1,7 @@
-[![Code Climate](https://codeclimate.com/github/PHPSocialNetwork/phpfastcache/badges/gpa.svg)](https://codeclimate.com/github/PHPSocialNetwork/phpfastcache) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/PHPSocialNetwork/phpfastcache/badges/quality-score.png?b=final)](https://scrutinizer-ci.com/g/PHPSocialNetwork/phpfastcache/?branch=final) [![Build Status](https://travis-ci.org/PHPSocialNetwork/phpfastcache.svg?branch=final)](https://travis-ci.org/PHPSocialNetwork/phpfastcache) [![Latest Stable Version](http://img.shields.io/packagist/v/phpfastcache/phpfastcache.svg)](https://packagist.org/packages/phpfastcache/phpfastcache) [![Total Downloads](http://img.shields.io/packagist/dt/phpfastcache/phpfastcache.svg)](https://packagist.org/packages/phpfastcache/phpfastcache) [![Dependency Status](https://www.versioneye.com/php/phpfastcache:phpfastcache/badge.svg)](https://www.versioneye.com/php/phpfastcache:phpfastcache) [![License](https://img.shields.io/packagist/l/phpfastcache/phpfastcache.svg)](https://packagist.org/packages/phpfastcache/phpfastcache) [![Coding Standards](https://img.shields.io/badge/CI-PSR6-orange.svg)](https://github.com/php-fig/cache)
+[![Total Downloads](http://img.shields.io/packagist/dt/phpfastcache/phpfastcache.svg)](https://packagist.org/packages/phpfastcache/phpfastcache) [![Dependency Status](https://www.versioneye.com/php/phpfastcache:phpfastcache/badge.svg)](https://www.versioneye.com/php/phpfastcache:phpfastcache) [![Latest Stable Version](http://img.shields.io/packagist/v/phpfastcache/phpfastcache.svg)](https://packagist.org/packages/phpfastcache/phpfastcache) [![License](https://img.shields.io/packagist/l/phpfastcache/phpfastcache.svg)](https://packagist.org/packages/phpfastcache/phpfastcache) [![Coding Standards](https://img.shields.io/badge/CI-PSR6-orange.svg)](https://github.com/php-fig/cache)  [![Coding Standards](https://img.shields.io/badge/CS-PSR16-orange.svg)](https://github.com/php-fig/simple-cache)    
+[![Code Climate](https://codeclimate.com/github/PHPSocialNetwork/phpfastcache/badges/gpa.svg)](https://codeclimate.com/github/PHPSocialNetwork/phpfastcache) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/PHPSocialNetwork/phpfastcache/badges/quality-score.png?b=final)](https://scrutinizer-ci.com/g/PHPSocialNetwork/phpfastcache/?branch=final) [![Build Status](https://travis-ci.org/PHPSocialNetwork/phpfastcache.svg?branch=final)](https://travis-ci.org/PHPSocialNetwork/phpfastcache)
 
-:exclamation: V4 USERS, PLEASE SEE THE README !! V5 IS OFFICIALY OUT !! YOUR CODE NEEDS TO BE [REWRITTEN](https://github.com/PHPSocialNetwork/phpfastcache/wiki/%5BV4%5D-Migrating-your-code-to-the-V5) :exclamation:
+:exclamation: V6 USERS, PLEASE NOTE THAT THE V6 REQUIRES PHP 5.6 AT LEAST :exclamation:
 
 ---------------------------
 Simple Yet Powerful PHP Caching Class
@@ -12,17 +13,17 @@ One Class uses for All Cache. You don't need to rewrite your code many times aga
 ### Supported drivers at this day *
 :bulb: Feel free to propose a driver by making a new **Pull Request**, they are welcome !
 
-|   Regular drivers  | High performances drivers | Development driver |
-|--------------------|---------------------------|--------------------|
-|  `Apc(u)`          | `CouchBase`               | `Devnull`          |
-|  `Cookie`          | `Mongodb`                 | `Devfalse`         |
-|  `Files`           | `Predis`                  | `Devtrue`          |
-|  `Leveldb`         | `Redis`                   |                    |
-|  `Memcache(d)`     | `Ssdb`                    |                    |
-|  `Sqlite`          | `Zend Memory Cache`       |                    |
-|  `Wincache`        |                           |                    |
-|  `Xcache`          |                           |                    |
-|  `Zend Disk Cache` |                           |                    |
+|   Regular drivers  | High performances drivers | Development drivers |
+|--------------------|---------------------------|---------------------|
+|  `Apc(u)`          | `Cassandra`               | `Devnull`           |
+|  `Cookie`          | `CouchBase`               | `Devfalse`          |
+|  `Files`           | `Couchdb`                 | `Devtrue`           |
+|  `Leveldb`         | `Mongodb`                 | `Memstatic`         |
+|  `Memcache(d)`     | `Predis`                  |                     |
+|  `Sqlite`          | `Redis`                   |                     |
+|  `Wincache`        | `Ssdb`                    |                     |
+|  `Xcache`          | `Zend Memory Cache`       |                     |
+|  `Zend Disk Cache` |                           |                     |
 
 \* Driver descriptions available in DOCS/DRIVERS.md
 
@@ -32,7 +33,6 @@ It's fresh, so feel free to report any bug or contribute to the project using pu
 
 Also a [Drupal 8 Module](https://github.com/PHPSocialNetwork/phpfastcache-drupal) is currently in development, add it to your starred projects to get notified of the first public release. 
 
-
 ---------------------------
 Not a "Traditional" Caching
 ---------------------------
@@ -66,7 +66,7 @@ phpFastCache offers you a lot of useful APIs:
 - getKey() // Returns the item identifier (key)
 - get() // The getter, obviously, returns your cache object
 - set($value) // The setter, for those who missed it, putting 0 means cache it forever
-- expiresAfter($ttl) // Allow you to extend the lifetime of an entry without altering its value (formerly known as touch())
+- expiresAfter($ttl) // Allows you to extends the lifetime of an entry without altering its value (formerly known as touch())
 - expiresAt($expiration) // Sets the expiration time for this cache item (as a DateTimeInterface object)
 - increment($step = 1) // To allow us to count on an integer item
 - decrement($step = 1) // Redundant joke...
@@ -82,40 +82,146 @@ phpFastCache offers you a lot of useful APIs:
 - getTags() // Gets the tags
 - getTagsAsString($separator = ', ') // Gets the data as a string separated by $separator
 - removeTag($tagName) // Removes a tag
-- removeTags(array $tagNames) // Removes some tags
-- getDataAsJsonString()// Returns the data as a well-formatted json string
+- removeTags(array $tagNames) // Removes multiple tags
+- getDataAsJsonString()// Return the data as a well-formatted json string
+- setExpirationDate() // Alias of expireAt() (for more code logic)
+- getCreationDate() // Gets the creation date for this cache item (as a DateTimeInterface object)  * 
+- getModificationDate() // Gets the modification date for this cache item (as a DateTimeInterface object) *
+- setCreationDate($expiration) // Sets the creation date for this cache item (as a DateTimeInterface object) *
+- setModificationDate($expiration) // Sets the modification date for this cache item (as a DateTimeInterface object) *
+- setEventManager($evtMngr) // Sets the event manager
+
+\* Require configuration directive "itemDetailedDate" to be enabled
 
 ### ItemPool API
 - getItem($key) // Retrieves an item and returns an empty item if not found
-- getItems(array $keys) // Retrieves one or more items and returns an array of items
-- getItemsAsJsonString(array $keys) // Returns a json string that represents an array of items
+- getItems(array $keys) // Retrieves one or more item and returns an array of items
+- getItemsAsJsonString(array $keys) // Returns A json string that represents an array of items
 - hasItem($key) // Tests if an item exists
 - deleteItem($key) // Deletes an item
 - deleteItems(array $keys) // Deletes one or more items
 - save(CacheItemInterface $item) // Persists a cache item immediately
+- saveMultiple(...$items) // Persists multiple cache items immediately
 - saveDeferred(CacheItemInterface $item); // Sets a cache item to be persisted later
 - commit(); // Persists any deferred cache items
-- clear() // Allows you to completely empty the cache
+- clear() // Allows you to completely empty the cache and restart from the beginning
+- getHelp() // Provides a very basic help for a specific driver
 - getStats() // Returns the cache statistics as an object, useful for checking disk space used by the cache etc.
 - getItemsByTag($tagName) // Returns items by a tag
-- getItemsByTags(array $tagNames) // Returns items by multiple tags
-- getItemsByTagsAsJsonString(array $tagNames) // Returns a json string that represents an array of items corresponding to given tags
+- getItemsByTags(array $tagNames) // Returns items by one of multiple tag names
+- getItemsByTagsAll(array $tagNames) // Returns items by all of multiple tag names
+- getItemsByTagsAsJsonString(array $tagNames) // Returns A json string that represents an array of items corresponding to given tags
 - deleteItemsByTag($tagName) // Deletes items by a tag
-- deleteItemsByTags(array $tagNames) // Deletes items by multiple tags
+- deleteItemsByTags(array $tagNames) // Deletes items  by one of multiple tag names
+- deleteItemsByTagsAll(array $tagNames) // Deletes items by all of multiple tag names
 - incrementItemsByTag($tagName, $step = 1) // Increments items by a tag
-- incrementItemsByTags(array $tagNames, $step = 1) // Increments items by multiple tags
+- incrementItemsByTags(array $tagNames, $step = 1) // Increments items by one of multiple tag names
+- incrementItemsByTagsAll(array $tagNames, $step = 1) // Increments items by all of multiple tag names
 - decrementItemsByTag($tagName, $step = 1) // Decrements items by a tag
-- decrementItemsByTags(array $tagNames, $step = 1) // Decrements items by multiple tags
+- decrementItemsByTags(array $tagNames, $step = 1) // Decrements items by one of multiple tag names
+- decrementItemsByTagsAll(array $tagNames, $step = 1) // Decrements items by all of multiple tag names
 - appendItemsByTag($tagName, $data) // Appends items by a tag
-- appendItemsByTags(array $tagNames, $data) // Appends items by multiple tags
+- appendItemsByTags(array $tagNames, $data) // Appends items by one of multiple tag names
+- appendItemsByTagsAll(array $tagNames, $data) // Appends items by all of multiple tag names
 - prependItemsByTag($tagName, $data) // Prepends items by a tag
-- prependItemsByTags(array $tagNames, $data) // Prepends items by multiple tags
+- prependItemsByTags(array $tagNames, $data) // Prepends items by one of multiple tag names
+- prependItemsByTagsAll(array $tagNames, $data) // Prepends items by all of multiple tag names
 - detachItem($item) // Detaches an item from the pool
 - detachAllItems($item) // Detaches all items from the pool
 - attachItem($item) // (Re-)attaches an item to the pool
-- isAttached($item) // Verifies if an item is (still) attached
+- isAttached($item) // Verify if an item is (still) attached
+- setEventManager(EventManager $evtMngr) // Sets the event manager
+
+It also supports multiple calls, Tagging, Setup Folder for caching. Look at our examples folders for more information.
+
+---------------------------
+Want to keep it simple ?
+---------------------------
+:sweat_smile: Good news, as of the V6, a Psr16 adapter is provided to keep the cache simplest using very basic getters/setters:
+
+- get($key, $default = null);
+- set($key, $value, $ttl = null);
+- delete($key);
+- clear();
+- getMultiple($keys, $default = null);
+- setMultiple($values, $ttl = null);
+- deleteMultiple($keys);
+- has($key);
+
+Basic usage:
+```php
+use phpFastCache\Helper\Psr16Adapter;
+
+$Psr16Adapter = new Psr16Adapter($defaultDriver);
+
+if(!$Psr16Adapter->has('test-key')){
+    // Setter action
+    $data = 'lorem ipsum';
+    $Psr16Adapter->set('test-key', 'lorem ipsum', 300);// 5 minutes
+}else{
+    // Getter action
+    $data = $Psr16Adapter->get('test-key');
+}
+
+
+/**
+* Do your stuff with $data
+*/
+```
+
+Internally, the Psr16 adapter calls the PhpFastCache Api via the cache manager. 
+
+---------------------------
+Introducing to events
+---------------------------
+
+:mega: As of the V6, PhpFastCache provides an event mechanism.
+You can subscribe to an event by passing a Closure to an active event:
+
+```php
+use phpFastCache\EventManager;
+
+/**
+* Bind the event callback
+*/
+EventManager::getInstance()->onCacheGetItem(function(ExtendedCacheItemPoolInterface $itemPool, ExtendedCacheItemInterface $item){
+    $item->set('[HACKED BY EVENT] ' . $item->get());
+});
+
+```
+
+An event callback can get unbind but you MUST provide a name to the callback previously:
+
+```php
+use phpFastCache\EventManager;
+
+/**
+* Bind the event callback
+*/
+EventManager::getInstance()->onCacheGetItem(function(ExtendedCacheItemPoolInterface $itemPool, ExtendedCacheItemInterface $item){
+    $item->set('[HACKED BY EVENT] ' . $item->get());
+}, 'myCallbackName');
+
+
+/**
+* Unbind the event callback
+*/
+EventManager::getInstance()->unbindEventCallback('onCacheGetItem', 'myCallbackName');
+
+```
+
+More information about the implementation and the events available on the [Wiki](https://github.com/PHPSocialNetwork/phpfastcache/wiki/%5BV6%5D-Introducing-to-events)
+
+---------------------------
+Introducing new helpers
+---------------------------
+:books: As of the V6, PhpFastCache provides some helpers to make your code easier.
+
+- The [ActOnAll Helper](https://github.com/PHPSocialNetwork/phpfastcache/wiki/%5BV6%CB%96%5D-Act-on-all-instances) to help you to act on multiple instance at once.
+- The [CacheConditional Helper](https://github.com/PHPSocialNetwork/phpfastcache/wiki/%5BV6%CB%96%5D-Cache-Conditional) to help you to make the basic conditional statement more easier.
+- The [Psr16 adapter](https://github.com/PHPSocialNetwork/phpfastcache/wiki/%5BV6%CB%96%5D-Psr16-adapter) to keep it simple as explained above.
 
-It also supports Multiple calls, Tagging, Setup Folder for caching. Look at our examples folders for more information.
+May more will come in the future, feel free to contribute !
 
 ---------------------------
 As Fast To Implement As Opening a Beer
@@ -175,7 +281,7 @@ echo implode('<br />', $CachedString->get());// Will echo your product list
 ```
 
 ##### :floppy_disk: Legacy / Lazy Method (Without Composer)
-* See the file examples/legacy.php for more information.
+* See the file examples/withoutComposer.php for more information.
 
 #### :zap: Step 3: Enjoy ! Your website is now faster than lightning !
 For curious developpers, there is a lot of other examples available  [here](https://github.com/PHPSocialNetwork/phpfastcache/tree/final/examples).

bin/ci/install_dependencies.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
 
 composer self-update;
-composer update;
+composer install --ignore-platform-reqs;
+composer require "phpfastcache/couchdb:~1.0.0" "phpfastcache/phpssdb:~1.0.0" "predis/predis:~1.1.0" "mongodb/mongodb:^1.1" --ignore-platform-reqs;

bin/ci/php-phpfastcache.ini

@@ -0,0 +1,3 @@
+; Adding required extensions for tests
+extension="memcached.so"
+extension="redis.so"

bin/legacy/Psr/SimpleCache/.editorconfig

@@ -0,0 +1,12 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

bin/legacy/Psr/SimpleCache/LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) 2016 PHP Framework Interoperability Group
+
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+>
+> The above copyright notice and this permission notice shall be included in
+> all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+> THE SOFTWARE.

bin/legacy/Psr/SimpleCache/README.md

@@ -0,0 +1,8 @@
+PHP FIG Simple Cache PSR
+========================
+
+This repository holds all interfaces related to PSR-16.
+
+Note that this is not a cache implementation of its own. It is merely an interface that describes a cache implementation. See [the specification](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-16-simple-cache.md) for more details.
+
+You can find implementations of the specification by looking for packages providing the [psr/simple-cache-implementation](https://packagist.org/providers/psr/simple-cache-implementation) virtual package.

bin/legacy/Psr/SimpleCache/composer.json

@@ -0,0 +1,25 @@
+{
+    "name": "psr/simple-cache",
+    "description": "Common interfaces for simple caching",
+    "keywords": ["psr", "psr-16", "cache", "simple-cache", "caching"],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "PHP-FIG",
+            "homepage": "http://www.php-fig.org/"
+        }
+    ],
+    "require": {
+        "php": ">=5.3.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "Psr\\SimpleCache\\": "src/"
+        }
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-master": "1.0.x-dev"
+        }
+    }
+}

bin/legacy/Psr/SimpleCache/src/CacheException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Psr\SimpleCache;
+
+/**
+ * Interface used for all types of exceptions thrown by the implementing library.
+ */
+interface CacheException
+{
+}