-
Notifications
You must be signed in to change notification settings - Fork 231
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deprecate modifying class parameters
- Loading branch information
Showing
3 changed files
with
88 additions
and
0 deletions.
There are no files selected for viewing
57 changes: 57 additions & 0 deletions
57
DependencyInjection/Compiler/DeprecateChangesClassParametersPass.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Doctrine\Bundle\MongoDBBundle\DependencyInjection\Compiler; | ||
|
||
use Doctrine\Bundle\MongoDBBundle\CacheWarmer\HydratorCacheWarmer; | ||
use Doctrine\Bundle\MongoDBBundle\CacheWarmer\PersistentCollectionCacheWarmer; | ||
use Doctrine\Bundle\MongoDBBundle\CacheWarmer\ProxyCacheWarmer; | ||
use Doctrine\Bundle\MongoDBBundle\ManagerConfigurator; | ||
use Doctrine\Bundle\MongoDBBundle\ManagerRegistry; | ||
use Doctrine\ODM\MongoDB\Configuration as MongoDBConfiguration; | ||
use Doctrine\ODM\MongoDB\DocumentManager; | ||
use MongoDB\Client; | ||
use Symfony\Bridge\Doctrine\ContainerAwareEventManager; | ||
use Symfony\Bridge\Doctrine\Security\User\EntityUserProvider; | ||
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntityValidator; | ||
use Symfony\Bridge\Doctrine\Validator\DoctrineInitializer; | ||
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface; | ||
use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
|
||
use function trigger_deprecation; | ||
|
||
/** @internal */ | ||
final class DeprecateChangesClassParametersPass implements CompilerPassInterface | ||
{ | ||
public function process(ContainerBuilder $container): void | ||
{ | ||
foreach ( | ||
[ | ||
'doctrine_mongodb.odm.connection.class' => Client::class, | ||
'doctrine_mongodb.odm.configuration.class' => MongoDBConfiguration::class, | ||
'doctrine_mongodb.odm.document_manager.class' => DocumentManager::class, | ||
'doctrine_mongodb.odm.manager_configurator.class' => ManagerConfigurator::class, | ||
'doctrine_mongodb.odm.event_manager.class' => ContainerAwareEventManager::class, | ||
'doctrine_odm.mongodb.validator_initializer.class' => DoctrineInitializer::class, | ||
'doctrine_odm.mongodb.validator.unique.class' => UniqueEntityValidator::class, | ||
'doctrine_mongodb.odm.class' => ManagerRegistry::class, | ||
'doctrine_mongodb.odm.security.user.provider.class' => EntityUserProvider::class, | ||
'doctrine_mongodb.odm.proxy_cache_warmer.class' => ProxyCacheWarmer::class, | ||
'doctrine_mongodb.odm.hydrator_cache_warmer.class' => HydratorCacheWarmer::class, | ||
'doctrine_mongodb.odm.persistent_collection_cache_warmer.class' => PersistentCollectionCacheWarmer::class, | ||
] as $parameter => $class | ||
) { | ||
if (! $container->hasParameter($parameter) || $container->getParameter($parameter) === $class) { | ||
continue; | ||
} | ||
|
||
trigger_deprecation( | ||
'doctrine/mongodb-odm-bundle', | ||
'4.7', | ||
'"%s" parameter is deprecated, use a compiler pass to update the service instead.', | ||
$parameter, | ||
); | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
29 changes: 29 additions & 0 deletions
29
Tests/DependencyInjection/Compiler/DeprecateChangesClassParametersPassTest.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Doctrine\Bundle\MongoDBBundle\Tests\DependencyInjection\Compiler; | ||
|
||
use Doctrine\Bundle\MongoDBBundle\DependencyInjection\Compiler\DeprecateChangesClassParametersPass; | ||
use PHPUnit\Framework\TestCase; | ||
use stdClass; | ||
use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait; | ||
use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
|
||
final class DeprecateChangesClassParametersPassTest extends TestCase | ||
{ | ||
use ExpectDeprecationTrait; | ||
|
||
/** @group legacy */ | ||
public function testChangeParameterClass(): void | ||
{ | ||
$compilerPass = new DeprecateChangesClassParametersPass(); | ||
|
||
$container = new ContainerBuilder(); | ||
$container->setParameter('doctrine_mongodb.odm.connection.class', stdClass::class); | ||
|
||
$this->expectDeprecation('Since doctrine/mongodb-odm-bundle 4.7: "doctrine_mongodb.odm.connection.class" parameter is deprecated, use a compiler pass to update the service instead.'); | ||
|
||
$compilerPass->process($container); | ||
} | ||
} |