cakephp-1.3 > Cache :: read()
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

read

line:344 at /cake/libs/cache.php
Read a key from the cache. Will automatically use the currently active cache configuration. To set the currently active configuration use Cache::config()

Method

(mixed) read ($key, $config = null)

Parameters

ParameterTypeCommentDefault
$key string required Identifier for the data
$config string optional optional name of the configuration to use. null

Return

mixed

Comment

Read a key from the cache. Will automatically use the currently
active cache configuration. To set the currently active configuration use
Cache::config()

### Usage:

Reading from the active cache configuration.

`Cache::read('my_data');`

Reading from a specific cache configuration.

`Cache::read('my_data', 'long_term');`

@param string $key Identifier for the data
@param string $config optional name of the configuration to use.
@return mixed The cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it
@access public
@static