library phpfastcache {🖫 296,878, ⚐ 149, ★ 1,790}

phpfastcache/phpfastcache

PHP Abstract Cache Class - Reduce your database call using cache system. PhpFastCache handles a lot of drivers such as Apc(u), Cassandra, CouchBase, Couchdb, Mongodb, Files, (P)redis, Leveldb, Memcache(d), Ssdb, Sqlite, Wincache, Xcache, Zend Data Cache.

Wednesday, July 25, 2018
by khoaofgod
Repository
140 Watchers
1790 Stars
296,878 Installations

PHP
70 Dependents
8 Suggesters
398 Forks
0 Open issues
100 Versions
15 % Grown

The README.md

, _(*1)

:warning: Please note that the V9 is mostly a PHP 8 type aware update of Phpfastcache with some significant changes !

As the V9 is relatively not compatible with previous versions, please read carefully the migration guide to ensure you the smoothest migration possible. One of the biggest changes is the configuration system which is now an object that replace the primitive array that we used to implement back then. Also, please note that the V9 requires at least PHP 8 or higher to works properly., _(*2)

Simple Yet Powerful PHP Caching Class

More information in Wiki The simplicity of abstraction: One class for many backend cache. You don't need to rewrite your code many times again., _(*3)

Supported drivers at this day *

:bulb: Feel free to propose a driver by making a new Pull Request, they are welcome !, _(*4)

Regular drivers	High performances drivers	Development drivers (Core)	Cluster-Aggregated drivers (Core)
`Apcu` (Core) _(APC support removed)_	`Arangodb` (Extension)	`Devnull`	`FullReplicationCluster`
`Dynamodb` (Extension)	`Cassandra` (PHP extension is no more maintained by Datastax, might be deprecated in v10)	`Devrandom`	`SemiReplicationCluster`
`Files` (Core)	`CouchBasev3` (Core)_ (Will be deprecated as of v10)_	`Memory` (Previously named `Memstatic`)	`MasterSlaveReplicationCluster`
`Firestore` (Extension)	`CouchBasev4` (Extension)		`RandomReplicationCluster`
`Leveldb` (Core)	`Couchdb` (Extension)
`Memcache(d)` (Core)	`Mongodb` (Extension)
`Solr` (Extension)	`Predis` (Core)
`Sqlite` (Core)	`Ravendb` _(Extension)
`Wincache` (Core) (Deprecated as of v9.2, will be removed as of v10)	`Relay` (By end of 2024)
`Zend Disk Cache` (Core)	`Redis`/`RedisCluster` (Core)
`Ssdb` (Core)
`Zend Memory Cache` (Core)

* Driver descriptions available in DOCS/DRIVERS.md, _(*5)

:new: As of v9.2 a new Couchbase extension has been released: Couchbasev4 Also a new driver extension has been added: Ravendb. The driver will be actively developed in the feature to allow better fine-grained configuration. This new extension is the beginning of a new era for Phpfastcache along with some others:\ Many drivers has been moved from the core to their own sub-repository as a standalone extension: Arangodb, Couchdb, Dynamodb, Firestore, Mongodb, Solr.\ They can be easily added through composer, ex: composer install phpfastcache/couchbasev4-extension However Couchbasev3 will stay in the core for compatibility reasons but will be deprecated., _(*6)

Because caching does not mean weaken your code

Phpfastcache has been developed over the years with 3 main goals:, _(*7)

Performance: We optimized and still optimize the code to provide you the lightest library as possible
Security: Because caching strategies can sometimes comes with unwanted vulnerabilities, we do our best to provide you a sage & strong library as possible
Portability: No matter what operating system you're working on, we did our best to provide you the most cross-platform code as possible

Rich Development API

Phpfastcache provides you a lot of useful APIs:, _(*8)

Item API (ExtendedCacheItemInterface)

| Method |--------------------------------- | addTag($tagName) | addTags(array $tagNames) | append($data) | decrement($step = 1) | expiresAfter($ttl) | expiresAt($expiration) | get() | getCreationDate() | getDataAsJsonString() | getEncodedKey() | getExpirationDate() | getKey() | getLength() | getModificationDate() | getTags() | hasTag(string $tagName) | hasTags(array $tagNames, | isTagged(): bool | getTagsAsString($separator | getTtl() | increment($step = 1) | isEmpty() | isExpired() | isHit() | isNull() | prepend($data) | removeTag($tagName) | removeTags(array $tagNames) | set($value) | setCreationDate($expiration) | setEventManager($evtMngr) | setExpirationDate() | setModificationDate($expiration) | setTags(array $tags) * Require configuration directive | Return | Description | ----------------|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------| | ExtendedCacheItemInterface | Adds a tag | | ExtendedCacheItemInterface | Adds multiple tags | | ExtendedCacheItemInterface | Appends data to a string or an array (push) | | ExtendedCacheItemInterface | Redundant joke... | | ExtendedCacheItemInterface | Allows you to extends the lifetime of an entry without altering its value (formerly known as touch()) | | ExtendedCacheItemInterface | Sets the expiration time for this cache item (as a DateTimeInterface object) | | mixed | The getter, obviously, returns your cache object | | \DatetimeInterface | Gets the creation date for this cache item (as a DateTimeInterface object) * | | string | Return the data as a well-formatted json string | | string | Returns the final and internal item identifier (key), generally used for debug purposes | | ExtendedCacheItemInterface | Gets the expiration date as a Datetime object | | string | Returns the item identifier (key) | | int | Gets the data length if the data is a string, array, or objects that implement \Countable interface. | | \DatetimeInterface | Gets the modification date for this cache item (as a DateTimeInterface object) * | | string[] | Gets the tags | | bool | Check if the cache item contain one specific tag | int $strategy): bool | bool | Check if the cache item contain one or more specific tag with optional strategy (default to TAG_STRATEGY_ONE) | | bool | Check if the cache item has at least one tag (v9.2) | = ', ') | string | Gets the data as a string separated by $separator | | int | Gets the remaining Time To Live as an integer | | ExtendedCacheItemInterface | To allow us to count on an integer item | | bool | Checks if the data is empty or not despite the hit/miss status. | | bool | Checks if your cache entry is expired | | bool | Checks if your cache entry exists and is still valid, it's the equivalent of isset() | | bool | Checks if the data is null or not despite the hit/miss status. | | ExtendedCacheItemInterface | Prepends data to a string or an array (unshift) | | ExtendedCacheItemInterface | Removes a tag | | ExtendedCacheItemInterface | Removes multiple tags | | ExtendedCacheItemInterface | The setter, for those who missed it, can be anything except resources or non-serializer object (ex: PDO objects, file pointers, etc). | | \DatetimeInterface | Sets the creation date for this cache item (as a DateTimeInterface object) * | | ExtendedCacheItemInterface | Sets the event manager | | ExtendedCacheItemInterface | Alias of expireAt() (for more code logic) | | \DatetimeInterface | Sets the modification date for this cache item (as a DateTimeInterface object) * | | ExtendedCacheItemInterface | Sets multiple tags | "itemDetailedDate" to be enabled, else a \LogicException will be thrown, _(*9)

ItemPool API (ExtendedCacheItemPoolInterface)

Methods (By Alphabetic Order)	Return	Description
`appendItemsByTag($tagName, $data)`	`bool`	Appends items by a tag
`appendItemsByTags(array $tagNames, $data)`	`bool`	Appends items by one of multiple tag names
`attachItem($item)`	`void`	(Re-)attaches an item to the pool
`clear()`	`bool`	Allows you to completely empty the cache and restart from the beginning
`commit()`	`bool`	Persists any deferred cache items
`decrementItemsByTag($tagName, $step = 1)`	`bool`	Decrements items by a tag
`decrementItemsByTags(array $tagNames, $step = 1)`	`bool`	Decrements items by one of multiple tag names
`deleteItem($key)`	`bool`	Deletes an item
`deleteItems(array $keys)`	`bool`	Deletes one or more items
`deleteItemsByTag($tagName)`	`bool`	Deletes items by a tag
`deleteItemsByTags(array $tagNames, int $strategy)`	`bool`	Deletes items by one of multiple tag names
`detachItem($item)`	`void`	Detaches an item from the pool
`getConfig()`	`ConfigurationOption`	Returns the configuration object
`getConfigOption($optionName);`	`mixed`	Returns a configuration value by its key `$optionName`
`getDefaultConfig()`	`ConfigurationOption`	Returns the default configuration object (not altered by the object instance)
`getDriverName()`	`string`	Returns the current driver name (without the namespace)
`getEventManager()`	`EventManagerInterface`	Gets the event manager
`getHelp()`	`string`	Provides a very basic help for a specific driver
`getInstanceId()`	`string`	Returns the instance ID
`getItem($key)`	`ExtendedCacheItemInterface`	Retrieves an item and returns an empty item if not found
`getItems(array $keys)`	`ExtendedCacheItemInterface[]`	Retrieves one or more item and returns an array of items. As of v9.2 an internal improvement has been made to this method.
`getAllItems(string $pattern = '')`	`ExtendedCacheItemInterface[]`	(v9.2) Retrieves all cache items with a hard limit of 9999 items. Support limited to some drivers
`getItemsAsJsonString(array $keys)`	`string`	Returns A json string that represents an array of items
`getItemsByTag($tagName, $strategy)`	`ExtendedCacheItemInterface[]`	Returns items by a tag
`getItemsByTags(array $tagNames, $strategy)`	`ExtendedCacheItemInterface[]`	Returns items by one of multiple tag names
`getItemsByTagsAsJsonString(array $tagNames, $strategy)`	`string`	Returns A json string that represents an array of items corresponding
`getStats()`	`DriverStatistic`	Returns the cache statistics as an object, useful for checking disk space used by the cache etc.
`hasEventManager()`	`bool`	Check the event manager
`hasItem($key)`	`bool`	Tests if an item exists
`incrementItemsByTag($tagName, $step = 1, $strategy)`	`bool`	Increments items by a tag
`incrementItemsByTags(array $tagNames, $step = 1, $strategy)`	`bool`	Increments items by one of multiple tag names
`isAttached($item)`	`bool`	Verify if an item is (still) attached
`prependItemsByTag($tagName, $data, $strategy)`	`bool`	Prepends items by a tag
`prependItemsByTags(array $tagNames, $data, $strategy)`	`bool`	Prepends items by one of multiple tag names
`save(CacheItemInterface $item)`	`bool`	Persists a cache item immediately
`saveDeferred(CacheItemInterface $item)`	`bool`	Sets a cache item to be persisted later
`saveMultiple(...$items)`	`bool`	Persists multiple cache items immediately
`setEventManager(EventManagerInterface $evtMngr)`	`ExtendedCacheItemPoolInterface`	Sets the event manager

:new: in V8: Multiple strategies ($strategy) are now supported for tagging: - TaggableCacheItemPoolInterface::TAG_STRATEGY_ONE allows you to get cache item(s) by at least ONE of the specified matching tag(s). Default behavior. - TaggableCacheItemPoolInterface::TAG_STRATEGY_ALL allows you to get cache item(s) by ALL of the specified matching tag(s) (the cache item can have additional tag(s)) - TaggableCacheItemPoolInterface::TAG_STRATEGY_ONLY allows you to get cache item(s) by ONLY the specified matching tag(s) (the cache item cannot have additional tag(s)), _(*10)

It also supports multiple calls, Tagging, Setup Folder for caching. Look at our examples folders for more information., _(*11)

Phpfastcache versioning API

Phpfastcache provides a class that gives you basic information about your Phpfastcache installation - Get the API version (Item+Pool interface) with Phpfastcache\Api::GetVersion(); - Get the API changelog (Item+Pool interface) Phpfastcache\Api::getChangelog(); - Get the Phpfastcache version with Phpfastcache\Api::getPhpfastcacheVersion(); - Get the Phpfastcache changelog Phpfastcache\Api::getPhpfastcacheChangelog();, _(*12)

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:, _(*13)

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:, _(*14)

<?php

use Phpfastcache\Helper\Psr16Adapter;

$defaultDriver = 'Files';
$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., _(*15)

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:, _(*16)

<?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:, _(*17)

<?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');

:new: As of the V8 you can simply subscribe to every event of Phpfastcache., _(*18)

More information about the implementation and the events are available on the Wiki, _(*19)

Introducing new helpers

:books: As of the V6, Phpfastcache provides some helpers to make your code easier., _(*20)

(:warning: Removed in v8, why ?) ~~The ActOnAll Helper to help you to act on multiple instance at once.~~
The CacheConditional Helper to help you to make the basic conditional statement more easier.
The Psr16 adapter

May more will come in the future, feel free to contribute !, _(*21)

Introducing aggregated cluster support

Check out the WIKI to learn how to implement aggregated cache clustering feature., _(*22)

As Fast To Implement As Opening a Beer

:thumbsup: Step 1: Include phpFastCache in your project with composer:

composer require phpfastcache/phpfastcache

:construction: Step 2: Setup your website code to implement the phpFastCache calls (with Composer)

<?php
use Phpfastcache\CacheManager;
use Phpfastcache\Config\ConfigurationOption;

// Setup File Path on your config files
// Please note that as of the V6.1 the "path" config 
// can also be used for Unix sockets (Redis, Memcache, etc)
CacheManager::setDefaultConfig(new ConfigurationOption([
    'path' => '/var/www/phpfastcache.com/dev/tmp', // or in windows "C:/tmp/"
]));

// In your class, function, you can call the Cache
$InstanceCache = CacheManager::getInstance('files');

/**
 * Try to get $products from Caching First
 * product_page is "identity keyword";
 */
$key = "product_page";
$CachedString = $InstanceCache->getItem($key);

$your_product_data = [
    'First product',
    'Second product',
    'Third product'
     /* ... */
];

if (!$CachedString->isHit()) {
    $CachedString->set($your_product_data)->expiresAfter(5);//in seconds, also accepts Datetime
    $InstanceCache->save($CachedString); // Save the cache item just like you do with doctrine and entities

    echo 'FIRST LOAD // WROTE OBJECT TO CACHE // RELOAD THE PAGE AND SEE // ';
    echo $CachedString->get();

} else {
    echo 'READ FROM CACHE // ';
    echo $CachedString->get()[0];// Will print 'First product'
}

/**
 * use your products here or return them;
 */
echo implode('<br />', $CachedString->get());// Will echo your product list

:zap: Step 3: Enjoy ! Your website is now faster than lightning !

For curious developers, there is a lot of other examples available here., _(*23)

:boom: Phpfastcache support

Found an issue or have an idea ? Come here and let us know !, _(*24)

The Versions

25/07 2018

dev-master

9999999-dev https://www.phpfastcache.com

library phpfastcache

PHP Abstract Cache Class - Reduce your database call using cache system. PhpFastCache handles a lot of drivers such as Apc(u), Cassandra, CouchBase, Couchdb, Mongodb, Files, (P)redis, Leveldb, Memcache(d), Ssdb, Sqlite, Wincache, Xcache, Zend Data Cache.

phpfastcache/phpfastcache

The README.md

:warning: Please note that the V9 is mostly a PHP 8 type aware update of Phpfastcache with some significant changes !

Simple Yet Powerful PHP Caching Class

Supported drivers at this day *

Because caching does not mean weaken your code

Rich Development API

Item API (ExtendedCacheItemInterface)

ItemPool API (ExtendedCacheItemPoolInterface)

Phpfastcache versioning API

Want to keep it simple ?

Introducing to events

Introducing new helpers

Introducing aggregated cluster support

As Fast To Implement As Opening a Beer

:thumbsup: Step 1: Include phpFastCache in your project with composer:

:construction: Step 2: Setup your website code to implement the phpFastCache calls (with Composer)

:zap: Step 3: Enjoy ! Your website is now faster than lightning !

:boom: Phpfastcache support

The Versions

dev-master

The Requires

by Khoa Bui

by Georges.L

7.0.2

The Requires

by Khoa Bui

by Georges.L

7.0.1

The Requires

by Khoa Bui

by Georges.L

v6.x-dev

The Requires

by Khoa Bui

by Georges.L

6.1.3

The Requires

by Khoa Bui

by Georges.L

v5.x-dev

The Requires

by Khoa Bui

by Georges.L

7.0.0

The Requires

by Khoa Bui

by Georges.L

7.0.0-RC4

The Requires

by Khoa Bui

by Georges.L

7.0.0-RC3

The Requires

by Khoa Bui

by Georges.L

7.0.0-RC2

The Requires

by Khoa Bui

by Georges.L

v7.x-dev

The Requires

by Khoa Bui

by Georges.L

7.0.0-rc

The Requires

by Khoa Bui

by Georges.L

dev-final

The Requires

by Khoa Bui

by Georges.L

6.1.2

The Requires

by Khoa Bui

by Georges.L

7.0.0-beta3

The Requires