26 KiB
⚠️ Please note that the V7 is a major (BC breaking) update of PhpFastCache !
As the V7 is absolutely not compatible with previous versions, please read carefully the migration guide to ensure you the smoothest migration possible. One of the biggest change 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 V7 requires at least PHP7 or higher to work properly.
🆕 The V8 is now released, upgrade Phpfastcache by following our migration guide in
docs/migration
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.
PHP7 Strict types enforced
As of the V7 PhpFastCache enforces the php7 strict types to make sure that it's completely php7 compatible and is type aware. This ensure you that the library is completely reliable when it come to manipulate variable types.
Supported drivers at this day *
💡 Feel free to propose a driver by making a new Pull Request, they are welcome !
| 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 ❓ |
Riak |
|
Xcache ❓ |
Ssdb |
|
Zend Disk Cache |
Zend Memory Cache |
* Driver descriptions available in DOCS/DRIVERS.md
❓ Please note that as of PHP7 some php extensions were not yet updated (and will may not), we keep the code here but there's no guarantee that they are still working especially due to the cores changes introduced by Opcache.
Symfony/Drupal developers are not forgotten !
Starting with v5, phpFastCache comes with a Symfony Bundle. It is now a mature project Flex -ready, so feel free to give at try and report any bug (if any).
Also a Drupal 8 Module is currently in development, add it to your starred projects to get notified of the first public release.
Not a "Traditional" Caching
phpFastCache is not like the traditional caching methods which keep reading and writing to
files, sqlite or keeping open massive amounts of connections to memcache, redis, mongodb...
Also, when you use high performances drivers, your miss hits will be drastically reduced.
Slightly different from the usual caching libraries you will find everywhere on the internet,
the phpFastCache library reduces the I/O and CPU load as much as possible.
<?php
use Phpfastcache\CacheManager;
CacheManager::getInstance('files', $config);
// An alternative exists:
CacheManager::Files($config);
Reduce Database/Webservice Calls
Your website has 10,000 visitors who are online, and your dynamic page has to send 10,000 times the same queries
to database or the webservice on every page load.
With phpFastCache, your page only sends 1 query to your DB/WS, and uses the cache to serve the 9,999 other visitors.
You can obviously decide the TTL that will matches your needs.
Rich Development API
PhpFastCache provides you a lot of useful APIs:
Item API (ExtendedCacheItemInterface)
| Method | Return | Description |
|---|---|---|
addTag($tagName) |
ExtendedCacheItemInterface | Adds a tag |
addTags(array $tagNames) |
ExtendedCacheItemInterface | Adds multiple tags |
append($data) |
ExtendedCacheItemInterface | Appends data to a string or an array (push) |
decrement($step = 1) |
ExtendedCacheItemInterface | Redundant joke... |
expiresAfter($ttl) |
ExtendedCacheItemInterface | Allows you to extends the lifetime of an entry without altering its value (formerly known as touch()) |
expiresAt($expiration) |
ExtendedCacheItemInterface | Sets the expiration time for this cache item (as a DateTimeInterface object) |
get() |
mixed | The getter, obviously, returns your cache object |
getCreationDate() |
\DatetimeInterface | Gets the creation date for this cache item (as a DateTimeInterface object) * |
getDataAsJsonString() |
string | Return the data as a well-formatted json string |
getEncodedKey() |
string | Returns the final and internal item identifier (key), generally used for debug purposes |
getExpirationDate() |
ExtendedCacheItemInterface | Gets the expiration date as a Datetime object |
getKey() |
string | Returns the item identifier (key) |
getLength() |
int | Gets the data length if the data is a string, array, or objects that implement \Countable interface. |
getModificationDate() |
\DatetimeInterface | Gets the modification date for this cache item (as a DateTimeInterface object) * |
getTags() |
string[] | Gets the tags |
getTagsAsString($separator = ', ') |
string | Gets the data as a string separated by $separator |
getTtl() |
int | Gets the remaining Time To Live as an integer |
increment($step = 1) |
ExtendedCacheItemInterface | To allow us to count on an integer item |
isEmpty() |
bool | Checks if the data is empty or not despite the hit/miss status. |
isExpired() |
bool | Checks if your cache entry is expired |
isHit() |
bool | Checks if your cache entry exists and is still valid, it's the equivalent of isset() |
isNull() |
bool | Checks if the data is null or not despite the hit/miss status. |
prepend($data) |
ExtendedCacheItemInterface | Prepends data to a string or an array (unshift) |
removeTag($tagName) |
ExtendedCacheItemInterface | Removes a tag |
removeTags(array $tagNames) |
ExtendedCacheItemInterface | Removes multiple tags |
set($value) |
ExtendedCacheItemInterface | The setter, for those who missed it, can be anything except resources or non-serializer object (ex: PDO objects, file pointers, etc). |
setCreationDate($expiration) |
\DatetimeInterface | Sets the creation date for this cache item (as a DateTimeInterface object) * |
setEventManager($evtMngr) |
ExtendedCacheItemInterface | Sets the event manager |
setExpirationDate() |
ExtendedCacheItemInterface | Alias of expireAt() (for more code logic) |
setModificationDate($expiration) |
\DatetimeInterface | Sets the modification date for this cache item (as a DateTimeInterface object) * |
setTags(array $tags) |
ExtendedCacheItemInterface | Sets multiple tags |
* Require configuration directive "itemDetailedDate" to be enabled, else a \LogicException will be thrown
ItemPool API (ExtendedCacheItemPoolInterface)
| Method | Return | Description |
|---|---|---|
appendItemsByTag($tagName, $data) |
bool | Appends items by a tag |
appendItemsByTags(array $tagNames, $data) |
bool | Appends items by one of multiple tag names |
appendItemsByTagsAll(array $tagNames, $data) |
bool | Appends items by all 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 |
decrementItemsByTagsAll(array $tagNames, $step = 1) |
bool | Decrements items by all 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) |
bool | Deletes items by one of multiple tag names |
deleteItemsByTagsAll(array $tagNames) |
bool | Deletes items by all of multiple tag names |
detachAllItems() |
void | Detaches all items from the pool |
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) |
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 |
getItemsAsJsonString(array $keys) |
string | Returns A json string that represents an array of items |
getItemsByTag($tagName) |
ExtendedCacheItemInterface[] | Returns items by a tag |
getItemsByTags(array $tagNames) |
ExtendedCacheItemInterface[] | Returns items by one of multiple tag names |
getItemsByTagsAll(array $tagNames) |
ExtendedCacheItemInterface[] | Returns items by all of multiple tag names |
getItemsByTagsAsJsonString(array $tagNames) |
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. |
hasItem($key) |
bool | Tests if an item exists |
incrementItemsByTag($tagName, $step = 1) |
bool | Increments items by a tag |
incrementItemsByTags(array $tagNames, $step = 1) |
bool | Increments items by one of multiple tag names |
incrementItemsByTagsAll(array $tagNames, $step = 1) |
bool | Increments items by all of multiple tag names |
isAttached($item) |
bool | Verify if an item is (still) attached |
prependItemsByTag($tagName, $data) |
bool | Prepends items by a tag |
prependItemsByTags(array $tagNames, $data) |
bool | Prepends items by one of multiple tag names |
prependItemsByTagsAll(array $tagNames, $data) |
bool | Prepends items by all 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(EventManager $evtMngr) |
ExtendedCacheItemPoolInterface | Sets the event manager |
It also supports multiple calls, Tagging, Setup Folder for caching. Look at our examples folders for more information.
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();
Want to keep it simple ?
😅 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;
$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.
Introducing to events
📣 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 are available on the Wiki
Introducing new helpers
📚 As of the V6, PhpFastCache provides some helpers to make your code easier.
- 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 to keep it simple as explained above.
May more will come in the future, feel free to contribute !
As Fast To Implement As Opening a Beer
👍 Step 1: Include phpFastCache in your project with composer:
composer require phpfastcache/phpfastcache
🚧 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
💾 Legacy support (Without Composer)
- See the file examples/withoutComposer.php for more information.
⚡ Step 3: Enjoy ! Your website is now faster than lightning !
For curious developers, there is a lot of other examples available here.
💥 phpFastCache support
Found an issue or have an idea ? Come here and let us know !