Add example to documentation for Cache::remember()

This commit is contained in:
mark_story 2013-10-05 10:56:55 -03:00
parent f146d4334a
commit cb91a2d33c

View file

@ -549,9 +549,20 @@ class Cache {
* will be invoked. The results will then be stored into the cache config * will be invoked. The results will then be stored into the cache config
* at key. * at key.
* *
* Examples:
*
* Using a Closure to provide data, assume $this is a Model:
*
* {{{
* $model = $this;
* $results = Cache::remember('all_articles', function () use ($model) {
* return $model->find('all');
* });
* }}}
*
* @param string $key The cache key to read/store data at. * @param string $key The cache key to read/store data at.
* @param callable $callable The callable that provides data in the case when * @param callable $callable The callable that provides data in the case when
* the cache key is empty. * the cache key is empty. Can be any callable type supported by your PHP.
* @param string $config The cache configuration to use for this operation. * @param string $config The cache configuration to use for this operation.
* Defaults to default. * Defaults to default.
*/ */