Permalink
Browse files

Added doc blocks for WincacheEngine. Fixed Memcache doc block.

  • Loading branch information...
1 parent ed8daf8 commit 826001adc7de69e13a5520455f3b302f00d673a3 @majna majna committed Aug 10, 2011
Showing with 24 additions and 13 deletions.
  1. +11 −6 app/Config/core.php
  2. +2 −1 lib/Cake/Cache/Cache.php
  3. +11 −6 lib/Cake/Console/Templates/skel/Config/core.php
View
@@ -247,7 +247,6 @@
* 'serialize' => true, [optional]
* ));
*
- *
* APC (http://pecl.php.net/package/APC)
*
* Cache::config('default', array(
@@ -263,12 +262,11 @@
* 'engine' => 'Xcache', //[required]
* 'duration'=> 3600, //[optional]
* 'probability'=> 100, //[optional]
- * 'prefix' => Inflector::slug(APP_DIR) . '_', //[optional] prefix every cache file with this string
+ * 'prefix' => Inflector::slug(APP_DIR) . '_', //[optional] prefix every cache file with this string
* 'user' => 'user', //user from xcache.admin.user settings
- * 'password' => 'password', //plaintext password (xcache.admin.pass)
+ * 'password' => 'password', //plaintext password (xcache.admin.pass)
* ));
*
- *
* Memcache (http://www.danga.com/memcached/)
*
* Cache::config('default', array(
@@ -281,9 +279,16 @@
* ), //[optional]
* 'persistent' => true, // [optional] set this to false for non-persistent connections
* 'compress' => false, // [optional] compress data in Memcache (slower, but uses less memory)
- * 'persistent' => true, // [optional] set this to false for non-persistent connections
* ));
+ *
+ * Wincache (http://php.net/wincache)
*
+ * Cache::config('default', array(
+ * 'engine' => 'Wincache', //[required]
+ * 'duration'=> 3600, //[optional]
+ * 'probability'=> 100, //[optional]
+ * 'prefix' => Inflector::slug(APP_DIR) . '_', //[optional] prefix every cache file with this string
+ * ));
*/
/**
@@ -315,7 +320,7 @@
));
/**
- * Configure the cache for model, and datasource caches. This cache configuration
+ * Configure the cache for model and datasource caches. This cache configuration
* is used to store schema descriptions, and table listings in connections.
*/
Cache::config('_cake_model_', array(
@@ -82,14 +82,15 @@ class Cache {
*
* `Cache::config('default');`
*
- * There are 4 built-in caching engines:
+ * There are 5 built-in caching engines:
*
* - `FileEngine` - Uses simple files to store content. Poor performance, but good for
* storing large objects, or things that are not IO sensitive.
* - `ApcEngine` - Uses the APC object cache, one of the fastest caching engines.
* - `MemcacheEngine` - Uses the PECL::Memcache extension and Memcached for storage.
* Fast reads/writes, and benefits from memcache being distributed.
* - `XcacheEngine` - Uses the Xcache extension, an alternative to APC.
+ * - `WincacheEngine` - Uses Windows Cache Extension for PHP. Supports wincache 1.1.0 and higher.
*
* The following keys are used in core cache engines:
*
@@ -247,7 +247,6 @@
* 'serialize' => true, [optional]
* ));
*
- *
* APC (http://pecl.php.net/package/APC)
*
* Cache::config('default', array(
@@ -263,12 +262,11 @@
* 'engine' => 'Xcache', //[required]
* 'duration'=> 3600, //[optional]
* 'probability'=> 100, //[optional]
- * 'prefix' => Inflector::slug(APP_DIR) . '_', //[optional] prefix every cache file with this string
+ * 'prefix' => Inflector::slug(APP_DIR) . '_', //[optional] prefix every cache file with this string
* 'user' => 'user', //user from xcache.admin.user settings
- * 'password' => 'password', //plaintext password (xcache.admin.pass)
+ * 'password' => 'password', //plaintext password (xcache.admin.pass)
* ));
*
- *
* Memcache (http://www.danga.com/memcached/)
*
* Cache::config('default', array(
@@ -281,9 +279,16 @@
* ), //[optional]
* 'persistent' => true, // [optional] set this to false for non-persistent connections
* 'compress' => false, // [optional] compress data in Memcache (slower, but uses less memory)
- * 'persistent' => true, // [optional] set this to false for non-persistent connections
* ));
+ *
+ * Wincache (http://php.net/wincache)
*
+ * Cache::config('default', array(
+ * 'engine' => 'Wincache', //[required]
+ * 'duration'=> 3600, //[optional]
+ * 'probability'=> 100, //[optional]
+ * 'prefix' => Inflector::slug(APP_DIR) . '_', //[optional] prefix every cache file with this string
+ * ));
*/
/**
@@ -315,7 +320,7 @@
));
/**
- * Configure the cache for model, and datasource caches. This cache configuration
+ * Configure the cache for model and datasource caches. This cache configuration
* is used to store schema descriptions, and table listings in connections.
*/
Cache::config('_cake_model_', array(

0 comments on commit 826001a

Please sign in to comment.