Skip to content

Commit df0ee36

Browse files
dbudbu
committed
strict typing
1 parent cc75403 commit df0ee36

File tree

70 files changed

+446
-903
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+446
-903
lines changed

‎.phpstan/classAliases.php

-22
This file was deleted.

‎phpstan.neon.dist

-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@ parameters:
22
level: 1
33
paths:
44
- src
5-
bootstrapFiles:
6-
- .phpstan/classAliases.php
75
excludePaths:
86
analyseAndScan:
97
# contains code to support legacy phpunit versions

‎phpstan.tests.neon.dist

-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
parameters:
22
level: 1
3-
bootstrapFiles:
4-
- .phpstan/classAliases.php
53
paths:
64
- tests

‎src/CacheInvalidator.php

+15-42
Original file line numberDiff line numberDiff line change
@@ -61,21 +61,10 @@ class CacheInvalidator
6161
*/
6262
public const CLEAR = 'clear';
6363

64-
/**
65-
* @var ProxyClient
66-
*/
67-
private $cache;
64+
private ProxyClient $cache;
6865

69-
/**
70-
* @var EventDispatcherInterface
71-
*/
72-
private $eventDispatcher;
66+
private EventDispatcherInterface $eventDispatcher;
7367

74-
/**
75-
* Constructor.
76-
*
77-
* @param ProxyClient $cache HTTP cache
78-
*/
7968
public function __construct(ProxyClient $cache)
8069
{
8170
$this->cache = $cache;
@@ -91,11 +80,9 @@ public function __construct(ProxyClient $cache)
9180
*
9281
* @param string $operation one of the class constants
9382
*
94-
* @return bool
95-
*
9683
* @throws InvalidArgumentException
9784
*/
98-
public function supports(string $operation)
85+
public function supports(string $operation): bool
9986
{
10087
switch ($operation) {
10188
case self::PATH:
@@ -125,7 +112,7 @@ public function supports(string $operation)
125112
*/
126113
public function setEventDispatcher(EventDispatcherInterface $eventDispatcher): void
127114
{
128-
if ($this->eventDispatcher) {
115+
if (isset($this->eventDispatcher)) {
129116
// if you want to set a custom event dispatcher, do so right after instantiating
130117
// the invalidator.
131118
throw new \Exception('You may not change the event dispatcher once it is set.');
@@ -135,12 +122,10 @@ public function setEventDispatcher(EventDispatcherInterface $eventDispatcher): v
135122

136123
/**
137124
* Get the event dispatcher used by the cache invalidator.
138-
*
139-
* @return EventDispatcherInterface
140125
*/
141-
public function getEventDispatcher()
126+
public function getEventDispatcher(): EventDispatcherInterface
142127
{
143-
if (!$this->eventDispatcher) {
128+
if (!isset($this->eventDispatcher)) {
144129
$this->eventDispatcher = new EventDispatcher();
145130
}
146131

@@ -150,14 +135,12 @@ public function getEventDispatcher()
150135
/**
151136
* Invalidate a path or URL.
152137
*
153-
* @param string $path Path or URL
154-
* @param array $headers HTTP headers (optional)
155-
*
156-
* @return $this
138+
* @param string $path Path or URL
139+
* @param array<string, string> $headers HTTP headers (optional)
157140
*
158141
* @throws UnsupportedProxyOperationException
159142
*/
160-
public function invalidatePath($path, array $headers = []): static
143+
public function invalidatePath(string $path, array $headers = []): static
161144
{
162145
if (!$this->cache instanceof PurgeCapable) {
163146
throw UnsupportedProxyOperationException::cacheDoesNotImplement('PURGE');
@@ -171,16 +154,14 @@ public function invalidatePath($path, array $headers = []): static
171154
/**
172155
* Refresh a path or URL.
173156
*
174-
* @param string $path Path or URL
175-
* @param array $headers HTTP headers (optional)
157+
* @param string $path Path or URL
158+
* @param array<string, string> $headers HTTP headers (optional)
176159
*
177160
* @see RefreshCapable::refresh()
178161
*
179-
* @return $this
180-
*
181162
* @throws UnsupportedProxyOperationException
182163
*/
183-
public function refreshPath($path, array $headers = []): static
164+
public function refreshPath(string $path, array $headers = []): static
184165
{
185166
if (!$this->cache instanceof RefreshCapable) {
186167
throw UnsupportedProxyOperationException::cacheDoesNotImplement('REFRESH');
@@ -199,9 +180,7 @@ public function refreshPath($path, array $headers = []): static
199180
*
200181
* @see BanCapable::ban()
201182
*
202-
* @param array $headers HTTP headers that path must match to be banned
203-
*
204-
* @return $this
183+
* @param array<string, string> $headers HTTP headers that path must match to be banned
205184
*
206185
* @throws UnsupportedProxyOperationException If HTTP cache does not support BAN requests
207186
*/
@@ -221,9 +200,7 @@ public function invalidate(array $headers): static
221200
*
222201
* @see TagCapable::tags()
223202
*
224-
* @param array $tags Tags that should be removed/expired from the cache. An empty tag list is ignored.
225-
*
226-
* @return $this
203+
* @param string[] $tags Tags that should be removed/expired from the cache. An empty tag list is ignored.
227204
*
228205
* @throws UnsupportedProxyOperationException If HTTP cache does not support Tags invalidation
229206
*/
@@ -257,8 +234,6 @@ public function invalidateTags(array $tags): static
257234
* @param array|string|null $hosts Regular expression of a host name or list of
258235
* exact host names to limit banning
259236
*
260-
* @return $this
261-
*
262237
* @throws UnsupportedProxyOperationException If HTTP cache does not support BAN requests
263238
*
264239
*@see BanCapable::banPath()
@@ -277,8 +252,6 @@ public function invalidateRegex(string $path, ?string $contentType = null, array
277252
/**
278253
* Clear the cache completely.
279254
*
280-
* @return $this
281-
*
282255
* @throws UnsupportedProxyOperationException if HTTP cache does not support clearing the cache completely
283256
*/
284257
public function clearCache(): static
@@ -299,7 +272,7 @@ public function clearCache(): static
299272
*
300273
* @throws ExceptionCollection if any errors occurred during flush
301274
*/
302-
public function flush()
275+
public function flush(): int
303276
{
304277
try {
305278
return $this->cache->flush();

‎src/EventListener/LogListener.php

+7-10
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,7 @@
2222
*/
2323
class LogListener implements EventSubscriberInterface
2424
{
25-
/**
26-
* @var LoggerInterface
27-
*/
28-
private $logger;
25+
private LoggerInterface $logger;
2926

3027
public function __construct(LoggerInterface $logger)
3128
{
@@ -40,22 +37,22 @@ public static function getSubscribedEvents(): array
4037
];
4138
}
4239

43-
public function onProxyUnreachableError(Event $event)
40+
public function onProxyUnreachableError(Event $event): void
4441
{
45-
$this->log(LogLevel::CRITICAL, $event->getException());
42+
$this->log($event->getException());
4643
}
4744

48-
public function onProxyResponseError(Event $event)
45+
public function onProxyResponseError(Event $event): void
4946
{
50-
$this->log(LogLevel::CRITICAL, $event->getException());
47+
$this->log($event->getException());
5148
}
5249

53-
private function log($level, \Exception $exception)
50+
private function log(\Throwable $exception): void
5451
{
5552
$context = [
5653
'exception' => $exception,
5754
];
5855

59-
$this->logger->log($level, $exception->getMessage(), $context);
56+
$this->logger->log(LogLevel::CRITICAL, $exception->getMessage(), $context);
6057
}
6158
}

‎src/Exception/ExceptionCollection.php

+13-18
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,14 @@
1717
*/
1818
class ExceptionCollection extends \Exception implements \IteratorAggregate, \Countable, HttpCacheException
1919
{
20-
private $exceptions = [];
20+
/**
21+
* @var \Throwable[]
22+
*/
23+
private array $exceptions = [];
2124

25+
/**
26+
* @param \Throwable[] $exceptions
27+
*/
2228
public function __construct(array $exceptions = [])
2329
{
2430
foreach ($exceptions as $exception) {
@@ -28,10 +34,8 @@ public function __construct(array $exceptions = [])
2834

2935
/**
3036
* Add an exception to the collection.
31-
*
32-
* @return $this
3337
*/
34-
public function add(\Exception $e)
38+
public function add(\Throwable $e): static
3539
{
3640
if (!$this->message) {
3741
$this->message = $e->getMessage();
@@ -44,34 +48,25 @@ public function add(\Exception $e)
4448

4549
/**
4650
* Get first exception in collection or null, if there is none.
47-
*
48-
* @return \Exception|null
4951
*/
50-
public function getFirst()
52+
public function getFirst(): ?\Throwable
5153
{
5254
if ($this->count() > 0) {
5355
return $this->exceptions[0];
5456
}
57+
58+
return null;
5559
}
5660

57-
/**
58-
* Get exception iterator.
59-
*
60-
* @return \ArrayIterator
61-
*/
62-
#[\ReturnTypeWillChange]
63-
public function getIterator()
61+
public function getIterator(): \ArrayIterator
6462
{
6563
return new \ArrayIterator($this->exceptions);
6664
}
6765

6866
/**
6967
* Get number of exceptions in collection.
70-
*
71-
* @return int
7268
*/
73-
#[\ReturnTypeWillChange]
74-
public function count()
69+
public function count(): int
7570
{
7671
return count($this->exceptions);
7772
}

‎src/Exception/InvalidUrlException.php

+6-10
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,10 @@
1717
class InvalidUrlException extends InvalidArgumentException
1818
{
1919
/**
20-
* @param string $url the invalid URL
21-
* @param string $reason Further explanation why the URL was invalid (optional)
22-
*
23-
* @return self
20+
* @param string $url the invalid URL
21+
* @param string|null $reason Further explanation why the URL was invalid (optional)
2422
*/
25-
public static function invalidUrl($url, $reason = null)
23+
public static function invalidUrl(string $url, ?string $reason = null): InvalidUrlException
2624
{
2725
$msg = sprintf('URL "%s" is invalid.', $url);
2826
if ($reason) {
@@ -33,12 +31,10 @@ public static function invalidUrl($url, $reason = null)
3331
}
3432

3533
/**
36-
* @param string $server Invalid server
37-
* @param array $allowed Allowed URL parts
38-
*
39-
* @return self
34+
* @param string $server Invalid server
35+
* @param string[] $allowed Allowed URL parts
4036
*/
41-
public static function invalidUrlParts($server, array $allowed)
37+
public static function invalidUrlParts(string $server, array $allowed): InvalidUrlException
4238
{
4339
return new self(sprintf(
4440
'Server "%s" is invalid. Only %s URL parts are allowed.',

‎src/Exception/MissingHostException.php

+1-3
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,8 @@ class MissingHostException extends \RuntimeException implements HttpCacheExcepti
1919
{
2020
/**
2121
* @param string $path the path that was asked to be invalidated
22-
*
23-
* @return MissingHostException
2422
*/
25-
public static function missingHost($path)
23+
public static function missingHost(string $path): MissingHostException
2624
{
2725
$msg = sprintf(
2826
'Path "%s" cannot be invalidated without a host. '

‎src/Exception/ProxyResponseException.php

+1-4
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,7 @@
1818
*/
1919
class ProxyResponseException extends \RuntimeException implements HttpCacheException
2020
{
21-
/**
22-
* @return ProxyResponseException
23-
*/
24-
public static function proxyResponse(HttpException $exception)
21+
public static function proxyResponse(HttpException $exception): ProxyResponseException
2522
{
2623
$message = sprintf(
2724
'%s error response "%s" from caching proxy',

‎src/Exception/ProxyUnreachableException.php

+1-4
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,7 @@
1919
*/
2020
class ProxyUnreachableException extends \RuntimeException implements HttpCacheException
2121
{
22-
/**
23-
* @return ProxyUnreachableException
24-
*/
25-
public static function proxyUnreachable(NetworkException $requestException)
22+
public static function proxyUnreachable(NetworkException $requestException): ProxyUnreachableException
2623
{
2724
$message = sprintf(
2825
'Request to caching proxy at %s failed with message "%s"',

‎src/Exception/UnsupportedProxyOperationException.php

+1-3
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,8 @@ class UnsupportedProxyOperationException extends \RuntimeException implements Ht
1919
{
2020
/**
2121
* @param string $method name of the HTTP method that would be required
22-
*
23-
* @return UnsupportedProxyOperationException
2422
*/
25-
public static function cacheDoesNotImplement($method)
23+
public static function cacheDoesNotImplement(string $method): UnsupportedProxyOperationException
2624
{
2725
return new self(sprintf('HTTP cache does not support %s requests', $method));
2826
}

0 commit comments

Comments
 (0)