user-access-manager / src / Cache / CacheProviderInterface.php

CacheProviderInterface.php in User Access Manager 2.1.9, at src/Cache/CacheProviderInterface.php

69 lines 1.3 KB

Raw Download Zip

1	<?php
2	/**
3	* CacheProviderInterface.php
4	*
5	* The CacheProviderInterface interface file.
6	*
7	* PHP versions 5
8	*
9	* @author Alexander Schneider <alexanderschneider85@gmail.com>
10	* @copyright 2008-2017 Alexander Schneider
11	* @license http://www.gnu.org/licenses/gpl-2.0.html GNU General Public License, version 2
12	* @version SVN: $id$
13	* @link http://wordpress.org/extend/plugins/user-access-manager/
14	*/
15	namespace UserAccessManager\Cache;
16
17	use UserAccessManager\Config\Config;
18
19	/**
20	* Interface CacheProviderInterface
21	*
22	* @package UserAccessManager\Cache
23	*/
24	interface CacheProviderInterface
25	{
26	/**
27	* Returns the id of the cache provider.
28	*
29	* @return string
30	*/
31	public function getId();
32
33	/**
34	* Initialises the cache provider object.
35	*/
36	public function init();
37
38	/**
39	* Returns the cache provider configuration.
40	*
41	* @return Config
42	*/
43	public function getConfig();
44
45	/**
46	* Adds a value to the cache.
47	*
48	* @param string $key
49	* @param mixed $value
50	*/
51	public function add($key, $value);
52
53	/**
54	* Returns a value from the cache.
55	*
56	* @param string $key
57	*
58	* @return mixed
59	*/
60	public function get($key);
61
62	/**
63	* Invalidates the cache.
64	*
65	* @param string $key
66	*/
67	public function invalidate($key);
68	}
69