Merge branch '3.3' into 3.4

nicolas-grekas · nicolas-grekas · commit 629895c3efce · 2017-11-07T15:20:24.000+01:00
* 3.3:
  [3.3] More docblock fixes
  [2.7] More docblock fixes
diff --git a/src/Symfony/Bridge/Doctrine/Tests/Fixtures/Type/StringWrapper.php b/src/Symfony/Bridge/Doctrine/Tests/Fixtures/Type/StringWrapper.php
@@ -13,9 +13,6 @@
 
 class StringWrapper
 {
-    /**
-     * @var string
-     */
     private $string;
 
     /**
diff --git a/src/Symfony/Bridge/PhpUnit/Legacy/SymfonyTestsListenerTrait.php b/src/Symfony/Bridge/PhpUnit/Legacy/SymfonyTestsListenerTrait.php
@@ -340,7 +340,7 @@ public function handleError($type, $msg, $file, $line, $context = array())
     }
 
     /**
-     * @param Test $test
+     * @param TestCase $test
      *
      * @return bool
      */
diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php
@@ -409,8 +409,6 @@ private function getContainerDefinitionDocument(Definition $definition, $id = nu
     }
 
     /**
-     * @param array $arguments
-     *
      * @return \DOMNode[]
      */
     private function getArgumentNodes(array $arguments, \DOMDocument $dom)
@@ -521,10 +519,6 @@ private function getEventDispatcherListenersDocument(EventDispatcherInterface $e
         return $dom;
     }
 
-    /**
-     * @param \DOMElement $element
-     * @param array       $eventListeners
-     */
     private function appendEventListenerDocument(EventDispatcherInterface $eventDispatcher, $event, \DOMElement $element, array $eventListeners)
     {
         foreach ($eventListeners as $listener) {
diff --git a/src/Symfony/Component/BrowserKit/Cookie.php b/src/Symfony/Component/BrowserKit/Cookie.php
@@ -80,10 +80,6 @@ public function __construct($name, $value, $expires = null, $path = null, $domai
 
     /**
      * Returns the HTTP representation of the Cookie.
-     *
-     * @return string The HTTP representation of the Cookie
-     *
-     * @throws \UnexpectedValueException
      */
     public function __toString()
     {
diff --git a/src/Symfony/Component/Cache/Adapter/PhpArrayAdapter.php b/src/Symfony/Component/Cache/Adapter/PhpArrayAdapter.php
@@ -227,10 +227,6 @@ public function commit()
     }
 
     /**
-     * Generator for items.
-     *
-     * @param array $keys
-     *
      * @return \Generator
      */
     private function generateItems(array $keys)
diff --git a/src/Symfony/Component/Config/ResourceCheckerConfigCacheFactory.php b/src/Symfony/Component/Config/ResourceCheckerConfigCacheFactory.php
@@ -19,9 +19,6 @@
  */
 class ResourceCheckerConfigCacheFactory implements ConfigCacheFactoryInterface
 {
-    /**
-     * @var iterable|ResourceCheckerInterface[]
-     */
     private $resourceCheckers = array();
 
     /**
diff --git a/src/Symfony/Component/Console/Descriptor/TextDescriptor.php b/src/Symfony/Component/Console/Descriptor/TextDescriptor.php
@@ -253,11 +253,9 @@ private function writeText($content, array $options = array())
     /**
      * Formats command aliases to show them in the command description.
      *
-     * @param Command $command
-     *
      * @return string
      */
-    private function getCommandAliasesText($command)
+    private function getCommandAliasesText(Command $command)
     {
         $text = '';
         $aliases = $command->getAliases();
diff --git a/src/Symfony/Component/Console/Helper/Table.php b/src/Symfony/Component/Console/Helper/Table.php
@@ -504,8 +504,6 @@ private function fillNextRows(array $rows, $line)
     /**
      * fill cells for a row that contains colspan > 1.
      *
-     * @param array|\Traversable $row
-     *
      * @return array
      */
     private function fillCells($row)
@@ -578,10 +576,8 @@ private function getRowColumns(array $row)
 
     /**
      * Calculates columns widths.
-     *
-     * @param array $rows
      */
-    private function calculateColumnsWidth($rows)
+    private function calculateColumnsWidth(array $rows)
     {
         for ($column = 0; $column < $this->numberOfColumns; ++$column) {
             $lengths = array();
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/GraphvizDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/GraphvizDumper.php
@@ -53,8 +53,6 @@ class GraphvizDumper extends Dumper
      *  * node.definition: The default options for services that are defined via service definition instances
      *  * node.missing: The default options for missing services
      *
-     * @param array $options An array of options
-     *
      * @return string The dot representation of the service container
      */
     public function dump(array $options = array())
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php
@@ -65,7 +65,7 @@ class PhpDumper extends Dumper
     private $asFiles;
 
     /**
-     * @var \Symfony\Component\DependencyInjection\LazyProxy\PhpDumper\DumperInterface
+     * @var ProxyDumper
      */
     private $proxyDumper;
 
diff --git a/src/Symfony/Component/DependencyInjection/Variable.php b/src/Symfony/Component/DependencyInjection/Variable.php
@@ -36,11 +36,6 @@ public function __construct($name)
         $this->name = $name;
     }
 
-    /**
-     * Converts the object to a string.
-     *
-     * @return string
-     */
     public function __toString()
     {
         return $this->name;
diff --git a/src/Symfony/Component/Filesystem/Tests/FilesystemTest.php b/src/Symfony/Component/Filesystem/Tests/FilesystemTest.php
@@ -1093,9 +1093,6 @@ public function testMakePathRelative($endPath, $startPath, $expectedPath)
         $this->assertEquals($expectedPath, $path);
     }
 
-    /**
-     * @return array
-     */
     public function providePathsForMakePathRelative()
     {
         $paths = array(
@@ -1350,9 +1347,6 @@ public function testIsAbsolutePath($path, $expectedResult)
         $this->assertEquals($expectedResult, $result);
     }
 
-    /**
-     * @return array
-     */
     public function providePathsForIsAbsolutePath()
     {
         return array(
diff --git a/src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php b/src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php
@@ -364,10 +364,6 @@ public function getBlockPrefix()
 
     /**
      * Adds the sub fields for an expanded choice field.
-     *
-     * @param FormBuilderInterface $builder     The form builder
-     * @param array                $choiceViews The choice view objects
-     * @param array                $options     The build options
      */
     private function addSubForms(FormBuilderInterface $builder, array $choiceViews, array $options)
     {
@@ -388,11 +384,6 @@ private function addSubForms(FormBuilderInterface $builder, array $choiceViews,
     }
 
     /**
-     * @param FormBuilderInterface $builder
-     * @param                      $name
-     * @param                      $choiceView
-     * @param array                $options
-     *
      * @return mixed
      */
     private function addSubForm(FormBuilderInterface $builder, $name, ChoiceView $choiceView, array $options)
diff --git a/src/Symfony/Component/Form/FormEvent.php b/src/Symfony/Component/Form/FormEvent.php
@@ -21,12 +21,6 @@ class FormEvent extends Event
     private $form;
     protected $data;
 
-    /**
-     * Constructs an event.
-     *
-     * @param FormInterface $form The associated form
-     * @param mixed         $data The data
-     */
     public function __construct(FormInterface $form, $data)
     {
         $this->form = $form;
diff --git a/src/Symfony/Component/Form/Tests/Extension/Core/DataMapper/PropertyPathMapperTest.php b/src/Symfony/Component/Form/Tests/Extension/Core/DataMapper/PropertyPathMapperTest.php
@@ -41,8 +41,6 @@ protected function setUp()
     }
 
     /**
-     * @param $path
-     *
      * @return \PHPUnit_Framework_MockObject_MockObject
      */
     private function getPropertyPath($path)
diff --git a/src/Symfony/Component/HttpKernel/DataCollector/RequestDataCollector.php b/src/Symfony/Component/HttpKernel/DataCollector/RequestDataCollector.php
@@ -20,13 +20,10 @@
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 /**
- * RequestDataCollector.
- *
  * @author Fabien Potencier <fabien@symfony.com>
  */
 class RequestDataCollector extends DataCollector implements EventSubscriberInterface, LateDataCollectorInterface
 {
-    /** @var \SplObjectStorage */
     protected $controllers;
 
     public function __construct()
diff --git a/src/Symfony/Component/HttpKernel/Event/FilterControllerArgumentsEvent.php b/src/Symfony/Component/HttpKernel/Event/FilterControllerArgumentsEvent.php
@@ -45,9 +45,6 @@ public function getArguments()
         return $this->arguments;
     }
 
-    /**
-     * @param array $arguments
-     */
     public function setArguments(array $arguments)
     {
         $this->arguments = $arguments;
diff --git a/src/Symfony/Component/HttpKernel/Event/FilterControllerEvent.php b/src/Symfony/Component/HttpKernel/Event/FilterControllerEvent.php
@@ -27,9 +27,6 @@
  */
 class FilterControllerEvent extends KernelEvent
 {
-    /**
-     * The current controller.
-     */
     private $controller;
 
     public function __construct(HttpKernelInterface $kernel, callable $controller, Request $request, $requestType)
@@ -49,11 +46,6 @@ public function getController()
         return $this->controller;
     }
 
-    /**
-     * Sets a new controller.
-     *
-     * @param callable $controller
-     */
     public function setController(callable $controller)
     {
         $this->controller = $controller;
diff --git a/src/Symfony/Component/HttpKernel/EventListener/AbstractTestSessionListener.php b/src/Symfony/Component/HttpKernel/EventListener/AbstractTestSessionListener.php
@@ -50,8 +50,6 @@ public function onKernelRequest(GetResponseEvent $event)
     /**
      * Checks if session was initialized and saves if current request is master
      * Runs on 'kernel.response' in test environment.
-     *
-     * @param FilterResponseEvent $event
      */
     public function onKernelResponse(FilterResponseEvent $event)
     {
diff --git a/src/Symfony/Component/HttpKernel/HttpCache/AbstractSurrogate.php b/src/Symfony/Component/HttpKernel/HttpCache/AbstractSurrogate.php
@@ -113,8 +113,6 @@ public function handle(HttpCache $cache, $uri, $alt, $ignoreErrors)
 
     /**
      * Remove the Surrogate from the Surrogate-Control header.
-     *
-     * @param Response $response
      */
     protected function removeFromControl(Response $response)
     {
diff --git a/src/Symfony/Component/HttpKernel/HttpCache/HttpCache.php b/src/Symfony/Component/HttpKernel/HttpCache/HttpCache.php
@@ -67,11 +67,6 @@ class HttpCache implements HttpKernelInterface, TerminableInterface
      *                            the cache can serve a stale response when an error is encountered (default: 60).
      *                            This setting is overridden by the stale-if-error HTTP Cache-Control extension
      *                            (see RFC 5861).
-     *
-     * @param HttpKernelInterface $kernel    An HttpKernelInterface instance
-     * @param StoreInterface      $store     A Store instance
-     * @param SurrogateInterface  $surrogate A SurrogateInterface instance
-     * @param array               $options   An array of options
      */
     public function __construct(HttpKernelInterface $kernel, StoreInterface $store, SurrogateInterface $surrogate = null, array $options = array())
     {
diff --git a/src/Symfony/Component/HttpKernel/Kernel.php b/src/Symfony/Component/HttpKernel/Kernel.php
@@ -543,8 +543,6 @@ protected function initializeBundles()
      * The extension point similar to the Bundle::build() method.
      *
      * Use this method to register compiler passes and manipulate the container during the building process.
-     *
-     * @param ContainerBuilder $container
      */
     protected function build(ContainerBuilder $container)
     {
diff --git a/src/Symfony/Component/HttpKernel/Tests/EventListener/ExceptionListenerTest.php b/src/Symfony/Component/HttpKernel/Tests/EventListener/ExceptionListenerTest.php
@@ -96,8 +96,8 @@ public function provider()
 
         $request = new Request();
         $exception = new \Exception('foo');
-        $event = new GetResponseForExceptionEvent(new TestKernel(), $request, 'foo', $exception);
-        $event2 = new GetResponseForExceptionEvent(new TestKernelThatThrowsException(), $request, 'foo', $exception);
+        $event = new GetResponseForExceptionEvent(new TestKernel(), $request, HttpKernelInterface::MASTER_REQUEST, $exception);
+        $event2 = new GetResponseForExceptionEvent(new TestKernelThatThrowsException(), $request, HttpKernelInterface::MASTER_REQUEST, $exception);
 
         return array(
             array($event, $event2),
@@ -116,7 +116,7 @@ public function testSubRequestFormat()
         $request = Request::create('/');
         $request->setRequestFormat('xml');
 
-        $event = new GetResponseForExceptionEvent($kernel, $request, 'foo', new \Exception('foo'));
+        $event = new GetResponseForExceptionEvent($kernel, $request, HttpKernelInterface::MASTER_REQUEST, new \Exception('foo'));
         $listener->onKernelException($event);
 
         $response = $event->getResponse();
diff --git a/src/Symfony/Component/Routing/RouteCompiler.php b/src/Symfony/Component/Routing/RouteCompiler.php
@@ -233,9 +233,6 @@ private static function compilePattern(Route $route, $pattern, $isHost)
     /**
      * Determines the longest static prefix possible for a route.
      *
-     * @param Route $route
-     * @param array $tokens
-     *
      * @return string The leading static part of a route's path
      */
     private static function determineStaticPrefix(Route $route, array $tokens)
diff --git a/src/Symfony/Component/Routing/Tests/CompiledRouteTest.php b/src/Symfony/Component/Routing/Tests/CompiledRouteTest.php
@@ -18,7 +18,7 @@ class CompiledRouteTest extends TestCase
 {
     public function testAccessors()
     {
-        $compiled = new CompiledRoute('prefix', 'regex', array('tokens'), array(), array(), array(), array(), array('variables'));
+        $compiled = new CompiledRoute('prefix', 'regex', array('tokens'), array(), null, array(), array(), array('variables'));
         $this->assertEquals('prefix', $compiled->getStaticPrefix(), '__construct() takes a static prefix as its second argument');
         $this->assertEquals('regex', $compiled->getRegex(), '__construct() takes a regexp as its third argument');
         $this->assertEquals(array('tokens'), $compiled->getTokens(), '__construct() takes an array of tokens as its fourth argument');
diff --git a/src/Symfony/Component/Security/Guard/Authenticator/AbstractFormLoginAuthenticator.php b/src/Symfony/Component/Security/Guard/Authenticator/AbstractFormLoginAuthenticator.php
@@ -39,9 +39,6 @@ abstract protected function getLoginUrl();
     /**
      * Override to change what happens after a bad username/password is submitted.
      *
-     * @param Request                 $request
-     * @param AuthenticationException $exception
-     *
      * @return RedirectResponse
      */
     public function onAuthenticationFailure(Request $request, AuthenticationException $exception)
@@ -96,9 +93,6 @@ public function supportsRememberMe()
      * Override to control what happens when the user hits a secure page
      * but isn't logged in yet.
      *
-     * @param Request                      $request
-     * @param AuthenticationException|null $authException
-     *
      * @return RedirectResponse
      */
     public function start(Request $request, AuthenticationException $authException = null)
diff --git a/src/Symfony/Component/Security/Guard/Firewall/GuardAuthenticationListener.php b/src/Symfony/Component/Security/Guard/Firewall/GuardAuthenticationListener.php
@@ -63,8 +63,6 @@ public function __construct(GuardAuthenticatorHandler $guardHandler, Authenticat
 
     /**
      * Iterates over each authenticator to see if each wants to authenticate the request.
-     *
-     * @param GetResponseEvent $event
      */
     public function handle(GetResponseEvent $event)
     {
@@ -186,8 +184,6 @@ private function executeGuardAuthenticator($uniqueGuardKey, GuardAuthenticatorIn
 
     /**
      * Should be called if this listener will support remember me.
-     *
-     * @param RememberMeServicesInterface $rememberMeServices
      */
     public function setRememberMeServices(RememberMeServicesInterface $rememberMeServices)
     {
@@ -197,11 +193,6 @@ public function setRememberMeServices(RememberMeServicesInterface $rememberMeSer
     /**
      * Checks to see if remember me is supported in the authenticator and
      * on the firewall. If it is, the RememberMeServicesInterface is notified.
-     *
-     * @param AuthenticatorInterface $guardAuthenticator
-     * @param Request                $request
-     * @param TokenInterface         $token
-     * @param Response               $response
      */
     private function triggerRememberMe(GuardAuthenticatorInterface $guardAuthenticator, Request $request, TokenInterface $token, Response $response = null)
     {
diff --git a/src/Symfony/Component/Security/Http/Authentication/DefaultAuthenticationFailureHandler.php b/src/Symfony/Component/Security/Http/Authentication/DefaultAuthenticationFailureHandler.php
@@ -42,12 +42,6 @@ class DefaultAuthenticationFailureHandler implements AuthenticationFailureHandle
         'failure_path_parameter' => '_failure_path',
     );
 
-    /**
-     * @param HttpKernelInterface $httpKernel
-     * @param HttpUtils           $httpUtils
-     * @param array               $options    Options for processing a failed authentication attempt
-     * @param LoggerInterface     $logger     Optional logger
-     */
     public function __construct(HttpKernelInterface $httpKernel, HttpUtils $httpUtils, array $options = array(), LoggerInterface $logger = null)
     {
         $this->httpKernel = $httpKernel;
diff --git a/src/Symfony/Component/Serializer/Mapping/ClassMetadata.php b/src/Symfony/Component/Serializer/Mapping/ClassMetadata.php
@@ -19,8 +19,6 @@
 class ClassMetadata implements ClassMetadataInterface
 {
     /**
-     * @var string
-     *
      * @internal This property is public in order to reduce the size of the
      *           class' serialized representation. Do not access it. Use
      *           {@link getName()} instead.
diff --git a/src/Symfony/Component/Serializer/Normalizer/DateTimeNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/DateTimeNormalizer.php
diff --git a/src/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/GetSetMethodNormalizer.php
diff --git a/src/Symfony/Component/Templating/Loader/FilesystemLoader.php b/src/Symfony/Component/Templating/Loader/FilesystemLoader.php
diff --git a/src/Symfony/Component/Translation/Tests/Writer/TranslationWriterTest.php b/src/Symfony/Component/Translation/Tests/Writer/TranslationWriterTest.php
diff --git a/src/Symfony/Component/Validator/Mapping/Cache/Psr6Cache.php b/src/Symfony/Component/Validator/Mapping/Cache/Psr6Cache.php
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/FileTest.php b/src/Symfony/Component/Validator/Tests/Constraints/FileTest.php
diff --git a/src/Symfony/Component/VarDumper/Cloner/Data.php b/src/Symfony/Component/VarDumper/Cloner/Data.php

Original file line number	Diff line number	Diff line change
`@@ -13,9 +13,6 @@`
`13`	`13`
`14`	`14`	`class StringWrapper`
`15`	`15`	`{`
`16`		`- /**`
`17`		`- * @var string`
`18`		`- */`
`19`	`16`	`private $string;`
`20`	`17`
`21`	`18`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -340,7 +340,7 @@ public function handleError($type, $msg, $file, $line, $context = array())`
`340`	`340`	`}`
`341`	`341`
`342`	`342`	`/**`
`343`		`- * @param Test $test`
	`343`	`+ * @param TestCase $test`
`344`	`344`	`*`
`345`	`345`	`* @return bool`
`346`	`346`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -409,8 +409,6 @@ private function getContainerDefinitionDocument(Definition $definition, $id = nu`
`409`	`409`	`}`
`410`	`410`
`411`	`411`	`/**`
`412`		`- * @param array $arguments`
`413`		`- *`
`414`	`412`	`* @return \DOMNode[]`
`415`	`413`	`*/`
`416`	`414`	`private function getArgumentNodes(array $arguments, \DOMDocument $dom)`
`@@ -521,10 +519,6 @@ private function getEventDispatcherListenersDocument(EventDispatcherInterface $e`
`521`	`519`	`return $dom;`
`522`	`520`	`}`
`523`	`521`
`524`		`- /**`
`525`		`- * @param \DOMElement $element`
`526`		`- * @param array $eventListeners`
`527`		`- */`
`528`	`522`	`private function appendEventListenerDocument(EventDispatcherInterface $eventDispatcher, $event, \DOMElement $element, array $eventListeners)`
`529`	`523`	`{`
`530`	`524`	`foreach ($eventListeners as $listener) {`
Original file line number	Diff line number	Diff line change
`@@ -19,9 +19,6 @@`
`19`	`19`	`*/`
`20`	`20`	`class ResourceCheckerConfigCacheFactory implements ConfigCacheFactoryInterface`
`21`	`21`	`{`
`22`		`- /**`
`23`		`- * @var iterable\|ResourceCheckerInterface[]`
`24`		`- */`
`25`	`22`	`private $resourceCheckers = array();`
`26`	`23`
`27`	`24`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -253,11 +253,9 @@ private function writeText($content, array $options = array())`
`253`	`253`	`/**`
`254`	`254`	`* Formats command aliases to show them in the command description.`
`255`	`255`	`*`
`256`		`- * @param Command $command`
`257`		`- *`
`258`	`256`	`* @return string`
`259`	`257`	`*/`
`260`		`- private function getCommandAliasesText($command)`
	`258`	`+ private function getCommandAliasesText(Command $command)`
`261`	`259`	`{`
`262`	`260`	`$text = '';`
`263`	`261`	`$aliases = $command->getAliases();`
Original file line number	Diff line number	Diff line change
`@@ -53,8 +53,6 @@ class GraphvizDumper extends Dumper`
`53`	`53`	`* * node.definition: The default options for services that are defined via service definition instances`
`54`	`54`	`* * node.missing: The default options for missing services`
`55`	`55`	`*`
`56`		`- * @param array $options An array of options`
`57`		`- *`
`58`	`56`	`* @return string The dot representation of the service container`
`59`	`57`	`*/`
`60`	`58`	`public function dump(array $options = array())`