Skip to content

Home

Jump to bottom
Geolim4-dev edited this page Jan 31, 2018 · 38 revisions

Simple Yet Powerful PHP Caching Class

More information in Wiki One Class uses for All Cache. You don't need to rewrite your code many times again.

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 Ssdb
Xcache Zend Memory Cache
Zend Disk Cache

* Driver descriptions available in DOCS/DRIVERS.md

Symfony/Drupal developers are not forgotten !

Starting with v5, phpFastCache comes with a Symfony Bundle. It's fresh, so feel free to report any bug or contribute to the project using pull requests.

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 Memcache / Memcached, your miss hits will be reduced. Different from the usual caching methods you'll find everywhere on the internet, the phpFastCache library reduces high I/O load, and is faster than the traditional caching methods by at least ~7 times. However, when you still want to use traditional caching methods, we support them too.

use phpFastCache\CacheManager;

CacheManager::getInstance('files', $config);
// An alternative exists:
CacheManager::Files($config);

Reduce Database 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 on every page load. With phpFastCache, your page only sends 1 query to your DB, and uses the cache to serve the 9,999 other visitors.

Rich Development API

phpFastCache offers you a lot of useful APIs:

Item API

  • 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) // 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...
  • append($data) // Appends data to a string or an array (push)
  • prepend($data) // Prepends data to a string or an array (unshift)
  • isHit() // Checks if your cache entry exists and is still valid, it's the equivalent of isset()
  • isExpired() // Checks if your cache entry is expired
  • getTtl() // Gets the remaining Time To Live as an integer
  • getExpirationDate() // Gets the expiration date as a Datetime object
  • addTag($tagName) // Adds a tag
  • addTags(array $tagNames) // Adds multiple tags
  • setTags(array $tags) // Sets multiple tags
  • getTags() // Gets the tags
  • getTagsAsString($separator = ', ') // Gets the data as a string separated by $separator
  • removeTag($tagName) // Removes a tag
  • 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 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 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 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 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 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 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 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 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) // 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 ?

😅 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:

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

📣 As of the V6, PhpFastCache provides an event mechanism. You can subscribe to an event by passing a Closure to an active event:

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:

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

Introducing new helpers

📚 As of the V6, PhpFastCache provides some helpers to make your code easier.

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)

use phpFastCache\CacheManager;

// Setup File Path on your config files
CacheManager::setup(array(
    "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'
    // etc...
];

if (is_null($CachedString->get())) {
    $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 / Lazy Method (Without Composer)
  • See the file examples/withoutComposer.php for more information.

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

For curious developpers, there is a lot of other examples available here.

💥 phpFastCache support

Found an issue or have an idea ? Come here and let us know !

❓ Finally, if you need help, always check out the inevitable README.md

Clone this wiki locally