johnhamelink
11/26/2012 - 2:35 PM

redis.php

<?php namespace Laravel\Cache\Drivers;

class Redis extends Sectionable {

	/**
	 * The Redis database instance.
	 *
	 * @var Laravel\Redis
	 */
	protected $redis;

	/**
	 * Create a new Redis cache driver instance.
	 *
	 * @param  Laravel\Redis  $redis
	 * @return void
	 */
	public function __construct(\Laravel\Redis $redis)
	{
		$this->redis = $redis;
	}

	/**
	 * Determine if an item exists in the cache.
	 *
	 * @param  string  $key
	 * @return bool
	 */
	public function has($key)
	{
		return ( ! is_null($this->redis->get($key)));
	}

	/**
	 * Retrieve an item from the cache driver.
	 *
	 * @param  string  $key
	 * @return mixed
	 */
	protected function retrieve($key)
	{
		if ( ! is_null($cache = $this->redis->get($key)))
		{
			return unserialize($cache);
		}
	}

	/**
	 * 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
	 * @return mixed
	 */
	public function put($key, $value, $minutes)
	{
		$this->forever($key, $value);
		$this->redis->expire($key, $minutes * 60);
	}

	/**
	 * Write an item to the cache that lasts forever.
	 *
	 * @param  string  $key
	 * @param  mixed   $value
	 * @return void
	 */
	public function forever($key, $value)
	{
        $this->redis->set($key, serialize($value));
	}

	/**
	 * Delete an item from the cache.
	 *
	 * @param  string  $key
	 * @return void
	 */
	public function forget($key)
	{
		$this->redis->del($key);
	}

	/**
	 * Define the section key string
	 *
	 * @param String $section
	 * @param String $key
	 * @return String
	 */
	protected function section_list_id($section)
	{
		return \Laravel\Config::get('application.key') . ".{$section}";
	}

	/**
	 * Define the section key string
	 *
	 * @param String $section
	 * @param String $key
	 * @return String
	 */
	protected function section_item_key($section, $key)
	{
		return \Laravel\Config::get('application.key') . ".{$section}::{$key}";
	}

    /**
	 * Delete an entire section from the cache.
	 *
	 * @param  string    $section
	 * @return bool
	 */
	public function forget_section($section)
	{
        // Retrieve list of keys currently within this section
		$keys = $this->redis->lrange($this->section_list_id($section), 0, -1);
		foreach ($keys as $key) {
            // Remove all keys in section
			$this->redis->del($key);
		}
        // Remove list of key as they're now unset
		$this->redis->lrem($this->section_list_id($section), 0, -1);
		return true;
	}

    /**
	 * Get a sectioned item from the cache, or cache and return the default value.
	 *
	 * @param  string  $section
	 * @param  string  $key
	 * @param  mixed   $default
	 * @param  int     $minutes
	 * @param  string  $function
	 * @return mixed
	 */
	public function remember_in_section($section, $key, $default, $minutes, $function = 'put')
	{
        // See if section key is currently set
		$return = $this->get_from_section($section, $key);
		if ($return === null) {
            // Nothing found, store new default
            $return = value($default);
			$this->put($this->section_item_key($section, $key), $return, $minutes);
			$this->redis->lpush($this->section_list_id($section), $this->section_item_key($section, $key));
		}
		return $return;
	}
}