← All changes | src/Cache/CacheProviderInterface.php +55 -9 2.3.16 → 2.1.11 View file →

		@@ -1,22 +1,68 @@
1	1	<?php
2		-
3		-declare(strict_types=1);
4		-
	2	+/**
	3	+ * CacheProviderInterface.php
	4	+ *
	5	+ * The CacheProviderInterface interface file.
	6	+ *
	7	+ * PHP versions 5
	8	+ *
	9	+ * @author Alexander Schneider <[email protected]>
	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	+ */
5	15	namespace UserAccessManager\Cache;
6	16
7	17	use UserAccessManager\Config\Config;
8	18
	19	+/**
	20	+ * Interface CacheProviderInterface
	21	+ *
	22	+ * @package UserAccessManager\Cache
	23	+ */
9	24	interface CacheProviderInterface
10	25	{
11		- public function getId(): string;
	26	+ /**
	27	+ * Returns the id of the cache provider.
	28	+ *
	29	+ * @return string
	30	+ */
	31	+ public function getId();
12	32
13		- public function init(): void;
	33	+ /**
	34	+ * Initialises the cache provider object.
	35	+ */
	36	+ public function init();
14	37
15		- public function getConfig(): Config;
	38	+ /**
	39	+ * Returns the cache provider configuration.
	40	+ *
	41	+ * @return Config
	42	+ */
	43	+ public function getConfig();
16	44
17		- public function add(string $key, mixed $value);
	45	+ /**
	46	+ * Adds a value to the cache.
	47	+ *
	48	+ * @param string $key
	49	+ * @param mixed $value
	50	+ */
	51	+ public function add($key, $value);
18	52
19		- public function get(string $key): mixed;
	53	+ /**
	54	+ * Returns a value from the cache.
	55	+ *
	56	+ * @param string $key
	57	+ *
	58	+ * @return mixed
	59	+ */
	60	+ public function get($key);
20	61
21		- public function invalidate(string $key);
	62	+ /**
	63	+ * Invalidates the cache.
	64	+ *
	65	+ * @param string $key
	66	+ */
	67	+ public function invalidate($key);
22	68	}