Skip to content

Commit 14ea9c7

Browse files
Nyholmjaviereguiluz
Nyholm
authored and
javiereguiluz
committed
[ConfigBuilder] Adding PHP ConfigBuilders for DoctrineBundle
1 parent a48b9cf commit 14ea9c7

File tree

7 files changed

+119
-138
lines changed

7 files changed

+119
-138
lines changed

‎configuration/secrets.rst‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -138,11 +138,14 @@ If you stored a ``DATABASE_PASSWORD`` secret, you can reference it by:
138138
.. code-block:: php
139139
140140
// config/packages/doctrine.php
141-
$container->loadFromExtension('doctrine', [
142-
'dbal' => [
143-
'password' => '%env(DATABASE_PASSWORD)%',
144-
]
145-
]);
141+
use Symfony\Config\DoctrineConfig;
142+
143+
return static function (DoctrineConfig $doctrine) {
144+
$doctrine->dbal()
145+
->connection('default')
146+
->password('%env(DATABASE_PASSWORD)%')
147+
;
148+
};
146149
147150
The actual value will be resolved at runtime: container compilation and cache
148151
warmup don't need the **decryption key**.

‎doctrine/custom_dql_functions.rst‎

Lines changed: 20 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -57,24 +57,19 @@ In Symfony, you can register your custom DQL functions as follows:
5757
use App\DQL\NumericFunction;
5858
use App\DQL\SecondStringFunction;
5959
use App\DQL\StringFunction;
60+
use Symfony\Config\DoctrineConfig;
6061
61-
$container->loadFromExtension('doctrine', [
62-
'orm' => [
63-
// ...
64-
'dql' => [
65-
'string_functions' => [
66-
'test_string' => StringFunction::class,
67-
'second_string' => SecondStringFunction::class,
68-
],
69-
'numeric_functions' => [
70-
'test_numeric' => NumericFunction::class,
71-
],
72-
'datetime_functions' => [
73-
'test_datetime' => DatetimeFunction::class,
74-
],
75-
],
76-
],
77-
]);
62+
return static function (DoctrineConfig $doctrine) {
63+
$defaultDql = $doctrine->orm()
64+
->entityManager('default')
65+
// ...
66+
->dql();
67+
68+
$defaultDql->stringFunction('test_string', StringFunction::class);
69+
$defaultDql->stringFunction('second_string', SecondStringFunction::class);
70+
$defaultDql->numericFunction('test_numeric', NumericFunction::class);
71+
$defaultDql->datetimeFunction('test_datetime', DatetimeFunction::class);
72+
};
7873
7974
.. note::
8075

@@ -129,21 +124,15 @@ In Symfony, you can register your custom DQL functions as follows:
129124
130125
// config/packages/doctrine.php
131126
use App\DQL\DatetimeFunction;
127+
use Symfony\Config\DoctrineConfig;
132128
133-
$container->loadFromExtension('doctrine', [
134-
'orm' => [
129+
return static function (DoctrineConfig $doctrine) {
130+
$doctrine->orm()
135131
// ...
136-
'entity_managers' => [
137-
'example_manager' => [
138-
// place your functions here
139-
'dql' => [
140-
'datetime_functions' => [
141-
'test_datetime' => DatetimeFunction::class,
142-
],
143-
],
144-
],
145-
],
146-
],
147-
]);
132+
->entityManager('example_manager')
133+
// place your functions here
134+
->dql()
135+
->datetimeFunction('test_datetime', DatetimeFunction::class);
136+
};
148137
149138
.. _`DQL User Defined Functions`: https://www.doctrine-project.org/projects/doctrine-orm/en/current/cookbook/dql-user-defined-functions.html

‎doctrine/dbal.rst‎

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -105,15 +105,13 @@ mapping types, read Doctrine's `Custom Mapping Types`_ section of their document
105105
// config/packages/doctrine.php
106106
use App\Type\CustomFirst;
107107
use App\Type\CustomSecond;
108+
use Symfony\Config\DoctrineConfig;
108109
109-
$container->loadFromExtension('doctrine', [
110-
'dbal' => [
111-
'types' => [
112-
'custom_first' => CustomFirst::class,
113-
'custom_second' => CustomSecond::class,
114-
],
115-
],
116-
]);
110+
return static function (DoctrineConfig $doctrine) {
111+
$dbal = $doctrine->dbal();
112+
$dbal->type('custom_first')->class(CustomFirst::class);
113+
$dbal->type('custom_second')->class(CustomSecond::class);
114+
};
117115
118116
Registering custom Mapping Types in the SchemaTool
119117
--------------------------------------------------
@@ -156,13 +154,13 @@ mapping type:
156154
.. code-block:: php
157155
158156
// config/packages/doctrine.php
159-
$container->loadFromExtension('doctrine', [
160-
'dbal' => [
161-
'mapping_types' => [
162-
'enum' => 'string',
163-
],
164-
],
165-
]);
157+
use Symfony\Config\DoctrineConfig;
158+
159+
return static function (DoctrineConfig $doctrine) {
160+
$dbalDefault = $doctrine->dbal()
161+
->connection('default');
162+
$dbalDefault->mappingType('enum', 'string');
163+
};
166164
167165
.. _`PDO`: https://www.php.net/pdo
168166
.. _`Doctrine`: https://www.doctrine-project.org/

‎doctrine/multiple_entity_managers.rst‎

Lines changed: 41 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -128,57 +128,47 @@ The following configuration code shows how you can configure two entity managers
128128
.. code-block:: php
129129
130130
// config/packages/doctrine.php
131-
$container->loadFromExtension('doctrine', [
132-
'dbal' => [
133-
'default_connection' => 'default',
134-
'connections' => [
135-
// configure these for your database server
136-
'default' => [
137-
'url' => '%env(resolve:DATABASE_URL)%',
138-
'driver' => 'pdo_mysql',
139-
'server_version' => '5.7',
140-
'charset' => 'utf8mb4',
141-
],
142-
// configure these for your database server
143-
'customer' => [
144-
'url' => '%env(resolve:DATABASE_CUSTOMER_URL)%',
145-
'driver' => 'pdo_mysql',
146-
'server_version' => '5.7',
147-
'charset' => 'utf8mb4',
148-
],
149-
],
150-
],
151-
152-
'orm' => [
153-
'default_entity_manager' => 'default',
154-
'entity_managers' => [
155-
'default' => [
156-
'connection' => 'default',
157-
'mappings' => [
158-
'Main' => [
159-
'is_bundle' => false,
160-
'type' => 'annotation',
161-
'dir' => '%kernel.project_dir%/src/Entity/Main',
162-
'prefix' => 'App\Entity\Main',
163-
'alias' => 'Main',
164-
]
165-
],
166-
],
167-
'customer' => [
168-
'connection' => 'customer',
169-
'mappings' => [
170-
'Customer' => [
171-
'is_bundle' => false,
172-
'type' => 'annotation',
173-
'dir' => '%kernel.project_dir%/src/Entity/Customer',
174-
'prefix' => 'App\Entity\Customer',
175-
'alias' => 'Customer',
176-
]
177-
],
178-
],
179-
],
180-
],
181-
]);
131+
use Symfony\Config\DoctrineConfig;
132+
133+
return static function (DoctrineConfig $doctrine) {
134+
$doctrine->dbal()->defaultConnection('default');
135+
136+
// configure these for your database server
137+
$doctrine->dbal()
138+
->connection('default')
139+
->url('%env(resolve:DATABASE_URL)%')
140+
->driver('pdo_mysql')
141+
->serverVersion('5.7')
142+
->charset('utf8mb4');
143+
144+
// configure these for your database server
145+
$doctrine->dbal()
146+
->connection('customer')
147+
->url('%env(resolve:DATABASE_CUSTOMER_URL)%')
148+
->driver('pdo_mysql')
149+
->serverVersion('5.7')
150+
->charset('utf8mb4');
151+
152+
$doctrine->orm()->defaultEntityManager('default');
153+
$emDefault = $doctrine->orm()->entityManager('default');
154+
$emDefault->connection('default');
155+
$emDefault->mapping('Main')
156+
->isBundle(false)
157+
->type('annotation')
158+
->dir('%kernel.project_dir%/src/Entity/Main')
159+
->prefix('App\Entity\Main')
160+
->alias('Main');
161+
162+
$emCustomer = $doctrine->orm()->entityManager('customer');
163+
$emCustomer->connection('customer');
164+
$emCustomer->mapping('Customer')
165+
->isBundle(false)
166+
->type('annotation')
167+
->dir('%kernel.project_dir%/src/Entity/Customer')
168+
->prefix('App\Entity\Customer')
169+
->alias('Customer')
170+
;
171+
};
182172
183173
In this case, you've defined two entity managers and called them ``default``
184174
and ``customer``. The ``default`` entity manager manages entities in the

‎doctrine/resolve_target_entity.rst‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -139,15 +139,13 @@ about the replacement:
139139
// config/packages/doctrine.php
140140
use App\Entity\Customer;
141141
use App\Model\InvoiceSubjectInterface;
142+
use Symfony\Config\DoctrineConfig;
142143
143-
$container->loadFromExtension('doctrine', [
144-
'orm' => [
145-
// ...
146-
'resolve_target_entities' => [
147-
InvoiceSubjectInterface::class => Customer::class,
148-
],
149-
],
150-
]);
144+
return static function (DoctrineConfig $doctrine) {
145+
$orm = $doctrine->orm();
146+
// ...
147+
$orm->resolveTargetEntity(InvoiceSubjectInterface::class, Customer::class);
148+
};
151149
152150
Final Thoughts
153151
--------------

‎reference/configuration/doctrine.rst‎

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -345,14 +345,17 @@ directory instead:
345345
346346
.. code-block:: php
347347
348-
$container->loadFromExtension('doctrine', [
349-
'orm' => [
350-
'auto_mapping' => true,
351-
'mappings' => [
352-
'AppBundle' => ['dir' => 'SomeResources/config/doctrine', 'type' => 'xml'],
353-
],
354-
],
355-
]);
348+
use Symfony\Config\DoctrineConfig;
349+
350+
return static function (DoctrineConfig $doctrine) {
351+
$emDefault = $doctrine->orm()->entityManager('default');
352+
353+
$emDefault->autoMapping(true);
354+
$emDefault->mapping('AppBundle')
355+
->type('xml')
356+
->dir('SomeResources/config/doctrine')
357+
;
358+
};
356359
357360
Mapping Entities Outside of a Bundle
358361
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -402,20 +405,20 @@ namespace in the ``src/Entity`` directory and gives them an ``App`` alias
402405
403406
.. code-block:: php
404407
405-
$container->loadFromExtension('doctrine', [
406-
'orm' => [
407-
'auto_mapping' => true,
408-
'mappings' => [
409-
'SomeEntityNamespace' => [
410-
'type' => 'annotation',
411-
'dir' => '%kernel.project_dir%/src/Entity',
412-
'is_bundle' => false,
413-
'prefix' => 'App\Entity',
414-
'alias' => 'App',
415-
],
416-
],
417-
],
418-
]);
408+
use Symfony\Config\DoctrineConfig;
409+
410+
return static function (DoctrineConfig $doctrine) {
411+
$emDefault = $doctrine->orm()->entityManager('default');
412+
413+
$emDefault->autoMapping(true);
414+
$emDefault->mapping('SomeEntityNamespace')
415+
->type('annotation')
416+
->dir('%kernel.project_dir%/src/Entity')
417+
->isBundle(false)
418+
->prefix('App\Entity')
419+
->alias('App')
420+
;
421+
};
419422
420423
Detecting a Mapping Configuration Format
421424
........................................

‎security/remember_me.rst‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -289,13 +289,13 @@ so ``DoctrineTokenProvider`` can store the tokens:
289289
.. code-block:: php
290290
291291
# config/packages/doctrine.php
292-
$container->loadFromExtension('doctrine', [
293-
'dbal' => [
294-
'schema_filter' => '~^(?!rememberme_token)~',
295-
// ...
296-
],
292+
use Symfony\Config\DoctrineConfig;
293+
294+
return static function (DoctrineConfig $doctrine) {
295+
$dbalDefault = $doctrine->dbal()->connection('default');
297296
// ...
298-
]);
297+
$dbalDefault->schemaFilter('~^(?!rememberme_token)~');
298+
};
299299
300300
Finally, set the ``token_provider`` option of the ``remember_me`` config to the
301301
service you created before:

0 commit comments

Comments
 (0)