Merge branch '3.4' into 4.0

fabpot · fabpot · commit e4f62ea0d27d · 2018-07-16T15:59:46.000+02:00
* 3.4:
  [FrameworkBundle] fixed brackets position in method calls
  [Form] Fix PHPDoc for FormConfigBuilder $dataClass argument
  [Security] Update user phpdoc on tokens
  [WebProfilerBundle] Fixed icon alignment issue using Bootstrap 4.1.2
  suppress side effects in 'get' or 'has' methods of NamespacedAttributeBag
  [HttpFoundation] reset callback on StreamedResponse when setNotModified() is called
  [HttpFoundation] Fixed phpdoc for get method of HeaderBag
  fix typo in ContainerBuilder docblock
  [Form/Profiler] Massively reducing memory footprint of form profiling pages by removing redundant 'form' variable from view variables.
  [Console] correctly return parameter's default value on "--"
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -286,8 +286,8 @@ public function testWorkflowMultipleTransitionsWithSameName()
     {
         $container = $this->createContainerFromFile('workflow_with_multiple_transitions_with_same_name');
 
-        $this->assertTrue($container->hasDefinition('workflow.article', 'Workflow is registered as a service'));
-        $this->assertTrue($container->hasDefinition('workflow.article.definition', 'Workflow definition is registered as a service'));
+        $this->assertTrue($container->hasDefinition('workflow.article'), 'Workflow is registered as a service');
+        $this->assertTrue($container->hasDefinition('workflow.article.definition'), 'Workflow definition is registered as a service');
 
         $workflowDefinition = $container->getDefinition('workflow.article.definition');
 
diff --git a/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Profiler/toolbar.css.twig b/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Profiler/toolbar.css.twig
@@ -292,6 +292,7 @@ div.sf-toolbar .sf-toolbar-block a:hover {
     border-width: 0;
     position: relative;
     top: 8px;
+    vertical-align: baseline;
 }
 
 .sf-toolbar-block .sf-toolbar-icon img + span,
diff --git a/src/Symfony/Component/Console/Input/ArgvInput.php b/src/Symfony/Component/Console/Input/ArgvInput.php
@@ -301,7 +301,7 @@ public function getParameterOption($values, $default = false, $onlyParams = fals
         while (0 < count($tokens)) {
             $token = array_shift($tokens);
             if ($onlyParams && '--' === $token) {
-                return false;
+                return $default;
             }
 
             foreach ($values as $value) {
diff --git a/src/Symfony/Component/Console/Input/ArrayInput.php b/src/Symfony/Component/Console/Input/ArrayInput.php
@@ -81,7 +81,7 @@ public function getParameterOption($values, $default = false, $onlyParams = fals
 
         foreach ($this->parameters as $k => $v) {
             if ($onlyParams && ('--' === $k || (is_int($k) && '--' === $v))) {
-                return false;
+                return $default;
             }
 
             if (is_int($k)) {
diff --git a/src/Symfony/Component/Console/Tests/Input/ArgvInputTest.php b/src/Symfony/Component/Console/Tests/Input/ArgvInputTest.php
@@ -395,25 +395,26 @@ public function testToString()
     /**
      * @dataProvider provideGetParameterOptionValues
      */
-    public function testGetParameterOptionEqualSign($argv, $key, $onlyParams, $expected)
+    public function testGetParameterOptionEqualSign($argv, $key, $default, $onlyParams, $expected)
     {
         $input = new ArgvInput($argv);
-        $this->assertEquals($expected, $input->getParameterOption($key, false, $onlyParams), '->getParameterOption() returns the expected value');
+        $this->assertEquals($expected, $input->getParameterOption($key, $default, $onlyParams), '->getParameterOption() returns the expected value');
     }
 
     public function provideGetParameterOptionValues()
     {
         return array(
-            array(array('app/console', 'foo:bar', '-e', 'dev'), '-e', false, 'dev'),
-            array(array('app/console', 'foo:bar', '--env=dev'), '--env', false, 'dev'),
-            array(array('app/console', 'foo:bar', '-e', 'dev'), array('-e', '--env'), false, 'dev'),
-            array(array('app/console', 'foo:bar', '--env=dev'), array('-e', '--env'), false, 'dev'),
-            array(array('app/console', 'foo:bar', '--env=dev', '--en=1'), array('--en'), false, '1'),
-            array(array('app/console', 'foo:bar', '--env=dev', '', '--en=1'), array('--en'), false, '1'),
-            array(array('app/console', 'foo:bar', '--env', 'val'), '--env', false, 'val'),
-            array(array('app/console', 'foo:bar', '--env', 'val', '--dummy'), '--env', false, 'val'),
-            array(array('app/console', 'foo:bar', '--', '--env=dev'), '--env', false, 'dev'),
-            array(array('app/console', 'foo:bar', '--', '--env=dev'), '--env', true, false),
+            array(array('app/console', 'foo:bar'), '-e', 'default', false, 'default'),
+            array(array('app/console', 'foo:bar', '-e', 'dev'), '-e', 'default', false, 'dev'),
+            array(array('app/console', 'foo:bar', '--env=dev'), '--env', 'default', false, 'dev'),
+            array(array('app/console', 'foo:bar', '-e', 'dev'), array('-e', '--env'), 'default', false, 'dev'),
+            array(array('app/console', 'foo:bar', '--env=dev'), array('-e', '--env'), 'default', false, 'dev'),
+            array(array('app/console', 'foo:bar', '--env=dev', '--en=1'), array('--en'), 'default', false, '1'),
+            array(array('app/console', 'foo:bar', '--env=dev', '', '--en=1'), array('--en'), 'default', false, '1'),
+            array(array('app/console', 'foo:bar', '--env', 'val'), '--env', 'default', false, 'val'),
+            array(array('app/console', 'foo:bar', '--env', 'val', '--dummy'), '--env', 'default', false, 'val'),
+            array(array('app/console', 'foo:bar', '--', '--env=dev'), '--env', 'default', false, 'dev'),
+            array(array('app/console', 'foo:bar', '--', '--env=dev'), '--env', 'default', true, 'default'),
         );
     }
 
diff --git a/src/Symfony/Component/Console/Tests/Input/ArrayInputTest.php b/src/Symfony/Component/Console/Tests/Input/ArrayInputTest.php
@@ -47,14 +47,14 @@ public function testGetParameterOption()
     {
         $input = new ArrayInput(array('name' => 'Fabien', '--foo' => 'bar'));
         $this->assertEquals('bar', $input->getParameterOption('--foo'), '->getParameterOption() returns the option of specified name');
-        $this->assertFalse($input->getParameterOption('--bar'), '->getParameterOption() returns the default if an option is not present in the passed parameters');
+        $this->assertEquals('default', $input->getParameterOption('--bar', 'default'), '->getParameterOption() returns the default value if an option is not present in the passed parameters');
 
         $input = new ArrayInput(array('Fabien', '--foo' => 'bar'));
         $this->assertEquals('bar', $input->getParameterOption('--foo'), '->getParameterOption() returns the option of specified name');
 
         $input = new ArrayInput(array('--foo', '--', '--bar' => 'woop'));
         $this->assertEquals('woop', $input->getParameterOption('--bar'), '->getParameterOption() returns the correct value if an option is present in the passed parameters');
-        $this->assertFalse($input->getParameterOption('--bar', false, true), '->getParameterOption() returns false if an option is present in the passed parameters after an end of options signal');
+        $this->assertEquals('default', $input->getParameterOption('--bar', 'default', true), '->getParameterOption() returns the default value if an option is present in the passed parameters after an end of options signal');
     }
 
     public function testParseArguments()
diff --git a/src/Symfony/Component/DependencyInjection/ContainerBuilder.php b/src/Symfony/Component/DependencyInjection/ContainerBuilder.php
@@ -602,10 +602,10 @@ private function doGet($id, $invalidBehavior = ContainerInterface::EXCEPTION_ON_
      * the parameters passed to the container constructor to have precedence
      * over the loaded ones.
      *
-     * $container = new ContainerBuilder(array('foo' => 'bar'));
+     * $container = new ContainerBuilder(new ParameterBag(array('foo' => 'bar')));
      * $loader = new LoaderXXX($container);
      * $loader->load('resource_name');
-     * $container->register('foo', new stdClass());
+     * $container->register('foo', 'stdClass');
      *
      * In the above example, even if the loaded resource defines a foo
      * parameter, the value will still be 'bar' as defined in the ContainerBuilder
diff --git a/src/Symfony/Component/Form/Extension/DataCollector/FormDataExtractor.php b/src/Symfony/Component/Form/Extension/DataCollector/FormDataExtractor.php
@@ -14,6 +14,7 @@
 use Symfony\Component\Form\FormInterface;
 use Symfony\Component\Form\FormView;
 use Symfony\Component\Validator\ConstraintViolationInterface;
+use Symfony\Component\VarDumper\Caster\CutStub;
 
 /**
  * Default implementation of {@link FormDataExtractorInterface}.
@@ -144,6 +145,10 @@ public function extractViewVariables(FormView $view)
         );
 
         foreach ($view->vars as $varName => $value) {
+            // Removing redundant variable from view variables
+            if ('form' === $varName) {
+                $value = new CutStub($value);
+            }
             $data['view_vars'][$varName] = $value;
         }
 
diff --git a/src/Symfony/Component/Form/FormConfigBuilder.php b/src/Symfony/Component/Form/FormConfigBuilder.php
@@ -138,7 +138,7 @@ class FormConfigBuilder implements FormConfigBuilderInterface
     private $data;
 
     /**
-     * @var string
+     * @var string|null
      */
     private $dataClass;
 
@@ -181,7 +181,7 @@ class FormConfigBuilder implements FormConfigBuilderInterface
      * Creates an empty form configuration.
      *
      * @param string|int               $name       The form name
-     * @param string                   $dataClass  The class of the form's data
+     * @param string|null              $dataClass  The class of the form's data
      * @param EventDispatcherInterface $dispatcher The event dispatcher
      * @param array                    $options    The form options
      *
diff --git a/src/Symfony/Component/HttpFoundation/HeaderBag.php b/src/Symfony/Component/HttpFoundation/HeaderBag.php
@@ -101,11 +101,11 @@ public function add(array $headers)
     /**
      * Returns a header value by name.
      *
-     * @param string          $key     The header name
-     * @param string|string[] $default The default value
-     * @param bool            $first   Whether to return the first value or all header values
+     * @param string               $key     The header name
+     * @param string|string[]|null $default The default value
+     * @param bool                 $first   Whether to return the first value or all header values
      *
-     * @return string|string[] The first header value or default value if $first is true, an array of values otherwise
+     * @return string|string[]|null The first header value or default value if $first is true, an array of values otherwise
      */
     public function get($key, $default = null, $first = true)
     {
diff --git a/src/Symfony/Component/HttpFoundation/Session/Attribute/NamespacedAttributeBag.php b/src/Symfony/Component/HttpFoundation/Session/Attribute/NamespacedAttributeBag.php
@@ -124,7 +124,13 @@ protected function &resolveAttributePath($name, $writeContext = false)
 
         foreach ($parts as $part) {
             if (null !== $array && !array_key_exists($part, $array)) {
-                $array[$part] = $writeContext ? array() : null;
+                if (!$writeContext) {
+                    $null = null;
+
+                    return $null;
+                }
+
+                $array[$part] = array();
             }
 
             $array = &$array[$part];
diff --git a/src/Symfony/Component/HttpFoundation/StreamedResponse.php b/src/Symfony/Component/HttpFoundation/StreamedResponse.php
@@ -141,4 +141,16 @@ public function getContent()
     {
         return false;
     }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @return $this
+     */
+    public function setNotModified()
+    {
+        $this->setCallback(function () {});
+
+        return parent::setNotModified();
+    }
 }
diff --git a/src/Symfony/Component/HttpFoundation/Tests/ResponseTest.php b/src/Symfony/Component/HttpFoundation/Tests/ResponseTest.php
@@ -126,7 +126,7 @@ public function testMustRevalidateWithProxyRevalidateCacheControlHeader()
 
     public function testSetNotModified()
     {
-        $response = new Response();
+        $response = new Response('foo');
         $modified = $response->setNotModified();
         $this->assertObjectHasAttribute('headers', $modified);
         $this->assertObjectHasAttribute('content', $modified);
@@ -135,6 +135,11 @@ public function testSetNotModified()
         $this->assertObjectHasAttribute('statusText', $modified);
         $this->assertObjectHasAttribute('charset', $modified);
         $this->assertEquals(304, $modified->getStatusCode());
+
+        ob_start();
+        $modified->sendContent();
+        $string = ob_get_clean();
+        $this->assertEmpty($string);
     }
 
     public function testIsSuccessful()
diff --git a/src/Symfony/Component/HttpFoundation/Tests/Session/Attribute/NamespacedAttributeBagTest.php b/src/Symfony/Component/HttpFoundation/Tests/Session/Attribute/NamespacedAttributeBagTest.php
@@ -82,6 +82,17 @@ public function testHas($key, $value, $exists)
         $this->assertEquals($exists, $this->bag->has($key));
     }
 
+    /**
+     * @dataProvider attributesProvider
+     */
+    public function testHasNoSideEffect($key, $value, $expected)
+    {
+        $expected = json_encode($this->bag->all());
+        $this->bag->has($key);
+
+        $this->assertEquals($expected, json_encode($this->bag->all()));
+    }
+
     /**
      * @dataProvider attributesProvider
      */
@@ -96,6 +107,17 @@ public function testGetDefaults()
         $this->assertEquals('default', $this->bag->get('user2.login', 'default'));
     }
 
+    /**
+     * @dataProvider attributesProvider
+     */
+    public function testGetNoSideEffect($key, $value, $expected)
+    {
+        $expected = json_encode($this->bag->all());
+        $this->bag->get($key);
+
+        $this->assertEquals($expected, json_encode($this->bag->all()));
+    }
+
     /**
      * @dataProvider attributesProvider
      */
diff --git a/src/Symfony/Component/HttpFoundation/Tests/StreamedResponseTest.php b/src/Symfony/Component/HttpFoundation/Tests/StreamedResponseTest.php
@@ -123,4 +123,22 @@ public function testReturnThis()
         $this->assertInstanceOf('Symfony\Component\HttpFoundation\StreamedResponse', $response->sendHeaders());
         $this->assertInstanceOf('Symfony\Component\HttpFoundation\StreamedResponse', $response->sendHeaders());
     }
+
+    public function testSetNotModified()
+    {
+        $response = new StreamedResponse(function () { echo 'foo'; });
+        $modified = $response->setNotModified();
+        $this->assertObjectHasAttribute('headers', $modified);
+        $this->assertObjectHasAttribute('content', $modified);
+        $this->assertObjectHasAttribute('version', $modified);
+        $this->assertObjectHasAttribute('statusCode', $modified);
+        $this->assertObjectHasAttribute('statusText', $modified);
+        $this->assertObjectHasAttribute('charset', $modified);
+        $this->assertEquals(304, $modified->getStatusCode());
+
+        ob_start();
+        $modified->sendContent();
+        $string = ob_get_clean();
+        $this->assertEmpty($string);
+    }
 }
diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/AbstractToken.php b/src/Symfony/Component/Security/Core/Authentication/Token/AbstractToken.php
@@ -76,14 +76,7 @@ public function getUser()
     }
 
     /**
-     * Sets the user in the token.
-     *
-     * The user can be a UserInterface instance, or an object implementing
-     * a __toString method or the username as a regular string.
-     *
-     * @param string|object $user The user
-     *
-     * @throws \InvalidArgumentException
+     * {@inheritdoc}
      */
     public function setUser($user)
     {
diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/TokenInterface.php b/src/Symfony/Component/Security/Core/Authentication/Token/TokenInterface.php
@@ -47,17 +47,22 @@ public function getCredentials();
     /**
      * Returns a user representation.
      *
-     * @return mixed Can be a UserInterface instance, an object implementing a __toString method,
-     *               or the username as a regular string
+     * @return string|object Can be a UserInterface instance, an object implementing a __toString method,
+     *                       or the username as a regular string
      *
      * @see AbstractToken::setUser()
      */
     public function getUser();
 
     /**
-     * Sets a user.
+     * Sets the user in the token.
      *
-     * @param mixed $user
+     * The user can be a UserInterface instance, or an object implementing
+     * a __toString method or the username as a regular string.
+     *
+     * @param string|object $user The user
+     *
+     * @throws \InvalidArgumentException
      */
     public function setUser($user);
 

Original file line number	Diff line number	Diff line change
`@@ -286,8 +286,8 @@ public function testWorkflowMultipleTransitionsWithSameName()`
`286`	`286`	`{`
`287`	`287`	`$container = $this->createContainerFromFile('workflow_with_multiple_transitions_with_same_name');`
`288`	`288`
`289`		`- $this->assertTrue($container->hasDefinition('workflow.article', 'Workflow is registered as a service'));`
`290`		`- $this->assertTrue($container->hasDefinition('workflow.article.definition', 'Workflow definition is registered as a service'));`
	`289`	`+ $this->assertTrue($container->hasDefinition('workflow.article'), 'Workflow is registered as a service');`
	`290`	`+ $this->assertTrue($container->hasDefinition('workflow.article.definition'), 'Workflow definition is registered as a service');`
`291`	`291`
`292`	`292`	`$workflowDefinition = $container->getDefinition('workflow.article.definition');`
`293`	`293`
Original file line number	Diff line number	Diff line change
`@@ -292,6 +292,7 @@ div.sf-toolbar .sf-toolbar-block a:hover {`
`292`	`292`	`border-width: 0;`
`293`	`293`	`position: relative;`
`294`	`294`	`top: 8px;`
	`295`	`+ vertical-align: baseline;`
`295`	`296`	`}`
`296`	`297`
`297`	`298`	`.sf-toolbar-block .sf-toolbar-icon img + span,`
Original file line number	Diff line number	Diff line change
`@@ -301,7 +301,7 @@ public function getParameterOption($values, $default = false, $onlyParams = fals`
`301`	`301`	`while (0 < count($tokens)) {`
`302`	`302`	`$token = array_shift($tokens);`
`303`	`303`	`if ($onlyParams && '--' === $token) {`
`304`		`- return false;`
	`304`	`+ return $default;`
`305`	`305`	`}`
`306`	`306`
`307`	`307`	`foreach ($values as $value) {`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ public function getParameterOption($values, $default = false, $onlyParams = fals`
`81`	`81`
`82`	`82`	`foreach ($this->parameters as $k => $v) {`
`83`	`83`	`if ($onlyParams && ('--' === $k \|\| (is_int($k) && '--' === $v))) {`
`84`		`- return false;`
	`84`	`+ return $default;`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`if (is_int($k)) {`
Original file line number	Diff line number	Diff line change
`@@ -47,14 +47,14 @@ public function testGetParameterOption()`
`47`	`47`	`{`
`48`	`48`	`$input = new ArrayInput(array('name' => 'Fabien', '--foo' => 'bar'));`
`49`	`49`	`$this->assertEquals('bar', $input->getParameterOption('--foo'), '->getParameterOption() returns the option of specified name');`
`50`		`- $this->assertFalse($input->getParameterOption('--bar'), '->getParameterOption() returns the default if an option is not present in the passed parameters');`
	`50`	`+ $this->assertEquals('default', $input->getParameterOption('--bar', 'default'), '->getParameterOption() returns the default value if an option is not present in the passed parameters');`
`51`	`51`
`52`	`52`	`$input = new ArrayInput(array('Fabien', '--foo' => 'bar'));`
`53`	`53`	`$this->assertEquals('bar', $input->getParameterOption('--foo'), '->getParameterOption() returns the option of specified name');`
`54`	`54`
`55`	`55`	`$input = new ArrayInput(array('--foo', '--', '--bar' => 'woop'));`
`56`	`56`	`$this->assertEquals('woop', $input->getParameterOption('--bar'), '->getParameterOption() returns the correct value if an option is present in the passed parameters');`
`57`		`- $this->assertFalse($input->getParameterOption('--bar', false, true), '->getParameterOption() returns false if an option is present in the passed parameters after an end of options signal');`
	`57`	`+ $this->assertEquals('default', $input->getParameterOption('--bar', 'default', true), '->getParameterOption() returns the default value if an option is present in the passed parameters after an end of options signal');`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`public function testParseArguments()`
Original file line number	Diff line number	Diff line change
`@@ -602,10 +602,10 @@ private function doGet($id, $invalidBehavior = ContainerInterface::EXCEPTION_ON_`
`602`	`602`	`* the parameters passed to the container constructor to have precedence`
`603`	`603`	`* over the loaded ones.`
`604`	`604`	`*`
`605`		`- * $container = new ContainerBuilder(array('foo' => 'bar'));`
	`605`	`+ * $container = new ContainerBuilder(new ParameterBag(array('foo' => 'bar')));`
`606`	`606`	`* $loader = new LoaderXXX($container);`
`607`	`607`	`* $loader->load('resource_name');`
`608`		`- * $container->register('foo', new stdClass());`
	`608`	`+ * $container->register('foo', 'stdClass');`
`609`	`609`	`*`
`610`	`610`	`* In the above example, even if the loaded resource defines a foo`
`611`	`611`	`* parameter, the value will still be 'bar' as defined in the ContainerBuilder`
Original file line number	Diff line number	Diff line change
`@@ -101,11 +101,11 @@ public function add(array $headers)`
`101`	`101`	`/**`
`102`	`102`	`* Returns a header value by name.`
`103`	`103`	`*`
`104`		`- * @param string $key The header name`
`105`		`- * @param string\|string[] $default The default value`
`106`		`- * @param bool $first Whether to return the first value or all header values`
	`104`	`+ * @param string $key The header name`
	`105`	`+ * @param string\|string[]\|null $default The default value`
	`106`	`+ * @param bool $first Whether to return the first value or all header values`
`107`	`107`	`*`
`108`		`- * @return string\|string[] The first header value or default value if $first is true, an array of values otherwise`
	`108`	`+ * @return string\|string[]\|null The first header value or default value if $first is true, an array of values otherwise`
`109`	`109`	`*/`
`110`	`110`	`public function get($key, $default = null, $first = true)`
`111`	`111`	`{`