Cache.php — Independent Analytics – WordPress Analytics Plugin 2.2.0

independent-analytics / vendor / doctrine / cache / lib / Doctrine / Common / Cache / Cache.php

independent-analytics / vendor / doctrine / cache / lib / Doctrine / Common / Cache Last commit date

Cache.php

87 lines

1	<?php
2
3	namespace IAWP_SCOPED\Doctrine\Common\Cache;
4
5	/**
6	* Interface for cache drivers.
7	*
8	* @link www.doctrine-project.org
9	* @internal
10	*/
11	interface Cache
12	{
13	public const STATS_HITS = 'hits';
14	public const STATS_MISSES = 'misses';
15	public const STATS_UPTIME = 'uptime';
16	public const STATS_MEMORY_USAGE = 'memory_usage';
17	public const STATS_MEMORY_AVAILABLE = 'memory_available';
18	/**
19	* Only for backward compatibility (may be removed in next major release)
20	*
21	* @deprecated
22	*/
23	public const STATS_MEMORY_AVAILIABLE = 'memory_available';
24	/**
25	* Fetches an entry from the cache.
26	*
27	* @param string $id The id of the cache entry to fetch.
28	*
29	* @return mixed The cached data or FALSE, if no cache entry exists for the given id.
30	*/
31	public function fetch($id);
32	/**
33	* Tests if an entry exists in the cache.
34	*
35	* @param string $id The cache id of the entry to check for.
36	*
37	* @return bool TRUE if a cache entry exists for the given cache id, FALSE otherwise.
38	*/
39	public function contains($id);
40	/**
41	* Puts data into the cache.
42	*
43	* If a cache entry with the given id already exists, its data will be replaced.
44	*
45	* @param string $id The cache id.
46	* @param mixed $data The cache entry/data.
47	* @param int $lifeTime The lifetime in number of seconds for this cache entry.
48	* If zero (the default), the entry never expires (although it may be deleted from the cache
49	* to make place for other entries).
50	*
51	* @return bool TRUE if the entry was successfully stored in the cache, FALSE otherwise.
52	*/
53	public function save($id, $data, $lifeTime = 0);
54	/**
55	* Deletes a cache entry.
56	*
57	* @param string $id The cache id.
58	*
59	* @return bool TRUE if the cache entry was successfully deleted, FALSE otherwise.
60	* Deleting a non-existing entry is considered successful.
61	*/
62	public function delete($id);
63	/**
64	* Retrieves cached information from the data store.
65	*
66	* The server's statistics array has the following values:
67	*
68	* - <b>hits</b>
69	* Number of keys that have been requested and found present.
70	*
71	* - <b>misses</b>
72	* Number of items that have been requested and not found.
73	*
74	* - <b>uptime</b>
75	* Time that the server is running.
76	*
77	* - <b>memory_usage</b>
78	* Memory used by this server to store items.
79	*
80	* - <b>memory_available</b>
81	* Memory allowed to use for storage.
82	*
83	* @return mixed[]\|null An associative array with server's statistics if available, NULL otherwise.
84	*/
85	public function getStats();
86	}
87