Chris@0
|
1 <?php
|
Chris@0
|
2
|
Chris@0
|
3 namespace Drupal\system\Tests\Cache;
|
Chris@0
|
4
|
Chris@18
|
5 @trigger_error(__NAMESPACE__ . '\CacheTestBase is deprecated for removal before Drupal 9.0.0. Use \Drupal\Tests\system\Functional\Cache\CacheTestBase instead. See https://www.drupal.org/node/2999939', E_USER_DEPRECATED);
|
Chris@18
|
6
|
Chris@0
|
7 use Drupal\simpletest\WebTestBase;
|
Chris@0
|
8
|
Chris@0
|
9 /**
|
Chris@0
|
10 * Provides helper methods for cache tests.
|
Chris@0
|
11 *
|
Chris@0
|
12 * @deprecated Scheduled for removal in Drupal 9.0.0.
|
Chris@0
|
13 * Use \Drupal\Tests\system\Functional\Cache\CacheTestBase instead.
|
Chris@18
|
14 *
|
Chris@18
|
15 * @see https://www.drupal.org/node/2999939
|
Chris@0
|
16 */
|
Chris@0
|
17 abstract class CacheTestBase extends WebTestBase {
|
Chris@0
|
18
|
Chris@0
|
19 protected $defaultBin = 'render';
|
Chris@0
|
20 protected $defaultCid = 'test_temporary';
|
Chris@0
|
21 protected $defaultValue = 'CacheTest';
|
Chris@0
|
22
|
Chris@0
|
23 /**
|
Chris@0
|
24 * Checks whether or not a cache entry exists.
|
Chris@0
|
25 *
|
Chris@0
|
26 * @param $cid
|
Chris@0
|
27 * The cache id.
|
Chris@0
|
28 * @param $var
|
Chris@0
|
29 * The variable the cache should contain.
|
Chris@0
|
30 * @param $bin
|
Chris@0
|
31 * The bin the cache item was stored in.
|
Chris@0
|
32 * @return
|
Chris@0
|
33 * TRUE on pass, FALSE on fail.
|
Chris@0
|
34 */
|
Chris@0
|
35 protected function checkCacheExists($cid, $var, $bin = NULL) {
|
Chris@0
|
36 if ($bin == NULL) {
|
Chris@0
|
37 $bin = $this->defaultBin;
|
Chris@0
|
38 }
|
Chris@0
|
39
|
Chris@0
|
40 $cached = \Drupal::cache($bin)->get($cid);
|
Chris@0
|
41
|
Chris@0
|
42 return isset($cached->data) && $cached->data == $var;
|
Chris@0
|
43 }
|
Chris@0
|
44
|
Chris@0
|
45 /**
|
Chris@0
|
46 * Asserts that a cache entry exists.
|
Chris@0
|
47 *
|
Chris@0
|
48 * @param $message
|
Chris@0
|
49 * Message to display.
|
Chris@0
|
50 * @param $var
|
Chris@0
|
51 * The variable the cache should contain.
|
Chris@0
|
52 * @param $cid
|
Chris@0
|
53 * The cache id.
|
Chris@0
|
54 * @param $bin
|
Chris@0
|
55 * The bin the cache item was stored in.
|
Chris@0
|
56 */
|
Chris@0
|
57 protected function assertCacheExists($message, $var = NULL, $cid = NULL, $bin = NULL) {
|
Chris@0
|
58 if ($bin == NULL) {
|
Chris@0
|
59 $bin = $this->defaultBin;
|
Chris@0
|
60 }
|
Chris@0
|
61 if ($cid == NULL) {
|
Chris@0
|
62 $cid = $this->defaultCid;
|
Chris@0
|
63 }
|
Chris@0
|
64 if ($var == NULL) {
|
Chris@0
|
65 $var = $this->defaultValue;
|
Chris@0
|
66 }
|
Chris@0
|
67
|
Chris@0
|
68 $this->assertTrue($this->checkCacheExists($cid, $var, $bin), $message);
|
Chris@0
|
69 }
|
Chris@0
|
70
|
Chris@0
|
71 /**
|
Chris@0
|
72 * Asserts that a cache entry has been removed.
|
Chris@0
|
73 *
|
Chris@0
|
74 * @param $message
|
Chris@0
|
75 * Message to display.
|
Chris@0
|
76 * @param $cid
|
Chris@0
|
77 * The cache id.
|
Chris@0
|
78 * @param $bin
|
Chris@0
|
79 * The bin the cache item was stored in.
|
Chris@0
|
80 */
|
Chris@0
|
81 public function assertCacheRemoved($message, $cid = NULL, $bin = NULL) {
|
Chris@0
|
82 if ($bin == NULL) {
|
Chris@0
|
83 $bin = $this->defaultBin;
|
Chris@0
|
84 }
|
Chris@0
|
85 if ($cid == NULL) {
|
Chris@0
|
86 $cid = $this->defaultCid;
|
Chris@0
|
87 }
|
Chris@0
|
88
|
Chris@0
|
89 $cached = \Drupal::cache($bin)->get($cid);
|
Chris@0
|
90 $this->assertFalse($cached, $message);
|
Chris@0
|
91 }
|
Chris@0
|
92
|
Chris@0
|
93 }
|