Deprecate `EntityManager::create()` #9961

derrabus · 2022-08-04T21:58:35Z

Now that the entity manager's constructor is public, why not make it the only way to construct an EM?

The only additional feature that create() has is that you can pass the connection parameters instead of a real DBAL connection. However, I believe that bootstrapping the DBAL connection is a concern that belongs into the DBAL library and the DBAL's DriverManager class already does a fine job in that regard.

This is why I believe that we shouldn't need the create() method anymore.

beberlei · 2022-08-04T23:33:01Z

Can you also check the docs for necesarry changes?

I am unsure about this. While your argument rings true, if we are on a greenfield project, we are not snd this method is not expensive to maintain, but will avoid breaking not only a lot of vode, but also tutorials, blog posts, books, ...

derrabus · 2022-08-05T09:20:46Z

Marking as draft for now. The documentation indeed deserves an update.

breaking not only a lot of code,

I don't believe that this is the case, actually. Usually, the EM is initialized once at a central point in your application. This is the one piece of code that you need to apply a trivial fix to.

Even more though, in applications that use some kind of framework integration like DoctrineBundle. In that case, this integration code will be patched and people won't even notice.

but also tutorials, blog posts, books, ...

Those will all still work for ORM 2. Deprecated code is not broken code. ORM 3 will be a little different than ORM 2 and I think it's acceptable that blogposts and tutorials need to be adjusted for a new major version.

My rationale here is that the ORM and the DBAL are not as inseparable anymore as they maybe used to be. The ::create() method might not be hard to maintain right now, but it also means that the DBAL can't change its own bootstrap too much without breaking the ORM.

greg0ire · 2022-10-23T08:51:41Z

lib/Doctrine/ORM/EntityManager.php

@@ -156,15 +156,15 @@ class EntityManager implements EntityManagerInterface
     * Creates a new EntityManager that operates on the given database connection
     * and uses the given Configuration and EventManager implementations.
     */
-    public function __construct(Connection $conn, Configuration $config)
+    public function __construct(Connection $conn, Configuration $config, ?EventManager $eventManager = null)


The class-level phpdoc comment refers to the factory method your deprecated, please update it.

SenseException · 2022-10-23T18:59:17Z

Is this still a draft or can it be changed into a PR?

derrabus · 2022-10-23T19:13:05Z

Still a draft because I'm updating the docs atm.

derrabus · 2022-10-23T20:56:56Z

Ready.

I chose to resurrect this PR because the latest deprecation in DBAL (removal of the EventManager integration) force us to change the create() method again. Let's remove the create() method, it's a burden.

* 2.14.x: Deprecate EntityManager::create() (doctrine#9961) Address deprecation of SchemaDiff::toSaveSql() Address deprecation of SchemaDiff::toSql() Use error style for notifications Fix calls to AbstractSchemaManager::createSchema() (doctrine#10165) Fix build with DBAL 3.5 (doctrine#10163) Adjust comments (doctrine#10160) Deprecate methods related to the annotation driver Use correct link Deprecate annotations Remove trailing whitespace Migrate more documentation towards attributes Remove wrong sentence Do not export phpstan stuff (doctrine#10154)

…r::create()` API Ref: https://github.com/doctrine/orm/blob/0aa45dd607100182294d31dee42b89338773f87e/lib/Doctrine/ORM/EntityManager.php#L956-L985 Ref: doctrine/orm#9961

frsmoray · 2023-01-13T11:30:09Z

Please update docs as official documentation on creating an EntityManager actually tells us to use the ::create() method. Not a single deprecation advice on that.

Thanks

greg0ire · 2023-01-13T12:59:35Z

@frsmoray You are linking to the 2.13.x docs. This was perfectly valid in 2.13.x

Not a single deprecation advice on that.

Use a nicer tone, this is not OK.

frsmoray · 2023-01-13T13:32:51Z

Sorry, mistakenly got pulled 2.14 onto my project. Expeting to be 2.13 as usual.

Use a nicer tone, this is not OK.

It's written text. Tone is a perception on spoken words. Apart from my mistake searching wrong docs, and 2.13 docs having nothing to do with any deprecation advice on that purpose, there is no deprecation notice at all there. If you think it twice, you may "find another tone" in these words

Not a single deprecation advice on that.

Thanks for the help :)

greg0ire · 2023-01-13T14:05:25Z

Sorry, mistakenly got pulled 2.14 onto my project. Expeting to be 2.13 as usual.

2.13 is no longer maintained, so if you upgrade, that's not a bad things, really.

It's written text. Tone is a perception on spoken words.

Wanna nit-pick? From https://www.merriam-webster.com/dictionary/tone :

style or manner of expression in speaking or writing

(emphasis mine)

Note that I didn't have to discard several web pages until finding one that fits my argument, it's literally the first one I clicked.

there is no deprecation notice at all there

You're right, but what's your point? Our policy is to document those in UPGRADE.md, not in the docs themselves.

If you think it twice, you may "find another tone" in these words

I can do that, and on your end, you can be more careful when addressing people that provide you with software updates for free. I guess you meant well, but having to do that assumption for everyone can be a bit exhausting, don't you think?

flack · 2023-12-04T19:22:55Z

docs/en/cookbook/resolve-target-entity-listener.rst

@@ -127,7 +127,8 @@ the targetEntity resolution will occur reliably:
    // Add the ResolveTargetEntityListener
    $evm->addEventListener(Doctrine\ORM\Events::loadClassMetadata, $rtel);

-    $em = \Doctrine\ORM\EntityManager::create($connectionOptions, $config, $evm);
+    $connection = \Doctrine\DBAL\DriverManager::createConnection($connectionOptions, $config, $evm);


is this supposed to be getConnection? There doesn't seem to be a createConnection function in this class

Yes, it became getConnection by now. It's totally okay if you want to create a pull request with changes for that.

If you haven't done a pull request for Doctrine, you might find this guide helpful:
https://www.doctrine-project.org/contribute/index.html

derrabus added the Deprecation label Aug 4, 2022

derrabus added this to the 2.13.0 milestone Aug 4, 2022

derrabus requested review from greg0ire and SenseException August 4, 2022 21:58

derrabus force-pushed the deprecate/em-create branch from c58da45 to f6cd5e8 Compare August 4, 2022 21:59

derrabus marked this pull request as draft August 5, 2022 09:05

derrabus modified the milestones: 2.13.0, 2.14.0 Aug 7, 2022

derrabus changed the base branch from 2.13.x to 2.14.x August 7, 2022 18:22

derrabus force-pushed the deprecate/em-create branch from f6cd5e8 to da2e462 Compare October 22, 2022 22:32

greg0ire reviewed Oct 23, 2022

View reviewed changes

derrabus force-pushed the deprecate/em-create branch from da2e462 to 9cb584c Compare October 23, 2022 20:20

Deprecate EntityManager::create()

e6eea74

derrabus force-pushed the deprecate/em-create branch from 9cb584c to e6eea74 Compare October 23, 2022 20:39

derrabus marked this pull request as ready for review October 23, 2022 20:54

greg0ire approved these changes Oct 23, 2022

View reviewed changes

derrabus merged commit f3f4532 into doctrine:2.14.x Oct 23, 2022

derrabus deleted the deprecate/em-create branch October 23, 2022 22:15

derrabus mentioned this pull request Oct 24, 2022

EntityManager calls Connection::getEventManager() which is deprecated since doctrine/dbal:3.5.0 #10167

Closed

github-actions bot mentioned this pull request Dec 19, 2022

Merge release 2.14.0 into 3.0.x #10324

Merged

keithbrink mentioned this pull request Feb 8, 2023

[FEATURE] DBAL 3 laravel-doctrine/orm#541

Merged

franmomu mentioned this pull request Aug 19, 2023

fix EntityManager::create deprecations doctrine-extensions/DoctrineExtensions#2669

Merged

flack reviewed Dec 4, 2023

View reviewed changes

flack mentioned this pull request Dec 4, 2023

Fix method name in code example #11104

Merged

GwendolenLynch mentioned this pull request Feb 21, 2024

Bump minimum Doctrine ORM version to v2.14 and add support for Doctrine ORM v3 & Lexer v3 martin-georgiev/postgresql-for-doctrine#184

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate `EntityManager::create()` #9961

Deprecate `EntityManager::create()` #9961

derrabus commented Aug 4, 2022

beberlei commented Aug 4, 2022

derrabus commented Aug 5, 2022

greg0ire Oct 23, 2022

SenseException commented Oct 23, 2022

derrabus commented Oct 23, 2022

derrabus commented Oct 23, 2022

frsmoray commented Jan 13, 2023

greg0ire commented Jan 13, 2023

frsmoray commented Jan 13, 2023 •

edited

Loading

greg0ire commented Jan 13, 2023

flack Dec 4, 2023

derrabus Dec 4, 2023

SenseException Dec 4, 2023 •

edited

Loading

flack Dec 4, 2023

Deprecate EntityManager::create() #9961

Deprecate EntityManager::create() #9961

Conversation

derrabus commented Aug 4, 2022

beberlei commented Aug 4, 2022

derrabus commented Aug 5, 2022

greg0ire Oct 23, 2022

Choose a reason for hiding this comment

SenseException commented Oct 23, 2022

derrabus commented Oct 23, 2022

derrabus commented Oct 23, 2022

frsmoray commented Jan 13, 2023

greg0ire commented Jan 13, 2023

frsmoray commented Jan 13, 2023 • edited Loading

greg0ire commented Jan 13, 2023

flack Dec 4, 2023

Choose a reason for hiding this comment

derrabus Dec 4, 2023

Choose a reason for hiding this comment

SenseException Dec 4, 2023 • edited Loading

Choose a reason for hiding this comment

flack Dec 4, 2023

Choose a reason for hiding this comment

Deprecate `EntityManager::create()` #9961

Deprecate `EntityManager::create()` #9961

frsmoray commented Jan 13, 2023 •

edited

Loading

SenseException Dec 4, 2023 •

edited

Loading