Skip to content

Commit c9797f6

Browse files
lyrixxlyrixx
committed
[CS] Remove @inheritdoc PHPDoc
1 parent 52c2c53 commit c9797f6

23 files changed

+0
-202
lines changed

‎Lock.php

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,6 @@ public function __destruct()
7171
$this->release();
7272
}
7373

74-
/**
75-
* {@inheritdoc}
76-
*/
7774
public function acquire(bool $blocking = false): bool
7875
{
7976
$this->key->resetLifetime();
@@ -127,9 +124,6 @@ public function acquire(bool $blocking = false): bool
127124
}
128125
}
129126

130-
/**
131-
* {@inheritdoc}
132-
*/
133127
public function acquireRead(bool $blocking = false): bool
134128
{
135129
$this->key->resetLifetime();
@@ -188,9 +182,6 @@ public function acquireRead(bool $blocking = false): bool
188182
}
189183
}
190184

191-
/**
192-
* {@inheritdoc}
193-
*/
194185
public function refresh(float $ttl = null)
195186
{
196187
if (null === $ttl) {
@@ -225,17 +216,11 @@ public function refresh(float $ttl = null)
225216
}
226217
}
227218

228-
/**
229-
* {@inheritdoc}
230-
*/
231219
public function isAcquired(): bool
232220
{
233221
return $this->dirty = $this->store->exists($this->key);
234222
}
235223

236-
/**
237-
* {@inheritdoc}
238-
*/
239224
public function release()
240225
{
241226
try {
@@ -257,17 +242,11 @@ public function release()
257242
}
258243
}
259244

260-
/**
261-
* {@inheritdoc}
262-
*/
263245
public function isExpired(): bool
264246
{
265247
return $this->key->isExpired();
266248
}
267249

268-
/**
269-
* {@inheritdoc}
270-
*/
271250
public function getRemainingLifetime(): ?float
272251
{
273252
return $this->key->getRemainingLifetime();

‎Store/CombinedStore.php

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,6 @@ public function __construct(array $stores, StrategyInterface $strategy)
5353
$this->logger = new NullLogger();
5454
}
5555

56-
/**
57-
* {@inheritdoc}
58-
*/
5956
public function save(Key $key)
6057
{
6158
$successCount = 0;
@@ -128,9 +125,6 @@ public function saveRead(Key $key)
128125
throw new LockConflictedException();
129126
}
130127

131-
/**
132-
* {@inheritdoc}
133-
*/
134128
public function putOffExpiration(Key $key, float $ttl)
135129
{
136130
$successCount = 0;
@@ -172,9 +166,6 @@ public function putOffExpiration(Key $key, float $ttl)
172166
throw new LockConflictedException();
173167
}
174168

175-
/**
176-
* {@inheritdoc}
177-
*/
178169
public function delete(Key $key)
179170
{
180171
foreach ($this->stores as $store) {
@@ -186,9 +177,6 @@ public function delete(Key $key)
186177
}
187178
}
188179

189-
/**
190-
* {@inheritdoc}
191-
*/
192180
public function exists(Key $key): bool
193181
{
194182
$successCount = 0;

‎Store/DoctrineDbalStore.php

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,6 @@ public function __construct(Connection|string $connOrUrl, array $options = [], f
7272
}
7373
}
7474

75-
/**
76-
* {@inheritdoc}
77-
*/
7875
public function save(Key $key)
7976
{
8077
$key->reduceLifetime($this->initialTtl);
@@ -114,9 +111,6 @@ public function save(Key $key)
114111
$this->checkNotExpired($key);
115112
}
116113

117-
/**
118-
* {@inheritdoc}
119-
*/
120114
public function putOffExpiration(Key $key, $ttl)
121115
{
122116
if ($ttl < 1) {
@@ -148,9 +142,6 @@ public function putOffExpiration(Key $key, $ttl)
148142
$this->checkNotExpired($key);
149143
}
150144

151-
/**
152-
* {@inheritdoc}
153-
*/
154145
public function delete(Key $key)
155146
{
156147
$this->conn->delete($this->table, [
@@ -159,9 +150,6 @@ public function delete(Key $key)
159150
]);
160151
}
161152

162-
/**
163-
* {@inheritdoc}
164-
*/
165153
public function exists(Key $key): bool
166154
{
167155
$sql = "SELECT 1 FROM $this->table WHERE $this->idCol = ? AND $this->tokenCol = ? AND $this->expirationCol > {$this->getCurrentTimestampStatement()}";

‎Store/FlockStore.php

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -53,33 +53,21 @@ public function __construct(string $lockPath = null)
5353
$this->lockPath = $lockPath;
5454
}
5555

56-
/**
57-
* {@inheritdoc}
58-
*/
5956
public function save(Key $key)
6057
{
6158
$this->lock($key, false, false);
6259
}
6360

64-
/**
65-
* {@inheritdoc}
66-
*/
6761
public function saveRead(Key $key)
6862
{
6963
$this->lock($key, true, false);
7064
}
7165

72-
/**
73-
* {@inheritdoc}
74-
*/
7566
public function waitAndSave(Key $key)
7667
{
7768
$this->lock($key, false, true);
7869
}
7970

80-
/**
81-
* {@inheritdoc}
82-
*/
8371
public function waitAndSaveRead(Key $key)
8472
{
8573
$this->lock($key, true, true);
@@ -135,17 +123,11 @@ private function lock(Key $key, bool $read, bool $blocking)
135123
$key->markUnserializable();
136124
}
137125

138-
/**
139-
* {@inheritdoc}
140-
*/
141126
public function putOffExpiration(Key $key, float $ttl)
142127
{
143128
// do nothing, the flock locks forever.
144129
}
145130

146-
/**
147-
* {@inheritdoc}
148-
*/
149131
public function delete(Key $key)
150132
{
151133
// The lock is maybe not acquired.
@@ -161,9 +143,6 @@ public function delete(Key $key)
161143
$key->removeState(__CLASS__);
162144
}
163145

164-
/**
165-
* {@inheritdoc}
166-
*/
167146
public function exists(Key $key): bool
168147
{
169148
return $key->hasState(__CLASS__);

‎Store/MemcachedStore.php

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,6 @@ public function __construct(\Memcached $memcached, int $initialTtl = 300)
5252
$this->initialTtl = $initialTtl;
5353
}
5454

55-
/**
56-
* {@inheritdoc}
57-
*/
5855
public function save(Key $key)
5956
{
6057
$token = $this->getUniqueToken($key);
@@ -67,9 +64,6 @@ public function save(Key $key)
6764
$this->checkNotExpired($key);
6865
}
6966

70-
/**
71-
* {@inheritdoc}
72-
*/
7367
public function putOffExpiration(Key $key, float $ttl)
7468
{
7569
if ($ttl < 1) {
@@ -106,9 +100,6 @@ public function putOffExpiration(Key $key, float $ttl)
106100
$this->checkNotExpired($key);
107101
}
108102

109-
/**
110-
* {@inheritdoc}
111-
*/
112103
public function delete(Key $key)
113104
{
114105
$token = $this->getUniqueToken($key);
@@ -130,9 +121,6 @@ public function delete(Key $key)
130121
$this->memcached->delete((string) $key);
131122
}
132123

133-
/**
134-
* {@inheritdoc}
135-
*/
136124
public function exists(Key $key): bool
137125
{
138126
return $this->memcached->get((string) $key) === $this->getUniqueToken($key);

‎Store/MongoDbStore.php

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -197,8 +197,6 @@ public function createTtlIndex(int $expireAfterSeconds = 0)
197197
}
198198

199199
/**
200-
* {@inheritdoc}
201-
*
202200
* @throws LockExpiredException when save is called on an expired lock
203201
*/
204202
public function save(Key $key)
@@ -222,8 +220,6 @@ public function save(Key $key)
222220
}
223221

224222
/**
225-
* {@inheritdoc}
226-
*
227223
* @throws LockStorageException
228224
* @throws LockExpiredException
229225
*/
@@ -243,9 +239,6 @@ public function putOffExpiration(Key $key, float $ttl)
243239
$this->checkNotExpired($key);
244240
}
245241

246-
/**
247-
* {@inheritdoc}
248-
*/
249242
public function delete(Key $key)
250243
{
251244
$this->getCollection()->deleteOne([ // filter
@@ -254,9 +247,6 @@ public function delete(Key $key)
254247
]);
255248
}
256249

257-
/**
258-
* {@inheritdoc}
259-
*/
260250
public function exists(Key $key): bool
261251
{
262252
return null !== $this->getCollection()->findOne([ // filter

‎Store/PdoStore.php

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,6 @@ public function __construct(\PDO|string $connOrDsn, array $options = [], float $
8383
$this->connectionOptions = $options['db_connection_options'] ?? $this->connectionOptions;
8484
}
8585

86-
/**
87-
* {@inheritdoc}
88-
*/
8986
public function save(Key $key)
9087
{
9188
$key->reduceLifetime($this->initialTtl);
@@ -115,9 +112,6 @@ public function save(Key $key)
115112
$this->checkNotExpired($key);
116113
}
117114

118-
/**
119-
* {@inheritdoc}
120-
*/
121115
public function putOffExpiration(Key $key, float $ttl)
122116
{
123117
if ($ttl < 1) {
@@ -143,9 +137,6 @@ public function putOffExpiration(Key $key, float $ttl)
143137
$this->checkNotExpired($key);
144138
}
145139

146-
/**
147-
* {@inheritdoc}
148-
*/
149140
public function delete(Key $key)
150141
{
151142
$sql = "DELETE FROM $this->table WHERE $this->idCol = :id AND $this->tokenCol = :token";
@@ -156,9 +147,6 @@ public function delete(Key $key)
156147
$stmt->execute();
157148
}
158149

159-
/**
160-
* {@inheritdoc}
161-
*/
162150
public function exists(Key $key): bool
163151
{
164152
$sql = "SELECT 1 FROM $this->table WHERE $this->idCol = :id AND $this->tokenCol = :token AND $this->expirationCol > {$this->getCurrentTimestampStatement()}";

‎Store/RedisStore.php

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,6 @@ public function __construct(\Redis|\RedisArray|\RedisCluster|\Predis\ClientInter
4848
$this->initialTtl = $initialTtl;
4949
}
5050

51-
/**
52-
* {@inheritdoc}
53-
*/
5451
public function save(Key $key)
5552
{
5653
$script = '
@@ -96,9 +93,6 @@ public function save(Key $key)
9693
$this->checkNotExpired($key);
9794
}
9895

99-
/**
100-
* {@inheritdoc}
101-
*/
10296
public function saveRead(Key $key)
10397
{
10498
$script = '
@@ -139,9 +133,6 @@ public function saveRead(Key $key)
139133
$this->checkNotExpired($key);
140134
}
141135

142-
/**
143-
* {@inheritdoc}
144-
*/
145136
public function putOffExpiration(Key $key, float $ttl)
146137
{
147138
$script = '
@@ -182,9 +173,6 @@ public function putOffExpiration(Key $key, float $ttl)
182173
$this->checkNotExpired($key);
183174
}
184175

185-
/**
186-
* {@inheritdoc}
187-
*/
188176
public function delete(Key $key)
189177
{
190178
$script = '
@@ -215,9 +203,6 @@ public function delete(Key $key)
215203
$this->evaluate($script, (string) $key, [$this->getUniqueToken($key)]);
216204
}
217205

218-
/**
219-
* {@inheritdoc}
220-
*/
221206
public function exists(Key $key): bool
222207
{
223208
$script = '

0 commit comments

Comments
 (0)