Skip to content

Commit 6f2938d

Browse files
authored
Merge pull request #302 from FriendsOfSymfony/analysis-8Q3nPp
StyleCI rules updated on the policy where to put dots or not
2 parents b599fd6 + 71420bd commit 6f2938d

22 files changed

+59
-59
lines changed

src/CacheInvalidator.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ public function __construct(ProxyClientInterface $cache)
8181
* refreshPath works and INVALIDATE is about all other invalidation
8282
* methods.
8383
*
84-
* @param string $operation one of the class constants.
84+
* @param string $operation one of the class constants
8585
*
8686
* @return bool
8787
*
@@ -110,7 +110,7 @@ public function supports($operation)
110110
*
111111
* @return $this
112112
*
113-
* @throws \Exception When trying to override the event dispatcher.
113+
* @throws \Exception When trying to override the event dispatcher
114114
*/
115115
public function setEventDispatcher(EventDispatcherInterface $eventDispatcher)
116116
{
@@ -188,7 +188,7 @@ public function refreshPath($path, array $headers = [])
188188
*
189189
* @see BanInterface::ban()
190190
*
191-
* @param array $headers HTTP headers that path must match to be banned.
191+
* @param array $headers HTTP headers that path must match to be banned
192192
*
193193
* @throws UnsupportedProxyOperationException If HTTP cache does not support BAN requests
194194
*
@@ -238,11 +238,11 @@ public function invalidateTags(array $tags)
238238
* @see BanInterface::banPath()
239239
*
240240
* @param string $path Regular expression pattern for URI to
241-
* invalidate.
241+
* invalidate
242242
* @param string $contentType Regular expression pattern for the content
243-
* type to limit banning, for instance 'text'.
243+
* type to limit banning, for instance 'text'
244244
* @param array|string $hosts Regular expression of a host name or list of
245-
* exact host names to limit banning.
245+
* exact host names to limit banning
246246
*
247247
* @throws UnsupportedProxyOperationException If HTTP cache does not support BAN requests
248248
*
@@ -262,9 +262,9 @@ public function invalidateRegex($path, $contentType = null, $hosts = null)
262262
/**
263263
* Send all pending invalidation requests.
264264
*
265-
* @return int The number of cache invalidations performed per caching server.
265+
* @return int The number of cache invalidations performed per caching server
266266
*
267-
* @throws ExceptionCollection If any errors occurred during flush.
267+
* @throws ExceptionCollection If any errors occurred during flush
268268
*/
269269
public function flush()
270270
{

src/Exception/InvalidUrlException.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
class InvalidUrlException extends InvalidArgumentException implements HttpCacheExceptionInterface
1818
{
1919
/**
20-
* @param string $url The invalid URL.
20+
* @param string $url The invalid URL
2121
* @param string $reason Further explanation why the URL was invalid (optional)
2222
*
2323
* @return self

src/Exception/MissingHostException.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
class MissingHostException extends \RuntimeException implements HttpCacheExceptionInterface
1919
{
2020
/**
21-
* @param string $path The path that was asked to be invalidated.
21+
* @param string $path The path that was asked to be invalidated
2222
*
2323
* @return MissingHostException
2424
*/

src/Exception/UnsupportedProxyOperationException.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
class UnsupportedProxyOperationException extends \RuntimeException implements HttpCacheExceptionInterface
1919
{
2020
/**
21-
* @param string $method Name of the HTTP method that would be required.
21+
* @param string $method Name of the HTTP method that would be required
2222
*
2323
* @return UnsupportedProxyOperationException
2424
*/

src/ProxyClient/AbstractProxyClient.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ abstract class AbstractProxyClient implements ProxyClientInterface
4343
/**
4444
* The options configured in the constructor argument or default values.
4545
*
46-
* @var array The resolved options.
46+
* @var array The resolved options
4747
*/
4848
protected $options;
4949

@@ -59,13 +59,13 @@ abstract class AbstractProxyClient implements ProxyClientInterface
5959
* @param array $servers Caching proxy server hostnames or IP
6060
* addresses, including port if not port 80.
6161
* E.g. ['127.0.0.1:6081']
62-
* @param array $options List of options for the client.
62+
* @param array $options List of options for the client
6363
* @param HttpAsyncClient|null $httpClient Client capable of sending HTTP requests. If no
64-
* client is supplied, a default one is created.
64+
* client is supplied, a default one is created
6565
* @param MessageFactory|null $messageFactory Factory for PSR-7 messages. If none supplied,
66-
* a default one is created.
66+
* a default one is created
6767
* @param UriFactory|null $uriFactory Factory for PSR-7 URIs. If not specified, a
68-
* default one is created.
68+
* default one is created
6969
*/
7070
public function __construct(
7171
array $servers,
@@ -127,9 +127,9 @@ protected function queueRequest($method, $url, array $headers)
127127
* Reusable function for proxy clients.
128128
* Escapes `,` and `\n` (newline) characters.
129129
*
130-
* @param array $tags The tags to escape.
130+
* @param array $tags The tags to escape
131131
*
132-
* @return array Sane tags.
132+
* @return array Sane tags
133133
*/
134134
protected function escapeTags(array $tags)
135135
{

src/ProxyClient/Http/HttpAdapter.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ class HttpAdapter
7070
* including base URL, for purge and refresh
7171
* requests (optional). This is required if
7272
* you purge and refresh paths instead of
73-
* absolute URLs.
73+
* absolute URLs
7474
* @param HttpAsyncClient $httpClient
7575
* @param UriFactory $uriFactory
7676
*/
@@ -102,9 +102,9 @@ public function invalidate(RequestInterface $invalidationRequest)
102102
/**
103103
* Send all pending invalidation requests and make sure the requests have terminated and gather exceptions.
104104
*
105-
* @return int The number of cache invalidations performed per caching server.
105+
* @return int The number of cache invalidations performed per caching server
106106
*
107-
* @throws ExceptionCollection If any errors occurred during flush.
107+
* @throws ExceptionCollection If any errors occurred during flush
108108
*/
109109
public function flush()
110110
{
@@ -225,7 +225,7 @@ private function setServers(array $servers)
225225
*
226226
* @param string $uriString Your application’s base URI
227227
*
228-
* @throws InvalidUrlException If the base URI is not a valid URI.
228+
* @throws InvalidUrlException If the base URI is not a valid URI
229229
*/
230230
private function setBaseUri($uriString = null)
231231
{
@@ -250,7 +250,7 @@ private function setBaseUri($uriString = null)
250250
* @return UriInterface Filtered URI (with default scheme if there was no scheme)
251251
*
252252
* @throws InvalidUrlException If URL is invalid, the scheme is not http or
253-
* contains parts that are not expected.
253+
* contains parts that are not expected
254254
*/
255255
private function filterUri($uriString, array $allowedParts = [])
256256
{
@@ -288,9 +288,9 @@ private function filterUri($uriString, array $allowedParts = [])
288288
*
289289
* This signature is used to avoid sending the same invalidation request twice.
290290
*
291-
* @param RequestInterface $request An invalidation request.
291+
* @param RequestInterface $request An invalidation request
292292
*
293-
* @return string A signature for this request.
293+
* @return string A signature for this request
294294
*/
295295
private function getRequestSignature(RequestInterface $request)
296296
{

src/ProxyClient/Invalidation/BanInterface.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ interface BanInterface extends ProxyClientInterface
3434
* host name, configure your proxy to copy the host to a custom HTTP header
3535
* such as X-Host.
3636
*
37-
* @param array $headers HTTP headers that path must match to be banned.
37+
* @param array $headers HTTP headers that path must match to be banned
3838
*
3939
* @return $this
4040
*/
@@ -50,11 +50,11 @@ public function ban(array $headers);
5050
* are matched.
5151
5252
* @param string $path Regular expression pattern for URI to
53-
* invalidate.
53+
* invalidate
5454
* @param string $contentType Regular expression pattern for the content
55-
* type to limit banning, for instance 'text'.
55+
* type to limit banning, for instance 'text'
5656
* @param array|string $hosts Regular expression of a host name or list
57-
* of exact host names to limit banning.
57+
* of exact host names to limit banning
5858
*
5959
* @return $this
6060
*/

src/ProxyClient/Invalidation/PurgeInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ interface PurgeInterface extends ProxyClientInterface
3030
* If the $url is just a path, the proxy client class will add a default
3131
* host name.
3232
*
33-
* @param string $url Path or URL to purge.
33+
* @param string $url Path or URL to purge
3434
* @param array $headers Extra HTTP headers to send to the caching proxy
3535
* (optional)
3636
*

src/ProxyClient/Invalidation/RefreshInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ interface RefreshInterface extends ProxyClientInterface
3131
* If the $url is just a path, the proxy client class will add a default
3232
* host name.
3333
*
34-
* @param string $url Path or URL to refresh.
34+
* @param string $url Path or URL to refresh
3535
* @param array $headers Extra HTTP headers to send to the caching proxy
3636
* (optional)
3737
*

src/ProxyClient/ProxyClientInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ interface ProxyClientInterface
2323
/**
2424
* Send all pending invalidation requests.
2525
*
26-
* @return int The number of cache invalidations performed per caching server.
26+
* @return int The number of cache invalidations performed per caching server
2727
*
28-
* @throws ExceptionCollection If any errors occurred during flush.
28+
* @throws ExceptionCollection If any errors occurred during flush
2929
*/
3030
public function flush();
3131
}

0 commit comments

Comments
 (0)