Skip to content

Commit 8805271

Browse files
goetasgoetas
authored
Merge pull request #366 from doctrine/merge-3.0.x-into-master
Merge 3.0.x into master
2 parents 1886713 + 4c185b3 commit 8805271

File tree

10 files changed

+516
-948
lines changed

10 files changed

+516
-948
lines changed

‎DependencyInjection/CompilerPass/ConfigureDependencyFactoryPass.php‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,17 @@
88
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
99
use Symfony\Component\DependencyInjection\ContainerBuilder;
1010
use Symfony\Component\DependencyInjection\Reference;
11+
1112
use function sprintf;
1213

1314
class ConfigureDependencyFactoryPass implements CompilerPassInterface
1415
{
15-
public function process(ContainerBuilder $container) : void
16+
public function process(ContainerBuilder $container): void
1617
{
1718
$preferredEm = $container->getParameter('doctrine.migrations.preferred_em');
1819
$diDefinition = $container->getDefinition('doctrine.migrations.dependency_factory');
1920

20-
$emID = sprintf('doctrine.orm.%s_entity_manager', $preferredEm ?: 'default');
21+
$emID = sprintf('doctrine.orm.%s_entity_manager', $preferredEm ?? 'default');
2122

2223
if ($container->has($emID)) {
2324
$container->getDefinition('doctrine.migrations.em_loader')
@@ -27,7 +28,7 @@ public function process(ContainerBuilder $container) : void
2728
$diDefinition->setArgument(1, new Reference('doctrine.migrations.em_loader'));
2829
} else {
2930
$preferredConnection = $container->getParameter('doctrine.migrations.preferred_connection');
30-
$connectionId = sprintf('doctrine.dbal.%s_connection', $preferredConnection ?: 'default');
31+
$connectionId = sprintf('doctrine.dbal.%s_connection', $preferredConnection ?? 'default');
3132
$container->getDefinition('doctrine.migrations.connection_loader')
3233
->setArgument(0, new Reference($connectionId));
3334

‎DependencyInjection/Configuration.php‎

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
use ReflectionClass;
88
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
99
use Symfony\Component\Config\Definition\ConfigurationInterface;
10+
1011
use function array_filter;
1112
use function array_keys;
1213
use function constant;
@@ -29,7 +30,7 @@ class Configuration implements ConfigurationInterface
2930
*
3031
* @return TreeBuilder The config tree builder
3132
*/
32-
public function getConfigTreeBuilder() : TreeBuilder
33+
public function getConfigTreeBuilder(): TreeBuilder
3334
{
3435
$treeBuilder = new TreeBuilder('doctrine_migrations');
3536

@@ -59,8 +60,8 @@ public function getConfigTreeBuilder() : TreeBuilder
5960
->defaultValue([])
6061
->validate()
6162
->ifTrue(static function ($v) {
62-
return count(array_filter(array_keys($v), static function (string $doctrineService) : bool {
63-
return strpos($doctrineService, 'Doctrine\Migrations\\') !==0;
63+
return count(array_filter(array_keys($v), static function (string $doctrineService): bool {
64+
return strpos($doctrineService, 'Doctrine\Migrations\\') !== 0;
6465
}));
6566
})
6667
->thenInvalid('Valid services for the DoctrineMigrationsBundle must be in the "Doctrine\Migrations" namespace.')
@@ -74,8 +75,8 @@ public function getConfigTreeBuilder() : TreeBuilder
7475
->defaultValue([])
7576
->validate()
7677
->ifTrue(static function ($v) {
77-
return count(array_filter(array_keys($v), static function (string $doctrineService) : bool {
78-
return strpos($doctrineService, 'Doctrine\Migrations\\') !==0;
78+
return count(array_filter(array_keys($v), static function (string $doctrineService): bool {
79+
return strpos($doctrineService, 'Doctrine\Migrations\\') !== 0;
7980
}));
8081
})
8182
->thenInvalid('Valid callables for the DoctrineMigrationsBundle must be in the "Doctrine\Migrations" namespace.')
@@ -130,16 +131,12 @@ public function getConfigTreeBuilder() : TreeBuilder
130131
->defaultValue(false)
131132
->info('Organize migrations mode. Possible values are: "BY_YEAR", "BY_YEAR_AND_MONTH", false')
132133
->validate()
133-
->ifTrue(static function ($v) use ($organizeMigrationModes) {
134+
->ifTrue(static function ($v) use ($organizeMigrationModes): bool {
134135
if ($v === false) {
135136
return false;
136137
}
137138

138-
if (is_string($v) && in_array(strtoupper($v), $organizeMigrationModes, true)) {
139-
return false;
140-
}
141-
142-
return true;
139+
return ! is_string($v) || ! in_array(strtoupper($v), $organizeMigrationModes, true);
143140
})
144141
->thenInvalid('Invalid organize migrations mode value %s')
145142
->end()
@@ -155,13 +152,12 @@ public function getConfigTreeBuilder() : TreeBuilder
155152
return $treeBuilder;
156153
}
157154

158-
159155
/**
160156
* Find organize migrations modes for their names
161157
*
162158
* @return string[]
163159
*/
164-
private function getOrganizeMigrationsModes() : array
160+
private function getOrganizeMigrationsModes(): array
165161
{
166162
$constPrefix = 'VERSIONS_ORGANIZATION_';
167163
$prefixLen = strlen($constPrefix);

‎DependencyInjection/DoctrineMigrationsExtension.php‎

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
1616
use Symfony\Component\DependencyInjection\Reference;
1717
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
18+
1819
use function array_keys;
1920
use function explode;
2021
use function implode;
@@ -32,7 +33,7 @@ class DoctrineMigrationsExtension extends Extension
3233
*
3334
* @param string[][]|array<string, array<string, array<string, string>|string>> $configs
3435
*/
35-
public function load(array $configs, ContainerBuilder $container) : void
36+
public function load(array $configs, ContainerBuilder $container): void
3637
{
3738
$configuration = new Configuration();
3839

@@ -82,19 +83,23 @@ public function load(array $configs, ContainerBuilder $container) : void
8283
$container->setDefinition('doctrine.migrations.storage.table_storage', $storageDefinition);
8384
$container->setAlias('doctrine.migrations.metadata_storage', 'doctrine.migrations.storage.table_storage');
8485

85-
if ($storageConfiguration['table_name']!== null) {
86+
if ($storageConfiguration['table_name'] !== null) {
8687
$storageDefinition->addMethodCall('setTableName', [$storageConfiguration['table_name']]);
8788
}
88-
if ($storageConfiguration['version_column_name']!== null) {
89+
90+
if ($storageConfiguration['version_column_name'] !== null) {
8991
$storageDefinition->addMethodCall('setVersionColumnName', [$storageConfiguration['version_column_name']]);
9092
}
91-
if ($storageConfiguration['version_column_length']!== null) {
93+
94+
if ($storageConfiguration['version_column_length'] !== null) {
9295
$storageDefinition->addMethodCall('setVersionColumnLength', [$storageConfiguration['version_column_length']]);
9396
}
94-
if ($storageConfiguration['executed_at_column_name']!== null) {
97+
98+
if ($storageConfiguration['executed_at_column_name'] !== null) {
9599
$storageDefinition->addMethodCall('setExecutedAtColumnName', [$storageConfiguration['executed_at_column_name']]);
96100
}
97-
if ($storageConfiguration['execution_time_column_name']!== null) {
101+
102+
if ($storageConfiguration['execution_time_column_name'] !== null) {
98103
$storageDefinition->addMethodCall('setExecutionTimeColumnName', [$storageConfiguration['execution_time_column_name']]);
99104
}
100105

@@ -111,20 +116,21 @@ public function load(array $configs, ContainerBuilder $container) : void
111116
$container->setParameter('doctrine.migrations.preferred_connection', $config['connection']);
112117
}
113118

114-
private function checkIfBundleRelativePath(string $path, ContainerBuilder $container) : string
119+
private function checkIfBundleRelativePath(string $path, ContainerBuilder $container): string
115120
{
116121
if (isset($path[0]) && $path[0] === '@') {
117122
$pathParts = explode('/', $path);
118123
$bundleName = substr($pathParts[0], 1);
119124

120125
$bundlePath = $this->getBundlePath($bundleName, $container);
126+
121127
return $bundlePath . substr($path, strlen('@' . $bundleName));
122128
}
123129

124130
return $path;
125131
}
126132

127-
private function getBundlePath(string $bundleName, ContainerBuilder $container) : string
133+
private function getBundlePath(string $bundleName, ContainerBuilder $container): string
128134
{
129135
$bundleMetadata = $container->getParameter('kernel.bundles_metadata');
130136

@@ -144,12 +150,12 @@ private function getBundlePath(string $bundleName, ContainerBuilder $container)
144150
*
145151
* @return string The XSD base path
146152
*/
147-
public function getXsdValidationBasePath() : string
153+
public function getXsdValidationBasePath(): string
148154
{
149155
return __DIR__ . '/../Resources/config/schema';
150156
}
151157

152-
public function getNamespace() : string
158+
public function getNamespace(): string
153159
{
154160
return 'http://symfony.com/schema/dic/doctrine/migrations/3.0';
155161
}

‎Resources/doc/index.rst‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,67 @@ You can skip single migrations by explicitly adding them to the ``migration_vers
230230

231231
Doctrine will then assume that this migration has already been run and will ignore it.
232232

233+
Migration Dependencies
234+
----------------------
235+
236+
Migrations can have dependencies on external services (such as geolocation, mailer, data processing services...) that
237+
can be used to have more powerful migrations. Those dependencies are not automatically injected into your migrations
238+
but need to be injected using custom migrations factories.
239+
240+
Here is an example on how to inject the service container into your migrations:
241+
242+
.. configuration-block::
243+
244+
.. code-block:: yaml
245+
246+
# config/packages/doctrine_migrations.yml
247+
doctrine_migrations:
248+
services:
249+
'Doctrine\Migrations\Version\MigrationFactory': 'App\Migrations\Factory\MigrationFactoryDecorator'
250+
251+
# config/services.yml
252+
services:
253+
Doctrine\Migrations\Version\DbalMigrationFactory: ~
254+
App\Migrations\Factory\MigrationFactoryDecorator:
255+
decorates: Doctrine\Migrations\Version\DbalMigrationFactory
256+
arguments: ['@App\Migrations\Factory\MigrationFactoryDecorator.inner', '@service_container']
257+
258+
259+
.. code-block:: php
260+
261+
declare(strict_types=1);
262+
263+
namespace App\Migrations\Factory;
264+
265+
use Doctrine\Migrations\AbstractMigration;
266+
use Doctrine\Migrations\Version\MigrationFactory;
267+
use Symfony\Component\DependencyInjection\ContainerAwareInterface;
268+
use Symfony\Component\DependencyInjection\ContainerInterface;
269+
270+
class MigrationFactoryDecorator implements MigrationFactory
271+
{
272+
private $migrationFactory;
273+
private $container;
274+
275+
public function __construct(MigrationFactory $migrationFactory, ContainerInterface $container)
276+
{
277+
$this->migrationFactory = $migrationFactory;
278+
$this->container = $container;
279+
}
280+
281+
public function createVersion(string $migrationClassName): AbstractMigration
282+
{
283+
$instance = $this->migrationFactory->createVersion($migrationClassName);
284+
285+
if ($instance instanceof ContainerAwareInterface) {
286+
$instance->setContainer($this->container);
287+
}
288+
289+
return $instance;
290+
}
291+
}
292+
293+
233294
Generating Migrations Automatically
234295
-----------------------------------
235296

‎Tests/DependencyInjection/DoctrineCommandsTest.php‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,15 @@
2727
use Symfony\Component\DependencyInjection\ContainerBuilder;
2828
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
2929
use Symfony\Component\HttpKernel\KernelInterface;
30+
3031
use function sys_get_temp_dir;
3132

3233
class DoctrineCommandsTest extends TestCase
3334
{
3435
/**
3536
* @dataProvider getCommands
3637
*/
37-
public function testCommandRegistered(string $name, string $instance) : void
38+
public function testCommandRegistered(string $name, string $instance): void
3839
{
3940
$application = $this->getApplication();
4041

@@ -44,7 +45,7 @@ public function testCommandRegistered(string $name, string $instance) : void
4445
/**
4546
* @return string[][]
4647
*/
47-
public function getCommands() : array
48+
public function getCommands(): array
4849
{
4950
return [
5051
['doctrine:migrations:diff', DiffCommand::class],
@@ -81,7 +82,7 @@ private function getKernel(ContainerBuilder $container)
8182
return $kernel;
8283
}
8384

84-
private function getApplication() : Application
85+
private function getApplication(): Application
8586
{
8687
$container = new ContainerBuilder(new ParameterBag([
8788
'kernel.debug' => false,

0 commit comments

Comments
 (0)