added comments to cache classes.

This commit is contained in:
Taylor Otwell 2011-09-28 22:55:48 -05:00
parent cc625e24c2
commit 288781c0df
2 changed files with 21 additions and 2 deletions

View File

@ -15,8 +15,13 @@ abstract public function has($key);
/**
* Get an item from the cache.
*
* A default value may also be specified, and will be returned in the requested
* item does not exist in the cache.
* <code>
* // Get an item from the cache driver
* $name = Cache::driver('name');
*
* // Return a default value if the requested item isn't cached
* $name = Cache::get('name', 'Taylor');
* </code>
*
* @param string $key
* @param mixed $default
@ -41,6 +46,11 @@ abstract protected function retrieve($key);
/**
* Write an item to the cache for a given number of minutes.
*
* <code>
* // Put an item in the cache for 15 minutes
* Cache::put('name', 'Taylor', 15);
* </code>
*
* @param string $key
* @param mixed $value
* @param int $minutes
@ -52,6 +62,14 @@ abstract public function put($key, $value, $minutes);
* Get an item from the cache. If the item doesn't exist in the cache, store
* the default value in the cache and return it.
*
* <code>
* // Get an item from the cache, or cache a value for 15 minutes if it doesn't exist
* $name = Cache::remember('name', 'Taylor', 15);
*
* // Use a closure for deferred execution
* $count = Cache::remember('count', function() { return User::count(); }, 15);
* </code>
*
* @param string $key
* @param mixed $default
* @param int $minutes

View File

@ -61,6 +61,7 @@ protected function retrieve($key)
*/
public function put($key, $value, $minutes)
{
// The expiration time is stored as a UNIX timestamp at the beginning of the file.
F::put($this->path.$key, (time() + ($minutes * 60)).serialize($value));
}