Merge pull request #188 from Geolim4/final

Merged 4.0-dev to final

Author: Geolim4

README.md

@@ -10,116 +10,73 @@ Supported: Redis, Predis, Cookie, Files, MemCache, MemCached, APC, WinCache, X-C
 
 ---------------------------
 Reduce Database Calls
+---------------------------
 
 Your website have 10,000 visitors who are online, and your dynamic page have to send 10,000 same queries to database on every page load.
 With phpFastCache, your page only send 1 query to DB, and use the cache to serve 9,999 other visitors.
 
-```php
-<?php
-/*
- * Welcome to Learn Lesson
- * This is very Simple PHP Code of Caching
- */
-
-// Require Library
-// Keep it Auto or setup it as "files","sqlite","wincache" ,"apc","memcache","memcached", "xcache"
-require_once("phpfastcache.php");
-phpFastCache::setup("storage","auto");
-// phpFastCache::setup("storage","files");
-// OR open phpfastcache.php and edit your config value there
-
-// simple Caching with:
-$cache = phpFastCache();
-// $cache = phpFastCache("redis");
-
-// Try to get $products from Caching First
-// product_page is "identity keyword";
-$products = $cache->get("product_page");
-
-if($products == null) {
-    $products = "DB QUERIES | FUNCTION_GET_PRODUCTS | ARRAY | STRING | OBJECTS";
-    // Write products to Cache in 10 minutes with same keyword
-    $cache->set("product_page",$products , 600);
-}
-
-// use your products here or return it;
-echo $products;
-```
 ---------------------------
-```php
-<?php
-
-/*
- * List of function and example
- */
-require_once("phpfastcache.php");
-$cache = phpFastCache();
-
-// Write into cache
-$cache->set("keyword", "data | array | object", 300);
-$cache->set("keyword", "data | array | object"); // <-- Non-Expired Objects without Time, until you delete the cache.
-
-// Read from Cache | return "null" or "data"
-$data = $cache->get("keyword");
-echo $data;
-
-// Temporary disabled phpFastCache
-phpFastCache::$disabled = true;
-$data = $cache->get("keyword");
-echo $data; // ALWAYS RETURN NULL;
-
-// Read object information | value | time from cache
-$object = $cache->getInfo("keyword");
-print_r($object);
+Rich Development API
+---------------------------
 
-// Delete from cache
-$cache->delete("keyword");
+Phpfastcache offers you a lot of usefull APIS:
 
-// Clean up all cache
-$cache->clean();
+- get() // The getter, obviously
+- set() // The setter, for those who missed it
+- delete() // For removing a cached thing
+- clean() // Allow you to completely empty the cache and restart from the beginning
+- touch() // Allow you to extends the lifetime of an entry without altering the value 
+- increment() // For integer that we can count on
+- decrement() // Redundant joke...
+- search() // Allow you to perform some search on the cache index
+- isExisting() // Check if your cache entry exists, it is the equivalent of isset()
+- stats() // Return the cache statistics, useful for checking disk space used by the cache etc.
 
-// Stats
-$array = $cache->stats();
-print_r($array);
+---------------------------
+As Fast To Implement As Opening a Beer
+---------------------------
 
-// Increase and Decrease Cache value - Return  true | false
-$cache->increment("keyword", 1);
-$cache->decrement("keyword", 1);
 
-// Extend expiring time - Return true | false;
-$cache->touch("keyword", 1000);
+#### Step 1: Include phpfastcache in your project with composer:
 
-// Check Existing or not - Return true | false;
-$cache->isExisting("keyword");
 
-// Get & Set Multiple Items
-// Same as above, but input is array();
+```bash
+composer require phpfastcache/phpfastcache
+```
 
-$list = $cache->getMulti(array("key1","key2","key3"));
+#### Step 2: Setup your website code to implements phpfastcache bits
+```php
+use Phpfastcache\core\InstanceManager;
 
-$list = $cache->getInfoMulti(array("key1","key2","key3"));
+// Include composer autoloader
+require '../vendor/autoload.php';
 
-$cache->setMulti(array("key1","value1", 300),
-    array("key2","value2", 600),
-    array("key3","value3", 1800));
+$cache = InstanceManager::getInstance();
 
-$cache->deleteMulti(array("key1","key2","key3"));
+/**
+ * Try to get $products from Caching First
+ * product_page is "identity keyword";
+ */
+$key = "product_page";
+$products = $cache->get($key);
 
-$cache->isExistingMulti(array("key1","key2","key3"));
+if (is_null($products)) {
+    $products = "DB QUERIES | FUNCTION_GET_PRODUCTS | ARRAY | STRING | OBJECTS";
+    // Write products to Cache in 10 minutes with same keyword
+    $cache->set($key, $products, 600);
 
-$cache->touchMulti(array(
-                    array("key", 300),
-                    array("key2", 400),
-                   ));
+    echo " --> NO CACHE ---> DB | Func | API RUN FIRST TIME ---> ";
 
-$cache->incrementMulti(array(
-                        array("key", 1),
-                        array("key2", 2),
-                    ));
+} else {
+    echo " --> USE CACHE --> SERV 10,000+ Visitors FROM CACHE ---> ";
+}
 
-$cache->decrementMulti(array(
-                        array("key", 1),
-                        array("key2", 2),
-                    ));
+/**
+ * use your products here or return it;
+ */
+echo $products;
 
 ```
+#### Step 3: Enjoy ! Your website is now faster than flash !
+
+For curious developpers, there is a lot of others available examples [here](https://github.com/khoaofgod/phpfastcache/tree/final/examples)