Merge pull request #489 from FriendsOfSymfony/fix-cs-config

dbu · web-flow · commit 462d9ed929fe · 2020-12-02T11:17:31.000+01:00
Update .styleci.yml
diff --git a/.styleci.yml b/.styleci.yml
@@ -2,7 +2,6 @@ preset: symfony
 
 enabled:
   - alpha_ordered_imports
-  - short_array_syntax
 
 disabled:
   - single_line_throw
diff --git a/src/CacheInvalidator.php b/src/CacheInvalidator.php
@@ -122,8 +122,6 @@ public function supports($operation)
     /**
      * Set event dispatcher - may only be called once.
      *
-     * @param EventDispatcherInterface $eventDispatcher
-     *
      * @throws \Exception when trying to override the event dispatcher
      */
     public function setEventDispatcher(EventDispatcherInterface $eventDispatcher)
diff --git a/src/Event.php b/src/Event.php
@@ -17,8 +17,6 @@ class Event extends BaseEvent
 
     /**
      * Set exception.
-     *
-     * @param \Exception $exception
      */
     public function setException(\Exception $exception)
     {
diff --git a/src/Exception/ExceptionCollection.php b/src/Exception/ExceptionCollection.php
@@ -29,8 +29,6 @@ public function __construct(array $exceptions = [])
     /**
      * Add an exception to the collection.
      *
-     * @param \Exception $e
-     *
      * @return $this
      */
     public function add(\Exception $e)
diff --git a/src/ProxyClient/Dispatcher.php b/src/ProxyClient/Dispatcher.php
@@ -25,11 +25,10 @@ interface Dispatcher
     /**
      * Queue invalidation request.
      *
-     * @param RequestInterface $invalidationRequest
-     * @param bool             $validateHost        If false, do not validate
-     *                                              that we either have a base
-     *                                              uri or the invalidation
-     *                                              request specifies the host
+     * @param bool $validateHost If false, do not validate
+     *                           that we either have a base
+     *                           uri or the invalidation
+     *                           request specifies the host
      */
     public function invalidate(RequestInterface $invalidationRequest, $validateHost = true);
 
diff --git a/src/ProxyClient/HttpProxyClient.php b/src/ProxyClient/HttpProxyClient.php
@@ -86,7 +86,6 @@ protected function configureOptions()
      *
      * @param string                               $method
      * @param string|UriInterface                  $url
-     * @param array                                $headers
      * @param bool                                 $validateHost see Dispatcher::invalidate
      * @param resource|string|StreamInterface|null $body
      */
diff --git a/src/ProxyClient/MultiplexerClient.php b/src/ProxyClient/MultiplexerClient.php
@@ -103,8 +103,6 @@ public function flush()
      *
      * {@inheritdoc}
      *
-     * @param array $tags
-     *
      * @return $this
      */
     public function invalidateTags(array $tags)
diff --git a/src/ResponseTagger.php b/src/ResponseTagger.php
@@ -55,8 +55,6 @@ class ResponseTagger
      *
      * - header_formatter (TagHeaderFormatter) Default: CommaSeparatedTagHeaderFormatter with default header name
      * - strict (bool) Default: false. If set to true, throws exception when adding empty tags
-     *
-     * @param array $options
      */
     public function __construct(array $options = [])
     {
diff --git a/src/SymfonyCache/CacheEvent.php b/src/SymfonyCache/CacheEvent.php
@@ -104,8 +104,6 @@ public function getResponse()
      * Sets a response to use instead of continuing to handle this request.
      *
      * Setting a response stops propagation of the event to further event handlers.
-     *
-     * @param Response $response
      */
     public function setResponse(Response $response)
     {
diff --git a/src/SymfonyCache/CustomTtlListener.php b/src/SymfonyCache/CustomTtlListener.php
@@ -50,8 +50,6 @@ public function __construct($ttlHeader = 'X-Reverse-Proxy-TTL')
      *
      * If there is such a header, the original s_maxage is backed up to the
      * static::SMAXAGE_BACKUP header.
-     *
-     * @param CacheEvent $e
      */
     public function useCustomTtl(CacheEvent $e)
     {
@@ -69,8 +67,6 @@ public function useCustomTtl(CacheEvent $e)
 
     /**
      * Remove the custom TTL header and restore s_maxage from the backup.
-     *
-     * @param CacheEvent $e
      */
     public function cleanResponse(CacheEvent $e)
     {
diff --git a/src/SymfonyCache/DebugListener.php b/src/SymfonyCache/DebugListener.php
@@ -39,8 +39,6 @@ public static function getSubscribedEvents()
      *
      * For this header to be present, the HttpCache must be created with the
      * debug option set to true.
-     *
-     * @param CacheEvent $event
      */
     public function handleDebug(CacheEvent $event)
     {
diff --git a/src/SymfonyCache/EventDispatchingHttpCache.php b/src/SymfonyCache/EventDispatchingHttpCache.php
@@ -135,7 +135,6 @@ protected function invalidate(Request $request, $catch = false)
      * Dispatch an event if needed.
      *
      * @param string        $name        Name of the event to trigger. One of the constants in FOS\HttpCache\SymfonyCache\Events
-     * @param Request       $request
      * @param Response|null $response    If already available
      * @param int           $requestType The request type (default HttpKernelInterface::MASTER_REQUEST)
      *
diff --git a/src/SymfonyCache/HttpCacheAware.php b/src/SymfonyCache/HttpCacheAware.php
@@ -31,9 +31,6 @@ public function getHttpCache()
         return $this->httpCache;
     }
 
-    /**
-     * @param HttpKernelInterface $httpCache
-     */
     public function setHttpCache(HttpKernelInterface $httpCache)
     {
         $this->httpCache = $httpCache;
diff --git a/src/SymfonyCache/PurgeListener.php b/src/SymfonyCache/PurgeListener.php
@@ -77,8 +77,6 @@ public static function getSubscribedEvents()
      * Look at unsafe requests and handle purge requests.
      *
      * Prevents access when the request comes from a non-authorized client.
-     *
-     * @param CacheEvent $event
      */
     public function handlePurge(CacheEvent $event)
     {
diff --git a/src/SymfonyCache/PurgeTagsListener.php b/src/SymfonyCache/PurgeTagsListener.php
@@ -81,8 +81,6 @@ public static function getSubscribedEvents()
      * Look at unsafe requests and handle purge tags requests.
      *
      * Prevents access when the request comes from a non-authorized client.
-     *
-     * @param CacheEvent $event
      */
     public function handlePurgeTags(CacheEvent $event)
     {
diff --git a/src/SymfonyCache/RefreshListener.php b/src/SymfonyCache/RefreshListener.php
@@ -40,8 +40,6 @@ public static function getSubscribedEvents()
      *
      * When the request comes from a non-authorized client, ignore refresh to
      * let normal lookup happen.
-     *
-     * @param CacheEvent $event
      */
     public function handleRefresh(CacheEvent $event)
     {
diff --git a/src/SymfonyCache/UserContextListener.php b/src/SymfonyCache/UserContextListener.php
@@ -102,8 +102,6 @@ public static function getSubscribedEvents()
      *
      * Checks if an external request tries tampering with the use context hash mechanism
      * to prevent attacks.
-     *
-     * @param CacheEvent $event
      */
     public function preHandle(CacheEvent $event)
     {
@@ -133,9 +131,6 @@ public function preHandle(CacheEvent $event)
      *
      * Cleans cookies header to only keep the session identifier cookie, so the hash lookup request
      * can be cached per session.
-     *
-     * @param Request $hashLookupRequest
-     * @param Request $originalRequest
      */
     protected function cleanupHashLookupRequest(Request $hashLookupRequest, Request $originalRequest)
     {
@@ -161,8 +156,6 @@ protected function cleanupHashLookupRequest(Request $hashLookupRequest, Request
     /**
      * Checks if passed request object is to be considered internal (e.g. for user hash lookup).
      *
-     * @param Request $request
-     *
      * @return bool
      */
     private function isInternalRequest(Request $request)
@@ -173,9 +166,6 @@ private function isInternalRequest(Request $request)
     /**
      * Returns the user context hash for $request.
      *
-     * @param HttpKernelInterface $kernel
-     * @param Request             $request
-     *
      * @return string
      */
     private function getUserHash(HttpKernelInterface $kernel, Request $request)
@@ -200,8 +190,6 @@ private function getUserHash(HttpKernelInterface $kernel, Request $request)
     /**
      * Checks if current request is considered anonymous.
      *
-     * @param Request $request
-     *
      * @return bool
      */
     private function isAnonymous(Request $request)
@@ -229,8 +217,6 @@ private function isSessionName($name)
     /**
      * Generates the request object that will be forwarded to get the user context hash.
      *
-     * @param Request $request
-     *
      * @return Request the request that will return the user context hash value
      */
     private function generateHashLookupRequest(Request $request)
diff --git a/src/TagHeaderFormatter/MaxHeaderValueLengthFormatter.php b/src/TagHeaderFormatter/MaxHeaderValueLengthFormatter.php
@@ -39,8 +39,7 @@ class MaxHeaderValueLengthFormatter implements TagHeaderFormatter
      * HTTP messages cannot carry characters outside the ISO-8859-1 standard so they all
      * use up just one byte.
      *
-     * @param TagHeaderFormatter $inner
-     * @param int                $maxHeaderValueLength
+     * @param int $maxHeaderValueLength
      */
     public function __construct(TagHeaderFormatter $inner, $maxHeaderValueLength = 4096)
     {
@@ -97,8 +96,6 @@ private function isHeaderTooLong($value)
     /**
      * Split an array of tags in two more or less equal sized arrays.
      *
-     * @param array $tags
-     *
      * @return array
      *
      * @throws InvalidTagException
diff --git a/src/TagHeaderFormatter/TagHeaderFormatter.php b/src/TagHeaderFormatter/TagHeaderFormatter.php
@@ -37,8 +37,6 @@ public function getTagsHeaderName();
      *
      * This concatenates all tags and ensures correct encoding.
      *
-     * @param array $tags
-     *
      * @return string|string[]
      */
     public function getTagsHeaderValue(array $tags);
diff --git a/src/Test/CacheAssertions.php b/src/Test/CacheAssertions.php
@@ -31,8 +31,7 @@ trait CacheAssertions
     /**
      * Assert a cache miss.
      *
-     * @param ResponseInterface $response
-     * @param string            $message  Test failure message (optional)
+     * @param string $message Test failure message (optional)
      */
     public function assertMiss(ResponseInterface $response, $message = '')
     {
@@ -42,8 +41,7 @@ public function assertMiss(ResponseInterface $response, $message = '')
     /**
      * Assert a cache hit.
      *
-     * @param ResponseInterface $response
-     * @param string            $message  Test failure message (optional)
+     * @param string $message Test failure message (optional)
      */
     public function assertHit(ResponseInterface $response, $message = '')
     {
diff --git a/src/Test/EventDispatchingHttpCacheTestCase.php b/src/Test/EventDispatchingHttpCacheTestCase.php
@@ -81,10 +81,6 @@ protected function getHttpCachePartialMock(array $mockedMethods = null)
 
     /**
      * Set the store property on a HttpCache to a StoreInterface expecting one write with request and response.
-     *
-     * @param CacheInvalidation $httpCache
-     * @param Request           $request
-     * @param Response          $response
      */
     protected function setStoreMock(CacheInvalidation $httpCache, Request $request, Response $response)
     {
diff --git a/src/Test/HttpClient.php b/src/Test/HttpClient.php
@@ -70,8 +70,6 @@ public function getResponse($uri, array $headers, $method)
     /**
      * Send PSR HTTP request to your application.
      *
-     * @param RequestInterface $request
-     *
      * @return ResponseInterface
      */
     public function sendRequest(RequestInterface $request)
diff --git a/src/Test/Proxy/AbstractProxy.php b/src/Test/Proxy/AbstractProxy.php
@@ -95,7 +95,6 @@ protected function wait($timeout, $callback)
      * Run a shell command.
      *
      * @param string $command
-     * @param array  $arguments
      *
      * @throws \RuntimeException If command execution fails
      */
diff --git a/src/UserContext/ContextProvider.php b/src/UserContext/ContextProvider.php
@@ -20,8 +20,6 @@ interface ContextProvider
      * This function is called before generating the hash of a UserContext.
      *
      * This allow to add a parameter on UserContext or set the whole array of parameters
-     *
-     * @param UserContext $context
      */
     public function updateUserContext(UserContext $context);
 }
diff --git a/src/UserContext/UserContext.php b/src/UserContext/UserContext.php
@@ -35,8 +35,6 @@ public function addParameter($key, $value)
 
     /**
      * Set all the parameters of this context.
-     *
-     * @param array $parameters
      */
     public function setParameters(array $parameters)
     {
diff --git a/tests/Functional/ProxyClient/NginxProxyClientTest.php b/tests/Functional/ProxyClient/NginxProxyClientTest.php
@@ -19,8 +19,8 @@
  */
 class NginxProxyClientTest extends NginxTestCase
 {
-    use RefreshAssertions;
     use PurgeAssertions;
+    use RefreshAssertions;
 
     public function testPurgeSeparateLocation()
     {
diff --git a/tests/Functional/ProxyClient/SymfonyProxyClientTest.php b/tests/Functional/ProxyClient/SymfonyProxyClientTest.php
@@ -20,9 +20,9 @@
  */
 class SymfonyProxyClientTest extends SymfonyTestCase
 {
-    use RefreshAssertions;
-    use PurgeAssertions;
     use InvalidateTagsAssertions;
+    use PurgeAssertions;
+    use RefreshAssertions;
 
     public function testPurge()
     {
diff --git a/tests/Functional/ProxyClient/VarnishProxyClientTest.php b/tests/Functional/ProxyClient/VarnishProxyClientTest.php
@@ -20,9 +20,9 @@
  */
 class VarnishProxyClientTest extends VarnishTestCase
 {
-    use RefreshAssertions;
-    use PurgeAssertions;
     use BanAssertions;
+    use PurgeAssertions;
+    use RefreshAssertions;
 
     public function testBanAll()
     {

Original file line number	Diff line number	Diff line change
`@@ -122,8 +122,6 @@ public function supports($operation)`
`122`	`122`	`/**`
`123`	`123`	`* Set event dispatcher - may only be called once.`
`124`	`124`	`*`
`125`		`- * @param EventDispatcherInterface $eventDispatcher`
`126`		`- *`
`127`	`125`	`* @throws \Exception when trying to override the event dispatcher`
`128`	`126`	`*/`
`129`	`127`	`public function setEventDispatcher(EventDispatcherInterface $eventDispatcher)`
Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,6 @@ class Event extends BaseEvent`
`17`	`17`
`18`	`18`	`/**`
`19`	`19`	`* Set exception.`
`20`		`- *`
`21`		`- * @param \Exception $exception`
`22`	`20`	`*/`
`23`	`21`	`public function setException(\Exception $exception)`
`24`	`22`	`{`
Original file line number	Diff line number	Diff line change
`@@ -29,8 +29,6 @@ public function __construct(array $exceptions = [])`
`29`	`29`	`/**`
`30`	`30`	`* Add an exception to the collection.`
`31`	`31`	`*`
`32`		`- * @param \Exception $e`
`33`		`- *`
`34`	`32`	`* @return $this`
`35`	`33`	`*/`
`36`	`34`	`public function add(\Exception $e)`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,6 @@ protected function configureOptions()`
`86`	`86`	`*`
`87`	`87`	`* @param string $method`
`88`	`88`	`* @param string\|UriInterface $url`
`89`		`- * @param array $headers`
`90`	`89`	`* @param bool $validateHost see Dispatcher::invalidate`
`91`	`90`	`* @param resource\|string\|StreamInterface\|null $body`
`92`	`91`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -103,8 +103,6 @@ public function flush()`
`103`	`103`	`*`
`104`	`104`	`* {@inheritdoc}`
`105`	`105`	`*`
`106`		`- * @param array $tags`
`107`		`- *`
`108`	`106`	`* @return $this`
`109`	`107`	`*/`
`110`	`108`	`public function invalidateTags(array $tags)`
Original file line number	Diff line number	Diff line change
`@@ -55,8 +55,6 @@ class ResponseTagger`
`55`	`55`	`*`
`56`	`56`	`* - header_formatter (TagHeaderFormatter) Default: CommaSeparatedTagHeaderFormatter with default header name`
`57`	`57`	`* - strict (bool) Default: false. If set to true, throws exception when adding empty tags`
`58`		`- *`
`59`		`- * @param array $options`
`60`	`58`	`*/`
`61`	`59`	`public function __construct(array $options = [])`
`62`	`60`	`{`
Original file line number	Diff line number	Diff line change
`@@ -104,8 +104,6 @@ public function getResponse()`
`104`	`104`	`* Sets a response to use instead of continuing to handle this request.`
`105`	`105`	`*`
`106`	`106`	`* Setting a response stops propagation of the event to further event handlers.`
`107`		`- *`
`108`		`- * @param Response $response`
`109`	`107`	`*/`
`110`	`108`	`public function setResponse(Response $response)`
`111`	`109`	`{`
Original file line number	Diff line number	Diff line change
`@@ -50,8 +50,6 @@ public function __construct($ttlHeader = 'X-Reverse-Proxy-TTL')`
`50`	`50`	`*`
`51`	`51`	`* If there is such a header, the original s_maxage is backed up to the`
`52`	`52`	`* static::SMAXAGE_BACKUP header.`
`53`		`- *`
`54`		`- * @param CacheEvent $e`
`55`	`53`	`*/`
`56`	`54`	`public function useCustomTtl(CacheEvent $e)`
`57`	`55`	`{`
`@@ -69,8 +67,6 @@ public function useCustomTtl(CacheEvent $e)`
`69`	`67`
`70`	`68`	`/**`
`71`	`69`	`* Remove the custom TTL header and restore s_maxage from the backup.`
`72`		`- *`
`73`		`- * @param CacheEvent $e`
`74`	`70`	`*/`
`75`	`71`	`public function cleanResponse(CacheEvent $e)`
`76`	`72`	`{`