cakephp-1.3 > Cache :: config()
A AclBase AclBehavior AclComponent AclNode AclShell Aco AcoAction AjaxHelper ApcEngine ApiShell App AppController AppController AppHelper AppHelper AppModel AppModel Aro AuthComponent B BakeShell BakeTask BehaviorCollection C Cache CacheEngine CacheHelper CakeErrorController CakeLog CakeRoute CakeSchema CakeSession CakeSocket ClassRegistry Component Configure ConnectionManager ConsoleShell ContainableBehavior Controller ControllerTask CookieComponent D DataSource DbAcl DbAclSchema DbConfigTask DboMssql DboMysql DboMysqlBase DboMysqli DboOracle DboPostgres DboSource DboSqlite Debugger Dispatcher E EmailComponent ErrorHandler ErrorHandler ExtractTask F File FileEngine FileLog FixtureTask Folder FormHelper H Helper HtmlHelper HttpSocket I I18n I18nModel i18nSchema I18nShell Inflector IniAcl J JavascriptHelper JqueryEngineHelper JsBaseEngineHelper JsHelper L L10n M MagicDb MagicFileResource MediaView MemcacheEngine Model ModelBehavior ModelTask MootoolsEngineHelper Multibyte N NumberHelper O Object Overloadable Overloadable Overloadable2 Overloadable2 P PagesController PagesController PaginatorHelper Permission PluginShortRoute PluginTask ProjectTask PrototypeEngineHelper R RequestHandlerComponent Router RssHelper S Sanitize Scaffold ScaffoldView SchemaShell Security SecurityComponent SessionComponent SessionHelper SessionsSchema Set Shell ShellDispatcher String T TemplateTask TestSuiteShell TestTask TextHelper ThemeView TimeHelper TranslateBehavior TreeBehavior V Validation View ViewTask X XcacheEngine Xml XmlElement XmlHelper XmlManager XmlNode XmlTextNode

config

line:114 at /cake/libs/cache.php
Set the cache configuration to use. config() can both create new configurations, return the settings for already configured configurations. It also sets the 'default' configuration to use for subsequent operations.

Method

(array(engine,) config ($name = null, $settings = array())

Parameters

ParameterTypeCommentDefault
$name string optional Name of the configuration null
$settings array optional Optional associative array of settings passed to the engine array()

Return

array(engine,

Comment

Set the cache configuration to use. config() can
both create new configurations, return the settings for already configured
configurations. It also sets the 'default' configuration to use for subsequent
operations.

To create a new configuration:

`Cache::config('my_config', array('engine' => 'File', 'path' => TMP));`

To get the settings for a configuration, and set it as the currently selected configuration

`Cache::config('default');`

The following keys are used in core cache engines:

- `duration` Specify how long items in this cache configuration last.
- `prefix` Prefix appended to all entries. Good for when you need to share a keyspace
with either another cache config or annother application.
- `probability` Probability of hitting a cache gc cleanup. Setting to 0 will disable
cache::gc from ever being called automatically.
- `servers' Used by memcache. Give the address of the memcached servers to use.
- `compress` Used by memcache. Enables memcache's compressed format.
- `serialize` Used by FileCache. Should cache objects be serialized first.
- `path` Used by FileCache. Path to where cachefiles should be saved.
- `lock` Used by FileCache. Should files be locked before writing to them?
- `user` Used by Xcache. Username for XCache
- `password` Used by Xcache. Password for XCache

@see app/config/core.php for configuration settings
@param string $name Name of the configuration
@param array $settings Optional associative array of settings passed to the engine
@return array(engine, settings) on success, false on failure
@access public
@static