Merge 4.x into 5.x

composer.json

@@ -65,7 +65,6 @@
     },
     "conflict": {
         "aws/aws-sdk-php": "<3.0",
-        "doctrine/dbal": "<2.11",
         "doctrine/mongodb-odm": "<2.2",
         "doctrine/orm": "<2.9",
         "knplabs/knp-menu-bundle": "<3.0",
@@ -77,7 +76,6 @@
     },
     "require-dev": {
         "aws/aws-sdk-php": "^3.0",
-        "doctrine/dbal": "^2.11",
         "doctrine/mongodb-odm": "^2.2",
         "doctrine/orm": "^2.9",
         "jackalope/jackalope-doctrine-dbal": "^1.1",
@@ -86,10 +84,10 @@
         "matthiasnoback/symfony-config-test": "^4.2",
         "matthiasnoback/symfony-dependency-injection-test": "^4.0",
         "phpstan/extension-installer": "^1.0",
-        "phpstan/phpstan": "^0.12.84",
-        "phpstan/phpstan-phpunit": "^0.12.16",
-        "phpstan/phpstan-strict-rules": "^0.12.10",
-        "phpstan/phpstan-symfony": "^0.12.21",
+        "phpstan/phpstan": "^1.0",
+        "phpstan/phpstan-phpunit": "^1.0",
+        "phpstan/phpstan-strict-rules": "^1.0",
+        "phpstan/phpstan-symfony": "^1.0",
         "phpunit/phpunit": "^9.5",
         "psalm/plugin-phpunit": "^0.16",
         "psalm/plugin-symfony": "^3.0",

phpstan.neon.dist

@@ -2,14 +2,16 @@ includes:
     - phpstan-baseline.neon
 
 parameters:
-    level: max
+    level: 8
     symfony:
         console_application_loader: ./phpstan-console-application.php
     paths:
         - src
         - tests
     treatPhpDocTypesAsCertain: false
     checkGenericClassInNonGenericObjectType: true
+    checkInternalClassCaseSensitivity: true
     checkMissingIterableValueType: true
     checkMissingVarTagTypehint: true
     checkMissingTypehints: true
+    checkUninitializedProperties: true

src/DependencyInjection/Compiler/AddProviderCompilerPass.php

@@ -70,7 +70,7 @@ private function attachArguments(ContainerBuilder $container, array $config): vo
                         ->replaceArgument(3, new Reference($provider['generator']))
                         ->replaceArgument(4, new Reference($provider['thumbnail']));
 
-                    if ($provider['resizer']) {
+                    if (null !== $provider['resizer']) {
                         $definition->addMethodCall('setResizer', [new Reference($provider['resizer'])]);
                     }
                 }

src/DependencyInjection/Configuration.php

@@ -284,7 +284,7 @@ private function addProvidersSection(ArrayNodeDefinition $node): void
                             ->addDefaultsIfNotSet()
                             ->children()
                                 ->scalarNode('service')->defaultValue('sonata.media.provider.file')->end()
-                                ->scalarNode('resizer')->defaultValue(false)->end()
+                                ->scalarNode('resizer')->defaultNull()->end()
                                 ->scalarNode('filesystem')->defaultValue('sonata.media.filesystem.local')->end()
                                 ->scalarNode('cdn')->defaultValue('sonata.media.cdn.server')->end()
                                 ->scalarNode('generator')->defaultValue('sonata.media.generator.default')->end()

src/Document/BaseGallery.php

@@ -13,16 +13,10 @@
 
 namespace Sonata\MediaBundle\Document;
 
-use Doctrine\Common\Collections\ArrayCollection;
 use Sonata\MediaBundle\Model\Gallery;
 
 abstract class BaseGallery extends Gallery
 {
-    public function __construct()
-    {
-        $this->galleryItems = new ArrayCollection();
-    }
-
     public function prePersist(): void
     {
         $this->createdAt = new \DateTime();

src/Document/BaseMedia.php

@@ -13,16 +13,10 @@
 
 namespace Sonata\MediaBundle\Document;
 
-use Doctrine\Common\Collections\ArrayCollection;
 use Sonata\MediaBundle\Model\Media;
 
 abstract class BaseMedia extends Media
 {
-    public function __construct()
-    {
-        $this->galleryItems = new ArrayCollection();
-    }
-
     public function prePersist(): void
     {
         $this->createdAt = new \DateTime();

src/Entity/BaseGallery.php

@@ -13,16 +13,10 @@
 
 namespace Sonata\MediaBundle\Entity;
 
-use Doctrine\Common\Collections\ArrayCollection;
 use Sonata\MediaBundle\Model\Gallery;
 
 abstract class BaseGallery extends Gallery
 {
-    public function __construct()
-    {
-        $this->galleryItems = new ArrayCollection();
-    }
-
     public function prePersist(): void
     {
         $this->createdAt = new \DateTime();

src/Entity/BaseMedia.php

@@ -13,16 +13,10 @@
 
 namespace Sonata\MediaBundle\Entity;
 
-use Doctrine\Common\Collections\ArrayCollection;
 use Sonata\MediaBundle\Model\Media;
 
 abstract class BaseMedia extends Media
 {
-    public function __construct()
-    {
-        $this->galleryItems = new ArrayCollection();
-    }
-
     public function prePersist(): void
     {
         $this->createdAt = new \DateTime();

src/Form/DataTransformer/ProviderDataTransformer.php

@@ -20,6 +20,9 @@
 use Sonata\MediaBundle\Provider\Pool;
 use Symfony\Component\Form\DataTransformerInterface;
 
+/**
+ * @implements DataTransformerInterface<MediaInterface, MediaInterface>
+ */
 final class ProviderDataTransformer implements DataTransformerInterface, LoggerAwareInterface
 {
     use LoggerAwareTrait;
@@ -52,25 +55,35 @@ public function __construct(Pool $pool, string $class, array $options = [])
      * @param mixed $value
      *
      * @return mixed
+     *
+     * @phpstan-param MediaInterface|null $value
+     * @phpstan-return MediaInterface|null
      */
     public function transform($value)
     {
         if (null === $value) {
             return new $this->class();
         }
 
+        if (!$value instanceof MediaInterface) {
+            return null;
+        }
+
         return $value;
     }
 
     /**
      * @param mixed $value
      *
      * @return mixed
+     *
+     * @phpstan-param MediaInterface|null $value
+     * @phpstan-return MediaInterface|null
      */
     public function reverseTransform($value)
     {
         if (!$value instanceof MediaInterface) {
-            return $value;
+            return null;
         }
 
         $binaryContent = $value->getBinaryContent();
@@ -79,7 +92,7 @@ public function reverseTransform($value)
         if (null === $binaryContent) {
             // and no media id
             if (null === $value->getId() && true === $this->options['empty_on_new']) {
-                return;
+                return null;
             }
             if (null !== $value->getId()) {
                 return $value;

src/Model/Gallery.php

@@ -36,6 +36,11 @@ abstract class Gallery implements GalleryInterface
      */
     protected Collection $galleryItems;
 
+    public function __construct()
+    {
+        $this->galleryItems = new ArrayCollection();
+    }
+
     public function __toString(): string
     {
         return $this->getName() ?? '-';

src/Model/Media.php

@@ -13,6 +13,7 @@
 
 namespace Sonata\MediaBundle\Model;
 
+use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Imagine\Image\Box;
 use Sonata\ClassificationBundle\Model\CategoryInterface;
@@ -81,6 +82,11 @@ abstract class Media implements MediaInterface
      */
     protected ?object $category = null;
 
+    public function __construct()
+    {
+        $this->galleryItems = new ArrayCollection();
+    }
+
     public function __toString(): string
     {
         return $this->getName() ?? 'n/a';

src/Model/NoDriverGalleryManager.php

@@ -13,7 +13,6 @@
 
 namespace Sonata\MediaBundle\Model;
 
-use Doctrine\DBAL\Connection;
 use Sonata\MediaBundle\Exception\NoDriverException;
 
 /**
@@ -68,7 +67,13 @@ public function getTableName(): string
         throw new NoDriverException();
     }
 
-    public function getConnection(): Connection
+    /**
+     * Do not add return typehint to this method, it forces a dependency with
+     * Doctrine DBAL that we do not want here. This method will probably be
+     * deprecated on sonata-project/doctrine-extensions because it is only for
+     * Doctrine ORM.
+     */
+    public function getConnection()
     {
         throw new NoDriverException();
     }

src/Model/NoDriverMediaManager.php

@@ -13,7 +13,6 @@
 
 namespace Sonata\MediaBundle\Model;
 
-use Doctrine\DBAL\Connection;
 use Sonata\MediaBundle\Exception\NoDriverException;
 
 /**
@@ -68,7 +67,13 @@ public function getTableName(): string
         throw new NoDriverException();
     }
 
-    public function getConnection(): Connection
+    /**
+     * Do not add return typehint to this method, it forces a dependency with
+     * Doctrine DBAL that we do not want here. This method will probably be
+     * deprecated on sonata-project/doctrine-extensions because it is only for
+     * Doctrine ORM.
+     */
+    public function getConnection()
     {
         throw new NoDriverException();
     }

src/Provider/FileProvider.php

@@ -260,19 +260,21 @@ public function getDownloadResponse(MediaInterface $media, string $format, strin
 
     public function validate(ErrorElement $errorElement, MediaInterface $media): void
     {
-        if (!$media->getBinaryContent() instanceof \SplFileInfo) {
+        $binaryContent = $media->getBinaryContent();
+
+        if (!$binaryContent instanceof \SplFileInfo) {
             return;
         }
 
-        if ($media->getBinaryContent() instanceof UploadedFile) {
-            $fileName = $media->getBinaryContent()->getClientOriginalName();
-        } elseif ($media->getBinaryContent() instanceof File) {
-            $fileName = $media->getBinaryContent()->getFilename();
+        if ($binaryContent instanceof UploadedFile) {
+            $fileName = $binaryContent->getClientOriginalName();
+        } elseif ($binaryContent instanceof File) {
+            $fileName = $binaryContent->getFilename();
         } else {
-            throw new \RuntimeException(sprintf('Invalid binary content type: %s', \get_class($media->getBinaryContent())));
+            throw new \RuntimeException(sprintf('Invalid binary content type: %s', \get_class($binaryContent)));
         }
 
-        if ($media->getBinaryContent() instanceof UploadedFile && 0 === ($media->getBinaryContent()->getSize() ?? 0)) {
+        if ($binaryContent instanceof UploadedFile && 0 === $binaryContent->getSize()) {
             $errorElement
                 ->with('binaryContent')
                     ->addViolation(

src/Provider/ImageProvider.php

@@ -61,7 +61,7 @@ public function getHelperProperties(MediaInterface $media, string $format, array
             }
 
             if (null === $this->resizer) {
-                throw new \RuntimeException('Resizer not set on the imageg provider.');
+                throw new \RuntimeException('Resizer not set on the image provider.');
             }
 
             $box = $this->resizer->getBox($media, $resizerFormat);
@@ -143,7 +143,7 @@ public function getHelperProperties(MediaInterface $media, string $format, array
                     // Check if format belongs to the current media's context
                     if (null !== $context && 0 === strpos($providerFormat, $context)) {
                         if (null === $this->resizer) {
-                            throw new \RuntimeException('Resizer not set on the imageg provider.');
+                            throw new \RuntimeException('Resizer not set on the image provider.');
                         }
 
                         $width = $this->resizer->getBox($media, $settings)->getWidth();

tests/App/Entity/Context.php

@@ -23,15 +23,13 @@
 class Context extends BaseContext
 {
     /**
-     * @var string|null
-     *
      * @ORM\Id
      * @ORM\GeneratedValue
      * @ORM\Column(type="string")
      */
-    protected $id;
+    protected ?string $id = null;
 
-    public function getId()
+    public function getId(): ?string
     {
         return $this->id;
     }

tests/DependencyInjection/Compiler/ThumbnailCompilerPassTest.php

@@ -53,8 +53,14 @@ public function processProvider(): iterable
     }
 }
 
+/**
+ * Here we create a class with an addResizer method that is not callable on purpose,
+ * we want to test that we will not call it if it can't be called. Please do not remove
+ * this method even if some tools report it as unused, it is intended.
+ */
 final class TestUncallableAddResizerMethod
 {
+    // @phpstan-ignore-next-line
     private function addResizer(): void
     {
     }

tests/Form/DataTransformer/ProviderDataTransformerTest.php

@@ -28,7 +28,7 @@ public function testReverseTransformFakeValue(): void
         $pool = new Pool('default');
 
         $transformer = new ProviderDataTransformer($pool, MediaInterface::class);
-        static::assertSame('foo', $transformer->reverseTransform('foo'));
+        static::assertNull($transformer->reverseTransform(null));
     }
 
     public function testReverseTransformUnknownProvider(): void

tests/Form/Type/AbstractTypeTest.php

@@ -14,7 +14,6 @@
 namespace Sonata\MediaBundle\Tests\Form\Type;
 
 use Sonata\MediaBundle\Provider\Pool;
-use Symfony\Component\Form\FormBuilder;
 use Symfony\Component\Form\FormTypeInterface;
 use Symfony\Component\Form\Test\TypeTestCase;
 
@@ -23,14 +22,14 @@
  */
 abstract class AbstractTypeTest extends TypeTestCase
 {
-    protected FormBuilder $formBuilder;
-
     protected FormTypeInterface $formType;
 
     protected Pool $mediaPool;
 
     protected function setUp(): void
     {
+        parent::setUp();
+
         $this->mediaPool = new Pool('default');
         $this->formType = $this->getTestedInstance();
     }