-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathApc.php
More file actions
209 lines (187 loc) · 4.84 KB
/
Apc.php
File metadata and controls
209 lines (187 loc) · 4.84 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
<?php
declare(strict_types=1);
namespace Codeception\Module;
use Codeception\Module;
use Codeception\TestInterface;
use Codeception\Exception\ModuleException;
/**
* This module interacts with the [Alternative PHP Cache (APC)](https://php.net/manual/en/intro.apcu.php)
* using _APCu_ extension.
*
* Performs a cleanup by flushing all values after each test run.
*
* ## Status
*
* * Maintainer: **Serghei Iakovlev**
* * Stability: **stable**
* * Contact: [email protected]
*
* ### Example (`unit.suite.yml`)
*
* ```yaml
* modules:
* - Apc
* ```
*
* Be sure you don't use the production server to connect.
*
*/
class Apc extends Module
{
/**
* Code to run before each test.
*
* @throws ModuleException
*/
public function _before(TestInterface $test)
{
if (!extension_loaded('apcu')) {
throw new ModuleException(
__CLASS__,
'The APCu extension not loaded.'
);
}
if (!ini_get('apc.enabled') || (PHP_SAPI === 'cli' && !ini_get('apc.enable_cli'))) {
throw new ModuleException(
__CLASS__,
'The "apc.enable_cli" parameter must be set to "On".'
);
}
}
/**
* Code to run after each test.
*/
public function _after(TestInterface $test)
{
$this->clear();
}
/**
* Grabs value from APCu by key.
*
* Example:
*
* ``` php
* <?php
* $users_count = $I->grabValueFromApc('users_count');
* ```
*/
public function grabValueFromApc(string $key): mixed
{
$value = $this->fetch($key);
$this->debugSection('Value', $value);
return $value;
}
/**
* Checks item in APCu exists and the same as expected.
*
* Examples:
*
* ``` php
* <?php
* // With only one argument, only checks the key exists
* $I->seeInApc('users_count');
*
* // Checks a 'users_count' exists and has the value 200
* $I->seeInApc('users_count', 200);
* ```
*
*/
public function seeInApc(string $key, mixed $value = null): void
{
if (null === $value) {
$this->assertTrue($this->exists($key), "Cannot find key '$key' in APCu.");
return;
}
$actual = $this->grabValueFromApc($key);
$this->assertEquals($value, $actual, "Cannot find key '$key' in APCu with the provided value.");
}
/**
* Checks item in APCu doesn't exist or is the same as expected.
*
* Examples:
*
* ``` php
* <?php
* // With only one argument, only checks the key does not exist
* $I->dontSeeInApc('users_count');
*
* // Checks a 'users_count' exists does not exist or its value is not the one provided
* $I->dontSeeInApc('users_count', 200);
* ```
*/
public function dontSeeInApc(string $key, mixed $value = null): void
{
if (null === $value) {
$this->assertFalse($this->exists($key), "The key '$key' exists in APCu.");
return;
}
$actual = $this->grabValueFromApc($key);
$this->assertFalse($actual, "The key '$key' exists in APCu with the provided value.");
}
/**
* Stores an item `$value` with `$key` on the APCu.
*
* Examples:
*
* ```php
* <?php
* // Array
* $I->haveInApc('users', ['name' => 'miles', 'email' => '[email protected]']);
*
* // Object
* $I->haveInApc('user', UserRepository::findFirst());
*
* // Key as array of 'key => value'
* $entries = [];
* $entries['key1'] = 'value1';
* $entries['key2'] = 'value2';
* $entries['key3'] = ['value3a','value3b'];
* $entries['key4'] = 4;
* $I->haveInApc($entries, null);
* ```
*/
public function haveInApc(string $key, mixed $value, int $expiration = 0): string
{
$this->store($key, $value, $expiration);
return $key;
}
/**
* Clears the APCu cache
*/
public function flushApc(): void
{
// Returns TRUE always
$this->clear();
}
/**
* Clears the APCu cache.
*/
protected function clear(): bool
{
return apcu_clear_cache();
}
/**
* Checks if entry exists
*/
protected function exists(string $key): bool
{
return apcu_exists($key);
}
/**
* Fetch a stored variable from the cache
*/
protected function fetch(string $key): mixed
{
$success = false;
$data = apcu_fetch($key, $success);
$this->debugSection('Fetching a stored variable', $success ? 'OK' : 'FAILED');
return $data;
}
/**
* Cache a variable in the data store.
*/
protected function store(string $key, mixed $var, int $ttl = 0): bool
{
return apcu_store($key, $var, $ttl);
}
}