Merge branch '4.3' into 4.4

* 4.3: cs fix Fix return statements [TwigBridge] add missing dep Add false type to ChoiceListFactoryInterface::createView $label argument Update UPGRADE guide of 4.3 for EventDispatcher [SecurityBundle] display the correct class name on the deprecated notice
symfony · Aug 13, 2019 · 3ec9106 · 3ec9106
2 parents 3bc4e4f + 9b66113
commit 3ec9106
Show file tree

Hide file tree

Showing 59 changed files with 132 additions and 106 deletions.
diff --git a/UPGRADE-4.3.md b/UPGRADE-4.3.md
@@ -54,7 +54,36 @@ Dotenv
 EventDispatcher
 ---------------
 
- * The signature of the `EventDispatcherInterface::dispatch()` method should be updated to `dispatch($event, string $eventName = null)`, not doing so is deprecated
+ * The signature of the `EventDispatcherInterface::dispatch()` method has been updated, consider using the new signature `dispatch($event, string $eventName = null)` instead of the old signature `dispatch($eventName, $event)` that is deprecated
+
+   You have to swap arguments when calling `dispatch()`:
+
+   Before:
+   ```php
+   $this->eventDispatcher->dispatch(Events::My_EVENT, $event);
+   ```
+
+   After:
+   ```php
+   $this->eventDispatcher->dispatch($event, Events::My_EVENT);
+   ```
+
+   If your bundle or package needs to provide compatibility with the previous way of using the dispatcher, you can use `Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy::decorate()` to ease upgrades:
+
+   Before:
+   ```php
+   public function __construct(EventDispatcherInterface $eventDispatcher) {
+       $this->eventDispatcher = $eventDispatcher;
+   }
+   ```
+
+   After:
+   ```php
+   public function __construct(EventDispatcherInterface $eventDispatcher) {
+       $this->eventDispatcher = LegacyEventDispatcherProxy::decorate($eventDispatcher);
+   }
+   ```
+
  * The `Event` class has been deprecated, use `Symfony\Contracts\EventDispatcher\Event` instead
 
 Filesystem

diff --git a/src/Symfony/Bridge/Doctrine/Form/ChoiceList/IdReader.php b/src/Symfony/Bridge/Doctrine/Form/ChoiceList/IdReader.php
@@ -91,7 +91,7 @@ public function isIntId(): bool
     public function getIdValue($object)
     {
         if (!$object) {
-            return;
+            return null;
         }
 
         if (!$this->om->contains($object)) {

diff --git a/src/Symfony/Bridge/Doctrine/Form/DoctrineOrmTypeGuesser.php b/src/Symfony/Bridge/Doctrine/Form/DoctrineOrmTypeGuesser.php
@@ -99,7 +99,7 @@ public function guessRequired($class, $property)
         $classMetadatas = $this->getMetadata($class);
 
         if (!$classMetadatas) {
-            return;
+            return null;
         }
 
         /** @var ClassMetadataInfo $classMetadata */

diff --git a/src/Symfony/Bridge/Twig/AppVariable.php b/src/Symfony/Bridge/Twig/AppVariable.php
@@ -68,7 +68,7 @@ public function getToken()
     /**
      * Returns the current user.
      *
-     * @return mixed
+     * @return object|null
      *
      * @see TokenInterface::getUser()
      */
@@ -79,7 +79,7 @@ public function getUser()
         }
 
         if (!$token = $tokenStorage->getToken()) {
-            return;
+            return null;
         }
 
         $user = $token->getUser();

diff --git a/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerTrait.php b/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerTrait.php
@@ -352,7 +352,7 @@ protected function getDoctrine(): ManagerRegistry
     /**
      * Get a user from the Security Token Storage.
      *
-     * @return mixed
+     * @return object|null
      *
      * @throws \LogicException If SecurityBundle is not available
      *
@@ -367,12 +367,12 @@ protected function getUser()
         }
 
         if (null === $token = $this->container->get('security.token_storage')->getToken()) {
-            return;
+            return null;
         }
 
         if (!\is_object($user = $token->getUser())) {
             // e.g. anonymous authentication
-            return;
+            return null;
         }
 
         return $user;

diff --git a/src/Symfony/Bundle/FrameworkBundle/Templating/GlobalVariables.php b/src/Symfony/Bundle/FrameworkBundle/Templating/GlobalVariables.php
@@ -40,7 +40,7 @@ public function __construct(ContainerInterface $container)
     public function getToken()
     {
         if (!$this->container->has('security.token_storage')) {
-            return;
+            return null;
         }
 
         return $this->container->get('security.token_storage')->getToken();

diff --git a/src/Symfony/Bundle/FrameworkBundle/Templating/Helper/CodeHelper.php b/src/Symfony/Bundle/FrameworkBundle/Templating/Helper/CodeHelper.php
@@ -126,7 +126,7 @@ public function fileExcerpt($file, $line)
 
                 // Check if the file is an application/octet-stream (eg. Phar file) because highlight_file cannot parse these files
                 if ('application/octet-stream' === $finfo->file($file, FILEINFO_MIME_TYPE)) {
-                    return;
+                    return '';
                 }
             }
 

diff --git a/src/Symfony/Bundle/SecurityBundle/Debug/WrappedListener.php b/src/Symfony/Bundle/SecurityBundle/Debug/WrappedListener.php
@@ -50,7 +50,7 @@ public function __invoke(RequestEvent $event)
         if (\is_callable($this->listener)) {
             ($this->listener)($event);
         } else {
-            @trigger_error(sprintf('Calling the "%s::handle()" method from the firewall is deprecated since Symfony 4.3, implement "__invoke()" instead.', \get_class($this)), E_USER_DEPRECATED);
+            @trigger_error(sprintf('Calling the "%s::handle()" method from the firewall is deprecated since Symfony 4.3, implement "__invoke()" instead.', \get_class($this->listener)), E_USER_DEPRECATED);
             $this->listener->handle($event);
         }
         $this->time = microtime(true) - $startTime;

diff --git a/src/Symfony/Component/BrowserKit/Client.php b/src/Symfony/Component/BrowserKit/Client.php
@@ -528,7 +528,7 @@ protected function filterResponse($response)
     protected function createCrawlerFromContent($uri, $content, $type)
     {
         if (!class_exists('Symfony\Component\DomCrawler\Crawler')) {
-            return;
+            return null;
         }
 
         $crawler = new Crawler(null, $uri);

diff --git a/src/Symfony/Component/Config/Util/XmlUtils.php b/src/Symfony/Component/Config/Util/XmlUtils.php
@@ -219,7 +219,7 @@ public static function phpize($value)
 
         switch (true) {
             case 'null' === $lowercaseValue:
-                return;
+                return null;
             case ctype_digit($value):
                 $raw = $value;
                 $cast = (int) $value;

diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -482,7 +482,7 @@ public function add(Command $command)
         if (!$command->isEnabled()) {
             $command->setApplication(null);
 
-            return;
+            return null;
         }
 
         if (null === $command->getDefinition()) {

diff --git a/src/Symfony/Component/CssSelector/Parser/TokenStream.php b/src/Symfony/Component/CssSelector/Parser/TokenStream.php
@@ -155,7 +155,7 @@ public function getNextIdentifierOrStar()
         }
 
         if ($next->isDelimiter(['*'])) {
-            return;
+            return null;
         }
 
         throw SyntaxErrorException::unexpectedToken('identifier or "*"', $next);

diff --git a/src/Symfony/Component/Debug/ErrorHandler.php b/src/Symfony/Component/Debug/ErrorHandler.php
@@ -446,7 +446,7 @@ public function handleError($type, $message, $file, $line)
                 self::$silencedErrorCache[$id][$message] = $errorAsException;
             }
             if (null === $lightTrace) {
-                return;
+                return true;
             }
         } else {
             $errorAsException = new \ErrorException($logMessage, 0, $type, $file, $line);

diff --git a/src/Symfony/Component/Debug/FatalErrorHandler/ClassNotFoundFatalErrorHandler.php b/src/Symfony/Component/Debug/FatalErrorHandler/ClassNotFoundFatalErrorHandler.php
@@ -37,11 +37,11 @@ public function handleError(array $error, FatalErrorException $exception)
         $notFoundSuffix = '\' not found';
         $notFoundSuffixLen = \strlen($notFoundSuffix);
         if ($notFoundSuffixLen > $messageLen) {
-            return;
+            return null;
         }
 
         if (0 !== substr_compare($error['message'], $notFoundSuffix, -$notFoundSuffixLen)) {
-            return;
+            return null;
         }
 
         foreach (['class', 'interface', 'trait'] as $typeName) {

diff --git a/src/Symfony/Component/Debug/FatalErrorHandler/UndefinedFunctionFatalErrorHandler.php b/src/Symfony/Component/Debug/FatalErrorHandler/UndefinedFunctionFatalErrorHandler.php
@@ -34,17 +34,17 @@ public function handleError(array $error, FatalErrorException $exception)
         $notFoundSuffix = '()';
         $notFoundSuffixLen = \strlen($notFoundSuffix);
         if ($notFoundSuffixLen > $messageLen) {
-            return;
+            return null;
         }
 
         if (0 !== substr_compare($error['message'], $notFoundSuffix, -$notFoundSuffixLen)) {
-            return;
+            return null;
         }
 
         $prefix = 'Call to undefined function ';
         $prefixLen = \strlen($prefix);
         if (0 !== strpos($error['message'], $prefix)) {
-            return;
+            return null;
         }
 
         $fullyQualifiedFunctionName = substr($error['message'], $prefixLen, -$notFoundSuffixLen);

diff --git a/src/Symfony/Component/Debug/FatalErrorHandler/UndefinedMethodFatalErrorHandler.php b/src/Symfony/Component/Debug/FatalErrorHandler/UndefinedMethodFatalErrorHandler.php
@@ -32,7 +32,7 @@ public function handleError(array $error, FatalErrorException $exception)
     {
         preg_match('/^Call to undefined method (.*)::(.*)\(\)$/', $error['message'], $matches);
         if (!$matches) {
-            return;
+            return null;
         }
 
         $className = $matches[1];

diff --git a/src/Symfony/Component/DependencyInjection/LazyProxy/ProxyHelper.php b/src/Symfony/Component/DependencyInjection/LazyProxy/ProxyHelper.php
@@ -29,7 +29,7 @@ public static function getTypeHint(\ReflectionFunctionAbstract $r, \ReflectionPa
             $type = $r->getReturnType();
         }
         if (!$type) {
-            return;
+            return null;
         }
         if (!\is_string($type)) {
             $name = $type->getName();
@@ -45,7 +45,7 @@ public static function getTypeHint(\ReflectionFunctionAbstract $r, \ReflectionPa
             return $prefix.$name;
         }
         if (!$r instanceof \ReflectionMethod) {
-            return;
+            return null;
         }
         if ('self' === $lcName) {
             return $prefix.$r->getDeclaringClass()->name;

diff --git a/src/Symfony/Component/Filesystem/Filesystem.php b/src/Symfony/Component/Filesystem/Filesystem.php
@@ -408,12 +408,12 @@ private function linkException(string $origin, string $target, string $linkType)
     public function readlink($path, $canonicalize = false)
     {
         if (!$canonicalize && !is_link($path)) {
-            return;
+            return null;
         }
 
         if ($canonicalize) {
             if (!$this->exists($path)) {
-                return;
+                return null;
             }
 
             if ('\\' === \DIRECTORY_SEPARATOR) {

diff --git a/src/Symfony/Component/Form/ChoiceList/Factory/ChoiceListFactoryInterface.php b/src/Symfony/Component/Form/ChoiceList/Factory/ChoiceListFactoryInterface.php
@@ -78,14 +78,11 @@ public function createListFromLoader(ChoiceLoaderInterface $loader, $value = nul
      * attributes that should be added to the respective choice.
      *
      * @param array|callable|null $preferredChoices The preferred choices
-     * @param callable|null       $label            The callable generating the
-     *                                              choice labels
-     * @param callable|null       $index            The callable generating the
-     *                                              view indices
-     * @param callable|null       $groupBy          The callable generating the
-     *                                              group names
-     * @param array|callable|null $attr             The callable generating the
-     *                                              HTML attributes
+     * @param callable|false|null $label            The callable generating the choice labels;
+     *                                              pass false to discard the label
+     * @param callable|null       $index            The callable generating the view indices
+     * @param callable|null       $groupBy          The callable generating the group names
+     * @param array|callable|null $attr             The callable generating the HTML attributes
      *
      * @return ChoiceListView The choice list view
      */

diff --git a/src/Symfony/Component/Form/Extension/Core/DataTransformer/BooleanToStringTransformer.php b/src/Symfony/Component/Form/Extension/Core/DataTransformer/BooleanToStringTransformer.php
@@ -45,14 +45,14 @@ public function __construct(string $trueValue, array $falseValues = [null])
      *
      * @param bool $value Boolean value
      *
-     * @return string String value
+     * @return string|null String value
      *
      * @throws TransformationFailedException if the given value is not a Boolean
      */
     public function transform($value)
     {
         if (null === $value) {
-            return;
+            return null;
         }
 
         if (!\is_bool($value)) {

diff --git a/src/Symfony/Component/Form/Extension/Core/DataTransformer/DateIntervalToArrayTransformer.php b/src/Symfony/Component/Form/Extension/Core/DataTransformer/DateIntervalToArrayTransformer.php
@@ -106,21 +106,21 @@ public function transform($dateInterval)
      *
      * @param array $value Interval array
      *
-     * @return \DateInterval Normalized date interval
+     * @return \DateInterval|null Normalized date interval
      *
      * @throws UnexpectedTypeException       if the given value is not an array
      * @throws TransformationFailedException if the value could not be transformed
      */
     public function reverseTransform($value)
     {
         if (null === $value) {
-            return;
+            return null;
         }
         if (!\is_array($value)) {
             throw new UnexpectedTypeException($value, 'array');
         }
         if ('' === implode('', $value)) {
-            return;
+            return null;
         }
         $emptyFields = [];
         foreach ($this->fields as $field) {

diff --git a/...Symfony/Component/Form/Extension/Core/DataTransformer/DateIntervalToStringTransformer.php b/...Symfony/Component/Form/Extension/Core/DataTransformer/DateIntervalToStringTransformer.php
@@ -62,21 +62,21 @@ public function transform($value)
      *
      * @param string $value An ISO 8601 or date string like date interval presentation
      *
-     * @return \DateInterval An instance of \DateInterval
+     * @return \DateInterval|null An instance of \DateInterval
      *
      * @throws UnexpectedTypeException       if the given value is not a string
      * @throws TransformationFailedException if the date interval could not be parsed
      */
     public function reverseTransform($value)
     {
         if (null === $value) {
-            return;
+            return null;
         }
         if (!\is_string($value)) {
             throw new UnexpectedTypeException($value, 'string');
         }
         if ('' === $value) {
-            return;
+            return null;
         }
         if (!$this->isISO8601($value)) {
             throw new TransformationFailedException('Non ISO 8601 date strings are not supported yet');

diff --git a/src/Symfony/Component/Form/Extension/Core/DataTransformer/DateTimeToArrayTransformer.php b/src/Symfony/Component/Form/Extension/Core/DataTransformer/DateTimeToArrayTransformer.php
@@ -105,23 +105,23 @@ public function transform($dateTime)
      *
      * @param array $value Localized date
      *
-     * @return \DateTime Normalized date
+     * @return \DateTime|null Normalized date
      *
      * @throws TransformationFailedException If the given value is not an array,
      *                                       if the value could not be transformed
      */
     public function reverseTransform($value)
     {
         if (null === $value) {
-            return;
+            return null;
         }
 
         if (!\is_array($value)) {
             throw new TransformationFailedException('Expected an array.');
         }
 
         if ('' === implode('', $value)) {
-            return;
+            return null;
         }
 
         $emptyFields = [];

diff --git a/...Component/Form/Extension/Core/DataTransformer/DateTimeToHtml5LocalDateTimeTransformer.php b/...Component/Form/Extension/Core/DataTransformer/DateTimeToHtml5LocalDateTimeTransformer.php
@@ -66,7 +66,7 @@ public function transform($dateTime)
      *
      * @param string $dateTimeLocal Formatted string
      *
-     * @return \DateTime Normalized date
+     * @return \DateTime|null Normalized date
      *
      * @throws TransformationFailedException If the given value is not a string,
      *                                       if the value could not be transformed
@@ -78,7 +78,7 @@ public function reverseTransform($dateTimeLocal)
         }
 
         if ('' === $dateTimeLocal) {
-            return;
+            return null;
         }
 
         // to maintain backwards compatibility we do not strictly validate the submitted date

diff --git a/...ny/Component/Form/Extension/Core/DataTransformer/DateTimeToLocalizedStringTransformer.php b/...ny/Component/Form/Extension/Core/DataTransformer/DateTimeToLocalizedStringTransformer.php
@@ -99,7 +99,7 @@ public function transform($dateTime)
      *
      * @param string|array $value Localized date string/array
      *
-     * @return \DateTime Normalized date
+     * @return \DateTime|null Normalized date
      *
      * @throws TransformationFailedException if the given value is not a string,
      *                                       if the date could not be parsed
@@ -111,7 +111,7 @@ public function reverseTransform($value)
         }
 
         if ('' === $value) {
-            return;
+            return null;
         }
 
         // date-only patterns require parsing to be done in UTC, as midnight might not exist in the local timezone due