Merge pull request #1958 from greg0ire/no-yml

Remove support for YML

Author: greg0ire

UPGRADE-3.0.md

@@ -22,6 +22,8 @@ More details below
 This makes `DisconnectedMetadataFactory` redundant, as it relies on code
 available only in `doctrine/orm` 2. It has been removed.
 
+Support for the YML and annotation metadata drivers has been dropped.
+
 Commands
 --------
 

config/orm.php

@@ -22,7 +22,6 @@
 use Doctrine\ORM\Mapping\DefaultTypedFieldMapper;
 use Doctrine\ORM\Mapping\Driver\AttributeDriver;
 use Doctrine\ORM\Mapping\Driver\SimplifiedXmlDriver;
-use Doctrine\ORM\Mapping\Driver\SimplifiedYamlDriver;
 use Doctrine\ORM\Mapping\UnderscoreNamingStrategy;
 use Doctrine\ORM\Tools\AttachEntityListenersListener;
 use Doctrine\ORM\Tools\Console\Command\ClearCache\CollectionRegionCommand;
@@ -67,7 +66,6 @@
         // metadata drivers
         ->set('doctrine.orm.metadata.driver_chain.class', MappingDriverChain::class)
         ->set('doctrine.orm.metadata.xml.class', SimplifiedXmlDriver::class)
-        ->set('doctrine.orm.metadata.yml.class', SimplifiedYamlDriver::class)
         ->set('doctrine.orm.metadata.php.class', PHPDriver::class)
         ->set('doctrine.orm.metadata.staticphp.class', StaticPHPDriver::class)
         ->set('doctrine.orm.metadata.attribute.class', AttributeDriver::class)

docs/en/configuration.rst

@@ -738,7 +738,7 @@ configuration for the ORM and there are several configuration options that you
 can control. The following configuration options exist for a mapping:
 
 ``type``
-    One of ``attribute``, ``xml``, ``yml``, ``php`` or ``staticphp``.
+    One of ``attribute``, ``xml``, ``php`` or ``staticphp``.
     This specifies which type of metadata type your mapping uses.
 
 ``dir``

phpstan.neon.dist

@@ -6,8 +6,6 @@ parameters:
       - tests
 
    ignoreErrors:
-    - message: '#(Annotation|SimplifiedYaml)Driver#'
-      identifier: class.notFound
     # phpstan has no array shape intersection support https://github.com/phpstan/phpstan/issues/12414
     - message: '#unresolvable type.#'
       path: src/DataCollector/DoctrineDataCollector.php

src/DependencyInjection/Compiler/DoctrineOrmMappingsPass.php

@@ -4,7 +4,6 @@
 
 use Doctrine\ORM\Mapping\Driver\AttributeDriver;
 use Doctrine\ORM\Mapping\Driver\XmlDriver;
-use Doctrine\ORM\Mapping\Driver\YamlDriver;
 use Doctrine\Persistence\Mapping\Driver\PHPDriver;
 use Doctrine\Persistence\Mapping\Driver\StaticPHPDriver;
 use Doctrine\Persistence\Mapping\Driver\SymfonyFileLocator;
@@ -72,28 +71,6 @@ public static function createXmlMappingDriver(array $namespaces, array $managerP
         return new DoctrineOrmMappingsPass($driver, $namespaces, $managerParameters, $enabledParameter, $aliasMap);
     }
 
-    /**
-     * @param string[]     $namespaces        Hashmap of directory path to namespace
-     * @param string[]     $managerParameters List of parameters that could which object manager name
-     *                                        your bundle uses. This compiler pass will automatically
-     *                                        append the parameter name for the default entity manager
-     *                                        to this list.
-     * @param string|false $enabledParameter  Service container parameter that must be present to
-     *                                        enable the mapping. Set to false to not do any check,
-     *                                        optional.
-     * @param string[]     $aliasMap          Map of alias to namespace.
-     *
-     * @return self
-     */
-    public static function createYamlMappingDriver(array $namespaces, array $managerParameters = [], $enabledParameter = false, array $aliasMap = [])
-    {
-        $locator = new Definition(SymfonyFileLocator::class, [$namespaces, '.orm.yml']);
-        /* @phpstan-ignore class.notFound */
-        $driver = new Definition(YamlDriver::class, [$locator]);
-
-        return new DoctrineOrmMappingsPass($driver, $namespaces, $managerParameters, $enabledParameter, $aliasMap);
-    }
-
     /**
      * @param string[]     $namespaces        Hashmap of directory path to namespace
      * @param string[]     $managerParameters List of parameters that could which object manager name

src/DependencyInjection/DoctrineExtension.php

@@ -24,7 +24,6 @@
 use Doctrine\ORM\Mapping\Driver\AttributeDriver;
 use Doctrine\ORM\Mapping\Driver\PHPDriver as LegacyPHPDriver;
 use Doctrine\ORM\Mapping\Driver\SimplifiedXmlDriver;
-use Doctrine\ORM\Mapping\Driver\SimplifiedYamlDriver;
 use Doctrine\ORM\Mapping\Driver\StaticPHPDriver as LegacyStaticPHPDriver;
 use Doctrine\ORM\Mapping\Embeddable;
 use Doctrine\ORM\Mapping\Entity;
@@ -840,11 +839,11 @@ protected function loadOrmEntityManager(array $entityManager, ContainerBuilder $
      *  doctrine.orm:
      *     mappings:
      *         MyBundle1: ~
-     *         MyBundle2: yml
+     *         MyBundle2: xml
      *         MyBundle3: { type: xml, dir: Resources/config/doctrine/mapping }
      *         MyBundle4: { type: attribute, dir: Entities/ }
      *         MyBundle5:
-     *             type: yml
+     *             type: xml
      *             dir: bundle-mappings/
      *             alias: BundleAlias
      *         arbitrary_key:
@@ -1154,10 +1153,6 @@ protected function getMetadataDriverClass(string $driverType): string
             case 'xml':
                 return SimplifiedXmlDriver::class;
 
-            case 'yml':
-                /* @phpstan-ignore class.notFound */
-                return SimplifiedYamlDriver::class;
-
             case 'php':
                 /* @phpstan-ignore class.notFound */
                 return class_exists(PHPDriver::class) ? PHPDriver::class : LegacyPHPDriver::class;

tests/DependencyInjection/AbstractDoctrineExtensionTestCase.php

@@ -534,7 +534,7 @@ public function testSingleEntityManagerMultipleMappingBundleDefinitions(): void
             self::markTestSkipped('This test requires ORM');
         }
 
-        $container = $this->loadContainer('orm_single_em_bundle_mappings', ['YamlBundle', 'XmlBundle', 'AttributesBundle']);
+        $container = $this->loadContainer('orm_single_em_bundle_mappings', ['XmlBundle', 'AttributesBundle']);
 
         $definition = $container->getDefinition('doctrine.orm.default_metadata_driver');
 
@@ -574,7 +574,7 @@ public function testMultipleEntityManagersMappingBundleDefinitions(): void
             self::markTestSkipped('This test requires ORM');
         }
 
-        $container = $this->loadContainer('orm_multiple_em_bundle_mappings', ['YamlBundle', 'XmlBundle', 'AttributesBundle']);
+        $container = $this->loadContainer('orm_multiple_em_bundle_mappings', ['XmlBundle', 'AttributesBundle']);
 
         $this->assertEquals(['em1' => 'doctrine.orm.em1_entity_manager', 'em2' => 'doctrine.orm.em2_entity_manager'], $container->getParameter('doctrine.entity_managers'), 'Set of the existing EntityManagers names is incorrect.');
         $this->assertEquals('%doctrine.entity_managers%', $container->getDefinition('doctrine')->getArgument(2), 'Set of the existing EntityManagers names is incorrect.');
@@ -611,7 +611,7 @@ public function testSingleEntityManagerDefaultTableOptions(): void
             self::markTestSkipped('This test requires ORM');
         }
 
-        $container = $this->loadContainer('orm_single_em_default_table_options', ['YamlBundle', 'XmlBundle', 'AttributesBundle']);
+        $container = $this->loadContainer('orm_single_em_default_table_options', ['XmlBundle', 'AttributesBundle']);
 
         $param = $container->getDefinition('doctrine.dbal.default_connection')->getArgument(0);
 

tests/DependencyInjection/DoctrineExtensionTest.php

@@ -24,7 +24,6 @@
 use Doctrine\ORM\Events;
 use Doctrine\ORM\Mapping\Driver\AttributeDriver;
 use Doctrine\ORM\Mapping\Driver\SimplifiedXmlDriver;
-use Doctrine\ORM\Mapping\Driver\SimplifiedYamlDriver;
 use Doctrine\ORM\Mapping\Embeddable;
 use Doctrine\ORM\Mapping\Entity;
 use Doctrine\ORM\Mapping\MappedSuperclass;
@@ -407,8 +406,6 @@ public function testDependencyInjectionConfigurationDefaults(): void
         $this->assertEquals('Proxies', $container->getParameter('doctrine.orm.proxy_namespace'));
         $this->assertEquals(MappingDriverChain::class, $container->getParameter('doctrine.orm.metadata.driver_chain.class'));
         $this->assertEquals(SimplifiedXmlDriver::class, $container->getParameter('doctrine.orm.metadata.xml.class'));
-        /* @phpstan-ignore class.notFound */
-        $this->assertEquals(SimplifiedYamlDriver::class, $container->getParameter('doctrine.orm.metadata.yml.class'));
 
         // second-level cache
         $this->assertEquals(DefaultCacheFactory::class, $container->getParameter('doctrine.orm.second_level_cache.default_cache_factory.class'));
@@ -731,37 +728,6 @@ public function testOverrideDefaultEntityManagerWithAdditionalConfiguration(): v
         $this->assertEquals('app', $container->getParameter('doctrine.default_entity_manager'));
     }
 
-    public function testYamlBundleMappingDetection(): void
-    {
-        if (! interface_exists(EntityManagerInterface::class)) {
-            self::markTestSkipped('This test requires ORM');
-        }
-
-        $container = $this->getContainer(['YamlBundle']);
-        $extension = new DoctrineExtension();
-
-        $config = BundleConfigurationBuilder::createBuilder()
-            ->addBaseConnection()
-            ->addEntityManager([
-                'default_entity_manager' => 'default',
-                'entity_managers' => [
-                    'default' => [
-                        'mappings' => [
-                            'YamlBundle' => [],
-                        ],
-                    ],
-                ],
-            ])
-            ->build();
-        $extension->load([$config], $container);
-
-        $definition = $container->getDefinition('doctrine.orm.default_metadata_driver');
-        $this->assertDICDefinitionMethodCallOnce($definition, 'addDriver', [
-            new Reference('doctrine.orm.default_yml_metadata_driver'),
-            'Fixtures\Bundles\YamlBundle\Entity',
-        ]);
-    }
-
     public function testXmlBundleMappingDetection(): void
     {
         if (! interface_exists(EntityManagerInterface::class)) {