Fix phpcr migrations for Symfony 7 without ContainerAwareInterface (#700

) --------- Co-authored-by: Christian Frantzen <christian.frantzen@dogado.de>
sulu · Aug 27, 2024 · 4def6b6 · 4def6b6
1 parent 7b40fb2
commit 4def6b6
Show file tree

Hide file tree

Showing 15 changed files with 189 additions and 52 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of Sulu.
+ *
+ * (c) Sulu GmbH
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
 $header = <<<EOF
 This file is part of Sulu.
 
@@ -10,8 +19,10 @@
 EOF;
 
 $finder = PhpCsFixer\Finder::create()
-    ->exclude(['Tests/Application/var/cache'])
-    ->in(__DIR__);
+    ->in(__DIR__)
+    ->ignoreDotFiles(false)
+    ->exclude(['Tests/Application/var'])
+;
 
 $config = new PhpCsFixer\Config();
 $config->setRiskyAllowed(true)

diff --git a/Content/ArticleDataItem.php b/Content/ArticleDataItem.php
@@ -66,6 +66,6 @@ public function getResource()
 
     public function getImage()
     {
-        return;
+        return null;
     }
 }
diff --git a/Content/ArticleDataProvider.php b/Content/ArticleDataProvider.php
@@ -225,7 +225,7 @@ public function resolveResourceItems(
 
     public function resolveDatasource($datasource, array $propertyParameter, array $options)
     {
-        return;
+        return null;
     }
 
     private function getWebspaceKey(array $propertyParameter, array $options): ?string

diff --git a/Resources/phpcr-migrations/ContainerAwareInterface.php b/Resources/phpcr-migrations/ContainerAwareInterface.php
@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of Sulu.
+ *
+ * (c) Sulu GmbH
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Sulu\Bundle\ArticleBundle;
+
+use PHPCR\PhpcrMigrationsBundle\ContainerAwareInterface as PhpcrContainerAwareInterface;
+use Symfony\Component\DependencyInjection\ContainerAwareInterface as SymfonyContainerAwareInterface;
+
+if (\interface_exists(PhpcrContainerAwareInterface::class)) {
+    /**
+     * @internal
+     */
+    interface ContainerAwareInterface extends PhpcrContainerAwareInterface
+    {
+    }
+} elseif (\interface_exists(SymfonyContainerAwareInterface::class)) {
+    /**
+     * @internal
+     */
+    interface ContainerAwareInterface extends SymfonyContainerAwareInterface
+    {
+    }
+} else {
+    /**
+     * @internal
+     */
+    interface ContainerAwareInterface
+    {
+    }
+}
diff --git a/Resources/phpcr-migrations/Version201702211450.php b/Resources/phpcr-migrations/Version201702211450.php
@@ -16,15 +16,26 @@
 use PHPCR\Migrations\VersionInterface;
 use PHPCR\SessionInterface;
 use Sulu\Component\Localization\Localization;
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Removes the property `i18n:<locale>-authors` and adds `i18n:<locale>-author`.
  */
 class Version201702211450 implements VersionInterface, ContainerAwareInterface
 {
-    use ContainerAwareTrait;
+    /**
+     * @var ContainerInterface
+     */
+    private $container;
+
+    public function setContainer(?ContainerInterface $container = null): void
+    {
+        if (null === $container) {
+            throw new \RuntimeException('Container is required to run this migration.');
+        }
+
+        $this->container = $container;
+    }
 
     public function up(SessionInterface $session)
     {

diff --git a/Resources/phpcr-migrations/Version201712041018.php b/Resources/phpcr-migrations/Version201712041018.php
@@ -17,15 +17,26 @@
 use PHPCR\NodeInterface;
 use PHPCR\SessionInterface;
 use Sulu\Component\Localization\Localization;
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Removes the property `sulu:author(ed)` and adds `i18n:<locale>-author(ed)`.
  */
 class Version201712041018 implements VersionInterface, ContainerAwareInterface
 {
-    use ContainerAwareTrait;
+    /**
+     * @var ContainerInterface
+     */
+    private $container;
+
+    public function setContainer(?ContainerInterface $container = null): void
+    {
+        if (null === $container) {
+            throw new \RuntimeException('Container is required to run this migration.');
+        }
+
+        $this->container = $container;
+    }
 
     public const AUTHOR_PROPERTY_NAME = 'sulu:author';
 

diff --git a/Resources/phpcr-migrations/Version201811091000.php b/Resources/phpcr-migrations/Version201811091000.php
@@ -17,16 +17,27 @@
 use PHPCR\NodeInterface;
 use PHPCR\SessionInterface;
 use Sulu\Component\Localization\Localization;
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Removes the property `mainWebspace` and adds `i18n:<locale>-mainWebspace`.
  * Removes the property `additionalWebspaces` and adds `i18n:<locale>-additionalWebspaces`.
  */
 class Version201811091000 implements VersionInterface, ContainerAwareInterface
 {
-    use ContainerAwareTrait;
+    /**
+     * @var ContainerInterface
+     */
+    private $container;
+
+    public function setContainer(?ContainerInterface $container = null): void
+    {
+        if (null === $container) {
+            throw new \RuntimeException('Container is required to run this migration.');
+        }
+
+        $this->container = $container;
+    }
 
     public const MAIN_WEBSPACE_PROPERTY_NAME = 'mainWebspace';
 

diff --git a/Resources/phpcr-migrations/Version201905071542.php b/Resources/phpcr-migrations/Version201905071542.php
@@ -13,12 +13,23 @@
 
 use PHPCR\Migrations\VersionInterface;
 use PHPCR\SessionInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
 class Version201905071542 implements VersionInterface, ContainerAwareInterface
 {
-    use ContainerAwareTrait;
+    /**
+     * @var ContainerInterface
+     */
+    private $container;
+
+    public function setContainer(?ContainerInterface $container = null): void
+    {
+        if (null === $container) {
+            throw new \RuntimeException('Container is required to run this migration.');
+        }
+
+        $this->container = $container;
+    }
 
     public function up(SessionInterface $session)
     {

diff --git a/Resources/phpcr-migrations/Version202005151141.php b/Resources/phpcr-migrations/Version202005151141.php
@@ -13,12 +13,23 @@
 
 use PHPCR\Migrations\VersionInterface;
 use PHPCR\SessionInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
 class Version202005151141 implements VersionInterface, ContainerAwareInterface
 {
-    use ContainerAwareTrait;
+    /**
+     * @var ContainerInterface
+     */
+    private $container;
+
+    public function setContainer(?ContainerInterface $container = null): void
+    {
+        if (null === $container) {
+            throw new \RuntimeException('Container is required to run this migration.');
+        }
+
+        $this->container = $container;
+    }
 
     public function up(SessionInterface $session)
     {

diff --git a/Resources/phpcr-migrations/Version202005191117.php b/Resources/phpcr-migrations/Version202005191117.php
@@ -13,12 +13,23 @@
 
 use PHPCR\Migrations\VersionInterface;
 use PHPCR\SessionInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
 class Version202005191117 implements VersionInterface, ContainerAwareInterface
 {
-    use ContainerAwareTrait;
+    /**
+     * @var ContainerInterface
+     */
+    private $container;
+
+    public function setContainer(?ContainerInterface $container = null): void
+    {
+        if (null === $container) {
+            throw new \RuntimeException('Container is required to run this migration.');
+        }
+
+        $this->container = $container;
+    }
 
     public function up(SessionInterface $session)
     {

diff --git a/Resources/phpcr-migrations/Version202005250920.php b/Resources/phpcr-migrations/Version202005250920.php
@@ -13,12 +13,23 @@
 
 use PHPCR\Migrations\VersionInterface;
 use PHPCR\SessionInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
 class Version202005250920 implements VersionInterface, ContainerAwareInterface
 {
-    use ContainerAwareTrait;
+    /**
+     * @var ContainerInterface
+     */
+    private $container;
+
+    public function setContainer(?ContainerInterface $container = null): void
+    {
+        if (null === $container) {
+            throw new \RuntimeException('Container is required to run this migration.');
+        }
+
+        $this->container = $container;
+    }
 
     public function up(SessionInterface $session)
     {

diff --git a/Resources/phpcr-migrations/Version202210140922.php b/Resources/phpcr-migrations/Version202210140922.php
@@ -13,15 +13,26 @@
 
 use PHPCR\Migrations\VersionInterface;
 use PHPCR\SessionInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Auto-generated Migration: Please modify to your needs!
  */
 final class Version202210140922 implements VersionInterface, ContainerAwareInterface
 {
-    use ContainerAwareTrait;
+    /**
+     * @var ContainerInterface
+     */
+    private $container;
+
+    public function setContainer(?ContainerInterface $container = null): void
+    {
+        if (null === $container) {
+            throw new \RuntimeException('Container is required to run this migration.');
+        }
+
+        $this->container = $container;
+    }
 
     public function up(SessionInterface $session)
     {

diff --git a/Resources/phpcr-migrations/Version202210241106.php b/Resources/phpcr-migrations/Version202210241106.php
@@ -15,12 +15,23 @@
 use PHPCR\Migrations\VersionInterface;
 use PHPCR\SessionInterface;
 use Sulu\Component\Localization\Localization;
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
-use Symfony\Component\DependencyInjection\ContainerAwareTrait;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
 class Version202210241106 implements VersionInterface, ContainerAwareInterface
 {
-    use ContainerAwareTrait;
+    /**
+     * @var ContainerInterface
+     */
+    private $container;
+
+    public function setContainer(?ContainerInterface $container = null): void
+    {
+        if (null === $container) {
+            throw new \RuntimeException('Container is required to run this migration.');
+        }
+
+        $this->container = $container;
+    }
 
     public function up(SessionInterface $session)
     {

diff --git a/Resources/phpcr-migrations/Version202407111600.php b/Resources/phpcr-migrations/Version202407111600.php
@@ -13,7 +13,6 @@
 
 use Jackalope\Query\Row;
 use PHPCR\Migrations\VersionInterface;
-use PHPCR\PhpcrMigrationsBundle\ContainerAwareInterface;
 use PHPCR\SessionInterface;
 use Sulu\Bundle\ArticleBundle\Document\Subscriber\RoutableSubscriber;
 use Sulu\Component\Content\Metadata\Factory\StructureMetadataFactoryInterface;
-Original file line number
+Diff line change
@@ Expand Up / @@ -66,6 +66,6 @@ public function getResource() @@
         public function getImage()
         {
-            return;
+            return null;
         }
     }