100 lines
2.3 KiB
PHP
100 lines
2.3 KiB
PHP
<?php namespace Laravel\Cache;
|
|
|
|
abstract class Driver {
|
|
|
|
/**
|
|
* Determine if an item exists in the cache.
|
|
*
|
|
* <code>
|
|
* // Determine if the "name" item exists in the cache
|
|
* $exists = Cache::driver()->has('name');
|
|
* </code>
|
|
*
|
|
* @param string $key
|
|
* @return bool
|
|
*/
|
|
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 the "name" item from the cache
|
|
* $name = Cache::driver()->get('name');
|
|
*
|
|
* // Get the "name" item from the cache or return "Fred"
|
|
* $name = Cache::driver()->get('name', 'Fred');
|
|
* </code>
|
|
*
|
|
* @param string $key
|
|
* @param mixed $default
|
|
* @param string $driver
|
|
* @return mixed
|
|
*/
|
|
public function get($key, $default = null)
|
|
{
|
|
if ( ! is_null($item = $this->retrieve($key))) return $item;
|
|
|
|
return (is_callable($default)) ? call_user_func($default) : $default;
|
|
}
|
|
|
|
/**
|
|
* Retrieve an item from the cache driver.
|
|
*
|
|
* @param string $key
|
|
* @return mixed
|
|
*/
|
|
abstract protected function retrieve($key);
|
|
|
|
/**
|
|
* Write an item to the cache for a given number of minutes.
|
|
*
|
|
* <code>
|
|
* // Write the "name" item to the cache for 30 minutes
|
|
* Cache::driver()->put('name', 'Fred', 30);
|
|
* </code>
|
|
*
|
|
* @param string $key
|
|
* @param mixed $value
|
|
* @param int $minutes
|
|
* @return void
|
|
*/
|
|
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 the "name" item from the cache or store "Fred" for 30 minutes
|
|
* $name = Cache::driver()->remember('name', 'Fred', 30);
|
|
* </code>
|
|
*
|
|
* @param string $key
|
|
* @param mixed $default
|
|
* @param int $minutes
|
|
* @return mixed
|
|
*/
|
|
public function remember($key, $value, $minutes)
|
|
{
|
|
if ( ! is_null($item = $this->get($key, null))) return $item;
|
|
|
|
$default = is_callable($default) ? call_user_func($default) : $default;
|
|
|
|
$this->put($key, $default, $minutes);
|
|
|
|
return $default;
|
|
}
|
|
|
|
/**
|
|
* Delete an item from the cache.
|
|
*
|
|
* @param string $key
|
|
* @return void
|
|
*/
|
|
abstract public function forget($key);
|
|
|
|
} |