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

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

66 lines 1.4 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
16	declare(strict_types=1);
17
18	namespace UserAccessManager\Cache;
19
20	use UserAccessManager\Config\Config;
21
22	/**
23	* Interface CacheProviderInterface
24	*
25	* @package UserAccessManager\Cache
26	*/
27	interface CacheProviderInterface
28	{
29	/**
30	* Returns the id of the cache provider.
31	* @return string
32	*/
33	public function getId(): string;
34
35	/**
36	* Initialises the cache provider object.
37	*/
38	public function init();
39
40	/**
41	* Returns the cache provider configuration.
42	* @return Config
43	*/
44	public function getConfig(): Config;
45
46	/**
47	* Adds a value to the cache.
48	* @param string $key
49	* @param mixed $value
50	*/
51	public function add(string $key, $value);
52
53	/**
54	* Returns a value from the cache.
55	* @param string $key
56	* @return mixed
57	*/
58	public function get(string $key);
59
60	/**
61	* Invalidates the cache.
62	* @param string $key
63	*/
64	public function invalidate(string $key);
65	}
66