MongoDBCache.php — Independent Analytics – WordPress Analytics Plugin 2.2.0

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

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

MongoDBCache.php

106 lines

1	<?php
2
3	namespace IAWP_SCOPED\Doctrine\Common\Cache;
4
5	use InvalidArgumentException;
6	use MongoCollection;
7	use IAWP_SCOPED\MongoDB\Collection;
8	use function trigger_error;
9	use const E_USER_DEPRECATED;
10	/**
11	* MongoDB cache provider.
12	*
13	* @deprecated Deprecated without replacement in doctrine/cache 1.11. This class will be dropped in 2.0
14	* @internal
15	*/
16	class MongoDBCache extends CacheProvider
17	{
18	/**
19	* The data field will store the serialized PHP value.
20	*/
21	public const DATA_FIELD = 'd';
22	/**
23	* The expiration field will store a MongoDate value indicating when the
24	* cache entry should expire.
25	*
26	* With MongoDB 2.2+, entries can be automatically deleted by MongoDB by
27	* indexing this field with the "expireAfterSeconds" option equal to zero.
28	* This will direct MongoDB to regularly query for and delete any entries
29	* whose date is older than the current time. Entries without a date value
30	* in this field will be ignored.
31	*
32	* The cache provider will also check dates on its own, in case expired
33	* entries are fetched before MongoDB's TTLMonitor pass can expire them.
34	*
35	* @see http://docs.mongodb.org/manual/tutorial/expire-data/
36	*/
37	public const EXPIRATION_FIELD = 'e';
38	/** @var CacheProvider */
39	private $provider;
40	/**
41	* This provider will default to the write concern and read preference
42	* options set on the collection instance (or inherited from MongoDB or
43	* MongoClient). Using an unacknowledged write concern (< 1) may make the
44	* return values of delete() and save() unreliable. Reading from secondaries
45	* may make contain() and fetch() unreliable.
46	*
47	* @see http://www.php.net/manual/en/mongo.readpreferences.php
48	* @see http://www.php.net/manual/en/mongo.writeconcerns.php
49	*
50	* @param MongoCollection\|Collection $collection
51	*/
52	public function __construct($collection)
53	{
54	if ($collection instanceof MongoCollection) {
55	@trigger_error('Using a MongoCollection instance for creating a cache adapter is deprecated and will be removed in 2.0', E_USER_DEPRECATED);
56	$this->provider = new LegacyMongoDBCache($collection);
57	} elseif ($collection instanceof Collection) {
58	$this->provider = new ExtMongoDBCache($collection);
59	} else {
60	throw new InvalidArgumentException('Invalid collection given - expected a MongoCollection or MongoDB\\Collection instance');
61	}
62	}
63	/**
64	* {@inheritdoc}
65	*/
66	protected function doFetch($id)
67	{
68	return $this->provider->doFetch($id);
69	}
70	/**
71	* {@inheritdoc}
72	*/
73	protected function doContains($id)
74	{
75	return $this->provider->doContains($id);
76	}
77	/**
78	* {@inheritdoc}
79	*/
80	protected function doSave($id, $data, $lifeTime = 0)
81	{
82	return $this->provider->doSave($id, $data, $lifeTime);
83	}
84	/**
85	* {@inheritdoc}
86	*/
87	protected function doDelete($id)
88	{
89	return $this->provider->doDelete($id);
90	}
91	/**
92	* {@inheritdoc}
93	*/
94	protected function doFlush()
95	{
96	return $this->provider->doFlush();
97	}
98	/**
99	* {@inheritdoc}
100	*/
101	protected function doGetStats()
102	{
103	return $this->provider->doGetStats();
104	}
105	}
106