deprecate all ORM proxy commands (#1581)

doctrine · Nov 16, 2022 · 03ad8e6 · 03ad8e6
1 parent 2f094c9
commit 03ad8e6
Show file tree

Hide file tree

Showing 19 changed files with 66 additions and 23 deletions.
diff --git a/Command/Proxy/ClearMetadataCacheDoctrineCommand.php b/Command/Proxy/ClearMetadataCacheDoctrineCommand.php
@@ -7,6 +7,8 @@
 
 /**
  * Command to clear the metadata cache of the various cache drivers.
+ *
+ * @deprecated use Doctrine\ORM\Tools\Console\Command\ClearCache\MetadataCommand instead
  */
 class ClearMetadataCacheDoctrineCommand extends MetadataCommand
 {

diff --git a/Command/Proxy/ClearQueryCacheDoctrineCommand.php b/Command/Proxy/ClearQueryCacheDoctrineCommand.php
@@ -7,6 +7,8 @@
 
 /**
  * Command to clear the query cache of the various cache drivers.
+ *
+ * @deprecated use Doctrine\ORM\Tools\Console\Command\ClearCache\QueryCommand instead
  */
 class ClearQueryCacheDoctrineCommand extends QueryCommand
 {

diff --git a/Command/Proxy/ClearResultCacheDoctrineCommand.php b/Command/Proxy/ClearResultCacheDoctrineCommand.php
@@ -7,6 +7,8 @@
 
 /**
  * Command to clear the result cache of the various cache drivers.
+ *
+ * @deprecated use Doctrine\ORM\Tools\Console\Command\ClearCache\ResultCommand instead
  */
 class ClearResultCacheDoctrineCommand extends ResultCommand
 {

diff --git a/Command/Proxy/CollectionRegionDoctrineCommand.php b/Command/Proxy/CollectionRegionDoctrineCommand.php
@@ -7,6 +7,8 @@
 
 /**
  * Command to clear a collection cache region.
+ *
+ * @deprecated use Doctrine\ORM\Tools\Console\Command\ClearCache\CollectionRegionCommand instead
  */
 class CollectionRegionDoctrineCommand extends CollectionRegionCommand
 {

diff --git a/Command/Proxy/ConvertMappingDoctrineCommand.php b/Command/Proxy/ConvertMappingDoctrineCommand.php
@@ -13,6 +13,8 @@
 /**
  * Convert Doctrine ORM metadata mapping information between the various supported
  * formats.
+ *
+ * @deprecated use Doctrine\ORM\Tools\Console\Command\ConvertMappingCommand instead
  */
 class ConvertMappingDoctrineCommand extends ConvertMappingCommand
 {

diff --git a/Command/Proxy/CreateSchemaDoctrineCommand.php b/Command/Proxy/CreateSchemaDoctrineCommand.php
@@ -8,6 +8,8 @@
 /**
  * Command to execute the SQL needed to generate the database schema for
  * a given entity manager.
+ *
+ * @deprecated use Doctrine\ORM\Tools\Console\Command\SchemaTool\CreateCommand instead
  */
 class CreateSchemaDoctrineCommand extends CreateCommand
 {

diff --git a/Command/Proxy/DropSchemaDoctrineCommand.php b/Command/Proxy/DropSchemaDoctrineCommand.php
@@ -7,6 +7,8 @@
 
 /**
  * Command to drop the database schema for a set of classes based on their mappings.
+ *
+ * @deprecated use Doctrine\ORM\Tools\Console\Command\SchemaTool\DropCommand instead
  */
 class DropSchemaDoctrineCommand extends DropCommand
 {

diff --git a/Command/Proxy/EnsureProductionSettingsDoctrineCommand.php b/Command/Proxy/EnsureProductionSettingsDoctrineCommand.php
@@ -7,6 +7,8 @@
 
 /**
  * Ensure the Doctrine ORM is configured properly for a production environment.
+ *
+ * @deprecated use Doctrine\ORM\Tools\Console\Command\EnsureProductionSettingsCommand instead
  */
 class EnsureProductionSettingsDoctrineCommand extends EnsureProductionSettingsCommand
 {

diff --git a/Command/Proxy/EntityRegionCacheDoctrineCommand.php b/Command/Proxy/EntityRegionCacheDoctrineCommand.php
@@ -7,6 +7,8 @@
 
 /**
  * Command to clear a entity cache region.
+ *
+ * @deprecated use Doctrine\ORM\Tools\Console\Command\ClearCache\EntityRegionCommand instead
  */
 class EntityRegionCacheDoctrineCommand extends EntityRegionCommand
 {

diff --git a/Command/Proxy/InfoDoctrineCommand.php b/Command/Proxy/InfoDoctrineCommand.php
@@ -7,6 +7,8 @@
 
 /**
  * Show information about mapped entities
+ *
+ * @deprecated use Doctrine\ORM\Tools\Console\Command\InfoCommand instead
  */
 class InfoDoctrineCommand extends InfoCommand
 {

diff --git a/Command/Proxy/OrmProxyCommand.php b/Command/Proxy/OrmProxyCommand.php
@@ -6,7 +6,12 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
-/** @internal */
+use function trigger_deprecation;
+
+/**
+ * @internal
+ * @deprecated
+ */
 trait OrmProxyCommand
 {
     private ?EntityManagerProvider $entityManagerProvider;
@@ -15,6 +20,14 @@ public function __construct(?EntityManagerProvider $entityManagerProvider = null
     {
         parent::__construct($entityManagerProvider);
         $this->entityManagerProvider = $entityManagerProvider;
+
+        trigger_deprecation(
+            'doctrine/doctrine-bundle',
+            '2.8',
+            'Class "%s" is deprecated. Use "%s" instead.',
+            self::class,
+            parent::class
+        );
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int

diff --git a/Command/Proxy/QueryRegionCacheDoctrineCommand.php b/Command/Proxy/QueryRegionCacheDoctrineCommand.php
@@ -7,6 +7,8 @@
 
 /**
  * Command to clear a query cache region.
+ *
+ * @deprecated use Doctrine\ORM\Tools\Console\Command\ClearCache\QueryRegionCommand instead
  */
 class QueryRegionCacheDoctrineCommand extends QueryRegionCommand
 {

diff --git a/Command/Proxy/RunDqlDoctrineCommand.php b/Command/Proxy/RunDqlDoctrineCommand.php
@@ -7,6 +7,8 @@
 
 /**
  * Execute a Doctrine DQL query and output the results.
+ *
+ * @deprecated use Doctrine\ORM\Tools\Console\Command\RunDqlCommand instead
  */
 class RunDqlDoctrineCommand extends RunDqlCommand
 {

diff --git a/Command/Proxy/UpdateSchemaDoctrineCommand.php b/Command/Proxy/UpdateSchemaDoctrineCommand.php
@@ -8,6 +8,8 @@
 /**
  * Command to generate the SQL needed to update the database schema to match
  * the current mapping information.
+ *
+ * @deprecated use Doctrine\ORM\Tools\Console\Command\SchemaTool\UpdateCommand instead
  */
 class UpdateSchemaDoctrineCommand extends UpdateCommand
 {

diff --git a/Command/Proxy/ValidateSchemaCommand.php b/Command/Proxy/ValidateSchemaCommand.php
@@ -7,6 +7,8 @@
 
 /**
  * Command to run Doctrine ValidateSchema() on the current mappings.
+ *
+ * @deprecated use Doctrine\ORM\Tools\Console\Command\ValidateSchemaCommand instead
  */
 class ValidateSchemaCommand extends DoctrineValidateSchemaCommand
 {

diff --git a/Resources/config/orm.xml b/Resources/config/orm.xml
@@ -181,72 +181,72 @@
         <service id="doctrine.orm.entity_value_resolver.expression_language" class="Symfony\Component\ExpressionLanguage\ExpressionLanguage" />
 
         <!-- commands -->
-        <service id="doctrine.cache_clear_metadata_command" class="Doctrine\Bundle\DoctrineBundle\Command\Proxy\ClearMetadataCacheDoctrineCommand">
+        <service id="doctrine.cache_clear_metadata_command" class="Doctrine\ORM\Tools\Console\Command\ClearCache\MetadataCommand">
             <argument type="service" id="doctrine.orm.command.entity_manager_provider" />
             <tag name="console.command" command="doctrine:cache:clear-metadata" />
         </service>
 
-        <service id="doctrine.cache_clear_query_cache_command" class="Doctrine\Bundle\DoctrineBundle\Command\Proxy\ClearQueryCacheDoctrineCommand">
+        <service id="doctrine.cache_clear_query_cache_command" class="Doctrine\ORM\Tools\Console\Command\ClearCache\QueryCommand">
             <argument type="service" id="doctrine.orm.command.entity_manager_provider" />
             <tag name="console.command" command="doctrine:cache:clear-query" />
         </service>
 
-        <service id="doctrine.cache_clear_result_command" class="Doctrine\Bundle\DoctrineBundle\Command\Proxy\ClearResultCacheDoctrineCommand">
+        <service id="doctrine.cache_clear_result_command" class="Doctrine\ORM\Tools\Console\Command\ClearCache\ResultCommand">
             <argument type="service" id="doctrine.orm.command.entity_manager_provider" />
             <tag name="console.command" command="doctrine:cache:clear-result" />
         </service>
 
-        <service id="doctrine.cache_collection_region_command" class="Doctrine\Bundle\DoctrineBundle\Command\Proxy\CollectionRegionDoctrineCommand">
+        <service id="doctrine.cache_collection_region_command" class="Doctrine\ORM\Tools\Console\Command\ClearCache\CollectionRegionCommand">
             <argument type="service" id="doctrine.orm.command.entity_manager_provider" />
             <tag name="console.command" command="doctrine:cache:clear-collection-region" />
         </service>
 
-        <service id="doctrine.mapping_convert_command" class="Doctrine\Bundle\DoctrineBundle\Command\Proxy\ConvertMappingDoctrineCommand">
+        <service id="doctrine.mapping_convert_command" class="Doctrine\ORM\Tools\Console\Command\ConvertMappingCommand">
             <argument type="service" id="doctrine.orm.command.entity_manager_provider" />
             <tag name="console.command" command="doctrine:mapping:convert" />
         </service>
 
-        <service id="doctrine.schema_create_command" class="Doctrine\Bundle\DoctrineBundle\Command\Proxy\CreateSchemaDoctrineCommand">
+        <service id="doctrine.schema_create_command" class="Doctrine\ORM\Tools\Console\Command\SchemaTool\CreateCommand">
             <argument type="service" id="doctrine.orm.command.entity_manager_provider" />
             <tag name="console.command" command="doctrine:schema:create" />
         </service>
 
-        <service id="doctrine.schema_drop_command" class="Doctrine\Bundle\DoctrineBundle\Command\Proxy\DropSchemaDoctrineCommand">
+        <service id="doctrine.schema_drop_command" class="Doctrine\ORM\Tools\Console\Command\SchemaTool\DropCommand">
             <argument type="service" id="doctrine.orm.command.entity_manager_provider" />
             <tag name="console.command" command="doctrine:schema:drop" />
         </service>
 
-        <service id="doctrine.ensure_production_settings_command" class="Doctrine\Bundle\DoctrineBundle\Command\Proxy\EnsureProductionSettingsDoctrineCommand">
+        <service id="doctrine.ensure_production_settings_command" class="Doctrine\ORM\Tools\Console\Command\EnsureProductionSettingsCommand">
             <argument type="service" id="doctrine.orm.command.entity_manager_provider" />
             <tag name="console.command" command="doctrine:ensure-production-settings" />
         </service>
 
-        <service id="doctrine.clear_entity_region_command" class="Doctrine\Bundle\DoctrineBundle\Command\Proxy\EntityRegionCacheDoctrineCommand">
+        <service id="doctrine.clear_entity_region_command" class="Doctrine\ORM\Tools\Console\Command\ClearCache\EntityRegionCommand">
             <argument type="service" id="doctrine.orm.command.entity_manager_provider" />
             <tag name="console.command" command="doctrine:cache:clear-entity-region" />
         </service>
 
-        <service id="doctrine.mapping_info_command" class="Doctrine\Bundle\DoctrineBundle\Command\Proxy\InfoDoctrineCommand">
+        <service id="doctrine.mapping_info_command" class="Doctrine\ORM\Tools\Console\Command\InfoCommand">
             <argument type="service" id="doctrine.orm.command.entity_manager_provider" />
             <tag name="console.command" command="doctrine:mapping:info" />
         </service>
 
-        <service id="doctrine.clear_query_region_command" class="Doctrine\Bundle\DoctrineBundle\Command\Proxy\QueryRegionCacheDoctrineCommand">
+        <service id="doctrine.clear_query_region_command" class="Doctrine\ORM\Tools\Console\Command\ClearCache\QueryRegionCommand">
             <argument type="service" id="doctrine.orm.command.entity_manager_provider" />
             <tag name="console.command" command="doctrine:cache:clear-query-region" />
         </service>
 
-        <service id="doctrine.query_dql_command" class="Doctrine\Bundle\DoctrineBundle\Command\Proxy\RunDqlDoctrineCommand">
+        <service id="doctrine.query_dql_command" class="Doctrine\ORM\Tools\Console\Command\RunDqlCommand">
             <argument type="service" id="doctrine.orm.command.entity_manager_provider" />
             <tag name="console.command" command="doctrine:query:dql" />
         </service>
 
-        <service id="doctrine.schema_update_command" class="Doctrine\Bundle\DoctrineBundle\Command\Proxy\UpdateSchemaDoctrineCommand">
+        <service id="doctrine.schema_update_command" class="Doctrine\ORM\Tools\Console\Command\SchemaTool\UpdateCommand">
             <argument type="service" id="doctrine.orm.command.entity_manager_provider" />
             <tag name="console.command" command="doctrine:schema:update" />
         </service>
 
-        <service id="doctrine.schema_validate_command" class="Doctrine\Bundle\DoctrineBundle\Command\Proxy\ValidateSchemaCommand">
+        <service id="doctrine.schema_validate_command" class="Doctrine\ORM\Tools\Console\Command\ValidateSchemaCommand">
             <argument type="service" id="doctrine.orm.command.entity_manager_provider" />
             <tag name="console.command" command="doctrine:schema:validate" />
         </service>

diff --git a/Tests/ContainerTest.php b/Tests/ContainerTest.php
@@ -2,8 +2,6 @@
 
 namespace Doctrine\Bundle\DoctrineBundle\Tests;
 
-use Doctrine\Bundle\DoctrineBundle\Command\Proxy\InfoDoctrineCommand;
-use Doctrine\Bundle\DoctrineBundle\Command\Proxy\UpdateSchemaDoctrineCommand;
 use Doctrine\Bundle\DoctrineBundle\Orm\ManagerRegistryAwareEntityManagerProvider;
 use Doctrine\Common\Annotations\Reader;
 use Doctrine\Common\EventManager;
@@ -13,6 +11,8 @@
 use Doctrine\ORM\Configuration;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Tools\Console\Command\InfoCommand;
+use Doctrine\ORM\Tools\Console\Command\SchemaTool\UpdateCommand;
 use Doctrine\Persistence\ManagerRegistry;
 use Doctrine\Persistence\Mapping\Driver\MappingDriverChain;
 use Symfony\Bridge\Doctrine\CacheWarmer\ProxyCacheWarmer;
@@ -61,8 +61,8 @@ public function testContainer(): void
         $this->assertInstanceOf(ProxyCacheWarmer::class, $container->get('doctrine.orm.proxy_cache_warmer'));
         $this->assertInstanceOf(ManagerRegistry::class, $container->get('doctrine'));
         $this->assertInstanceOf(UniqueEntityValidator::class, $container->get('doctrine.orm.validator.unique'));
-        $this->assertInstanceOf(InfoDoctrineCommand::class, $container->get('doctrine.mapping_info_command'));
-        $this->assertInstanceOf(UpdateSchemaDoctrineCommand::class, $container->get('doctrine.schema_update_command'));
+        $this->assertInstanceOf(InfoCommand::class, $container->get('doctrine.mapping_info_command'));
+        $this->assertInstanceOf(UpdateCommand::class, $container->get('doctrine.schema_update_command'));
 
         $this->assertSame($container->get('my.platform'), $container->get('doctrine.dbal.default_connection')->getDatabasePlatform());
 

diff --git a/UPGRADE-2.8.md b/UPGRADE-2.8.md
@@ -8,10 +8,11 @@ Dependencies
 
 Commands
 --------
- * Support for using Shards has been removed from `\Doctrine\Bundle\DoctrineBundle\Command\CreateDatabaseDoctrineCommand` as it's not supported using DBAL 3.
- * Support for using Shards has been removed from `\Doctrine\Bundle\DoctrineBundle\Command\DropDatabaseDoctrineCommand` as it's not supported using DBAL 3.
- * Support for using Shards has been removed from `\Doctrine\Bundle\DoctrineBundle\Command\ImportMappingDoctrineCommand` as it's not supported using DBAL 3.
- * The `\Doctrine\Bundle\DoctrineBundle\Command\Proxy\ImportDoctrineCommand` command has been removed as it's not supported using DBAL 3.
+ * Support for using Shards has been removed from `Doctrine\Bundle\DoctrineBundle\Command\CreateDatabaseDoctrineCommand` as it's not supported using DBAL 3.
+ * Support for using Shards has been removed from `Doctrine\Bundle\DoctrineBundle\Command\DropDatabaseDoctrineCommand` as it's not supported using DBAL 3.
+ * Support for using Shards has been removed from `Doctrine\Bundle\DoctrineBundle\Command\ImportMappingDoctrineCommand` as it's not supported using DBAL 3.
+ * The `Doctrine\Bundle\DoctrineBundle\Command\Proxy\ImportDoctrineCommand` command has been removed as it's not supported using DBAL 3.
+ * All ORM proxy commands in the namespace `Doctrine\Bundle\DoctrineBundle\Command\Proxy\` have been deprecated. Use their corresponding ORM command class directly instead.
 
 Configuration
 --------

diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -14,6 +14,7 @@
             <directory name="vendor"/>
             <!-- Deprecated classes, not worth fixing -->
             <file name="Command/ImportMappingDoctrineCommand.php"/>
+            <file name="Command/Proxy/OrmProxyCommand.php"/>
             <file name="DependencyInjection/Compiler/WellKnownSchemaFilterPass.php"/>
         </ignoreFiles>
         <directory name="CacheWarmer"/>