summaryrefslogtreecommitdiff
path: root/system/libraries/Cache.php
blob: 2ed344faf119f60992fe5c69eb3e70511bd04df7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
<?php defined('SYSPATH') OR die('No direct access allowed.');
/**
 * Provides a driver-based interface for finding, creating, and deleting cached
 * resources. Caches are identified by a unique string. Tagging of caches is
 * also supported, and caches can be found and deleted by id or tag.
 *
 * $Id: Cache.php 4605 2009-09-14 17:22:21Z kiall $
 *
 * @package    Cache
 * @author     Kohana Team
 * @copyright  (c) 2007-2009 Kohana Team
 * @license    http://kohanaphp.com/license
 */
class Cache_Core {

	protected static $instances = array();

	// Configuration
	protected $config;

	// Driver object
	protected $driver;

	/**
	 * Returns a singleton instance of Cache.
	 *
	 * @param   string  configuration
	 * @return  Cache_Core
	 */
	public static function & instance($config = FALSE)
	{
		if ( ! isset(Cache::$instances[$config]))
		{
			// Create a new instance
			Cache::$instances[$config] = new Cache($config);
		}

		return Cache::$instances[$config];
	}

	/**
	 * Loads the configured driver and validates it.
	 *
	 * @param   array|string  custom configuration or config group name
	 * @return  void
	 */
	public function __construct($config = FALSE)
	{
		if (is_string($config))
		{
			$name = $config;

			// Test the config group name
			if (($config = Kohana::config('cache.'.$config)) === NULL)
				throw new Kohana_Exception('The :group: group is not defined in your configuration.', array(':group:' => $name));
		}

		if (is_array($config))
		{
			// Append the default configuration options
			$config += Kohana::config('cache.default');
		}
		else
		{
			// Load the default group
			$config = Kohana::config('cache.default');
		}

		// Cache the config in the object
		$this->config = $config;

		// Set driver name
		$driver = 'Cache_'.ucfirst($this->config['driver']).'_Driver';

		// Load the driver
		if ( ! Kohana::auto_load($driver))
			throw new Kohana_Exception('The :driver: driver for the :class: library could not be found',
									   array(':driver:' => $this->config['driver'], ':class:' => get_class($this)));

		// Initialize the driver
		$this->driver = new $driver($this->config['params']);

		// Validate the driver
		if ( ! ($this->driver instanceof Cache_Driver))
			throw new Kohana_Exception('The :driver: driver for the :library: library must implement the :interface: interface',
									   array(':driver:' => $this->config['driver'], ':library:' => get_class($this), ':interface:' => 'Cache_Driver'));

		Kohana_Log::add('debug', 'Cache Library initialized');
	}

	/**
	 * Set cache items
	 */
	public function set($key, $value = NULL, $tags = NULL, $lifetime = NULL)
	{
		if ($lifetime === NULL)
		{
			$lifetime = $this->config['lifetime'];
		}

		if ( ! is_array($key))
		{
			$key = array($key => $value);
		}

		return $this->driver->set($key, $tags, $lifetime);
	}

	/**
	 * Get a cache items by key
	 */
	public function get($keys)
	{
		$single = FALSE;

		if ( ! is_array($keys))
		{
			$keys = array($keys);
			$single = TRUE;
		}

		return $this->driver->get($keys, $single);
	}

	/**
	 * Get cache items by tags
	 */
	public function get_tag($tags)
	{
		if ( ! is_array($tags))
		{
			$tags = array($tags);
		}

		return $this->driver->get_tag($tags);
	}

	/**
	 * Delete cache item by key
	 */
	public function delete($keys)
	{
		if ( ! is_array($keys))
		{
			$keys = array($keys);
		}

		return $this->driver->delete($keys);
	}

	/**
	 * Delete cache items by tag
	 */
	public function delete_tag($tags)
	{
		if ( ! is_array($tags))
		{
			$tags = array($tags);
		}

		return $this->driver->delete_tag($tags);
	}

	/**
	 * Empty the cache
	 */
	public function delete_all()
	{
		return $this->driver->delete_all();
	}
} // End Cache Library