Doctrine\Common\Util\ClassUtils being deprecated #867

TerjeBr · 2019-03-13T22:36:39Z

In my application I am using the latest doctrine 2.x. Recently we found it necessary to also use the static function Doctrine\Common\Util\ClassUtils::getRealClass(string $class). But this function is marked as deprecated.

I asked in issue 826 what would be the alternative function to use. Then I got the response that there is no alternative to that function in doctrine 2.x.

This issue is about removing those depreaction notices, since I see no point in marking something as deprecated when the application programmers have nothing to replace it with.

See also comment #826 (comment)

The text was updated successfully, but these errors were encountered:

TerjeBr · 2019-03-13T22:45:30Z

@Ocramius You said "If you want, you can make ClassUtils::getRealClass() proxy through to the new API in 3.x, and then we can drop it in 4.x."

Does that mean making it not deprecated in 2.x, adding a proxy for it in 3.x (which will be deprecated from the start) and then drop it in 4.x ?

If that is so, that is exactly the kind of change I wanted.

Ocramius · 2019-03-13T23:01:41Z

This could be a viable plan: * in 2.x, that API is deprecated (we still don't want people to do `get_class()` on proxies), and we remove the warning * In 3.x, we change the implementation to be compatible with the new proxy naming, we deprecate it and we add a warning * In 4.x, we drop that API

…

On Wed, 13 Mar 2019, 23:45 Terje Bråten, ***@***.***> wrote: @Ocramius <https://github.com/Ocramius> You said "If you want, you can make ClassUtils::getRealClass() proxy through to the new API in 3.x, and then we can drop it in 4.x." Does that mean making it not deprecated in 2.x, adding a proxy for it in 3.x (which will be deprecated from the start) and then drop it in 4.x ? If that is so, that is exactly the kind of change I wanted. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#867 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAJakDj7KYxSfUQryE6NY3eKcqc_xy0-ks5vWX-KgaJpZM4bxVSu> .

TerjeBr · 2019-03-13T23:07:30Z

"is deprecated" and "remove the warning" sounds like an oxymoron to me. But as long as we agree that the deprecation warning should go in 2.x, I guess we are on the same page.

Ocramius · 2019-03-13T23:19:22Z

We assembled this document *after* picking a losing fight with `trigger_error()|, so we can change it: https://www.doctrine-project.org/policies/deprecation.html

…

On Thu, 14 Mar 2019, 00:07 Terje Bråten, ***@***.***> wrote: "is deprecated" and "remove the warning" sounds like an oxymoron to me. But as long as we agree that the deprecation warning should go in 2.x, I guess we are on the same page. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#867 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAJakFqRsYP5yS7H73Mj7R3csVkd-Bxsks5vWYSzgaJpZM4bxVSu> .

TerjeBr · 2019-03-13T23:29:16Z

Doctrine\Common\Util\ClassUtils starts with

/**
 * Class and reflection related functionality for objects that
 * might or not be proxy objects at the moment.
 *
 * @author Benjamin Eberlei <[email protected]>
 * @author Johannes Schmitt <[email protected]>
 *
 * @deprecated The ClassUtils class is deprecated.
 */
class ClassUtils
{

The annotation @deprecated triggers warnings in f.ex. PHPStorm and other smart editors.

My suggestion is that we remove the @deprecated annotation in 2.x. You may still have a comment in header that this class is/will be deprecated, but without the annotation.

Does that sound ok?

Ocramius · 2019-03-13T23:31:18Z

The annotation has no runtime effects, and the intention for this API to be removed is still there, which is what we'd communicate with `@deprecated`.

…

On Thu, 14 Mar 2019, 00:29 Terje Bråten, ***@***.***> wrote: Doctrine\Common\Util\ClassUtils starts with /** * Class and reflection related functionality for objects that * might or not be proxy objects at the moment. * * @author Benjamin Eberlei ***@***.***> * @author Johannes Schmitt ***@***.***> * * @deprecated The ClassUtils class is deprecated. */ class ClassUtils { The annotation @deprecated triggers warnings in f.ex. PHPStorm and other smart editors. My suggestion is that we remove the @deprecated annotation in 2.x. You may still have a comment in header that this class is/will be deprecated, but without the annotation. Does that sound ok? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#867 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAJakGob33v2uuvnBb_hGJiehh7rtkiaks5vWYnMgaJpZM4bxVSu> .

TerjeBr · 2019-03-13T23:35:01Z

As I said, the annotation has effects in my programming environment.

When I see something marked as deprecated, I always want to replace it. But it does not make sense to mark it as deprecated, when it is no sensible action the application programmer can do to replace it.

Ocramius · 2019-03-13T23:44:29Z

The correct replacement is `EntityManager#gerClassMetadata(get_class($proxy))->getName()`, now that I think of it. Want to document that? (Works also with the `ClassMetadataFactory` interface)

…

On Thu, 14 Mar 2019, 00:35 Terje Bråten, ***@***.***> wrote: As I said, the annotation has effects in my programming environment. When I see something marked as deprecated, I always want to replace it. But it does not make sense to mark it as deprecated, when it is no sensible action the application programmer can do to replace it. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#867 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAJakEJRlG-SSAM9VgTR_De3ABuJ9sdOks5vWYsmgaJpZM4bxVSu> .

TerjeBr · 2019-03-13T23:57:49Z

So, my original problem is that I have an object that may or may not be a proxy.
First we tried get_class($object) but that failed when the object was proxy instead of the real object.
Then we changed it to Doctrine\Common\Util\ClassUtils::getClass($object).

So, you are saying that the correct way to do it will be:

$em = $this->getDoctrineEntityManager();
$classname = $em->getClassMetadata(get_class($object))->getName();

Ocramius · 2019-03-13T23:58:47Z

Yes, if it is something that doctrine knows about

…

On Thu, 14 Mar 2019, 00:57 Terje Bråten, ***@***.***> wrote: So, my original problem is that I have an object that may or may not be a proxy. First we tried get_class($object) but that failed when the object was proxy instead of the real object. Then we changed it to Doctrine\Common\Util\ClassUtils::getClass($object). So, you are saying that the correct way to do it will be: $em = $this->getDoctrineEntityManager(); $classname = $em->getClassMetadata(get_class($object))->getName(); ``` — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#867 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAJakP-itXfzmTzxGejxqO6St0EKYYXLks5vWZB-gaJpZM4bxVSu> .

TerjeBr · 2019-03-14T00:01:34Z

That is a bit complicated replacement. I guess I will need to make my own Util function to contain that then.

Yes, I guess it would help if that was documented in the class where the @deprecated annotation is.

Ocramius · 2019-03-14T00:04:41Z

Could you send a PR for that, and maybe also to the upgrade notes?

…

On Thu, 14 Mar 2019, 01:01 Terje Bråten, ***@***.***> wrote: That is a bit complicated replacement. I guess I will need to make my own Util function to contain that then. Yes, I guess it would help if that was documented in the class where the @deprecated <https://github.com/deprecated> annotation is. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#867 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAJakM2UFjrQgtu9wnV_DkbRBZqWSiuhks5vWZFegaJpZM4bxVSu> .

TerjeBr · 2019-03-14T00:08:30Z

Ok, have to go now. May be tomorrow or over the weekend.

TerjeBr · 2019-03-14T00:11:04Z

Could it also be a new method in the EntityManager?
May be something like $em->getClassName($object);

Ocramius · 2019-03-14T00:14:17Z

Unlikely: the class metadata API is what this is for, and adding methods to existing classes usually leads to more bloat and BC breaks (for inheritance)

…

On Thu, 14 Mar 2019, 01:11 Terje Bråten, ***@***.***> wrote: Could it also be a new method in the EntityManager? May be something like $em->getClassName($object); — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#867 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAJakCsy_J7_eX53PNnsi3e2J0kJb9_hks5vWZOYgaJpZM4bxVSu> .

stof · 2019-03-14T11:34:49Z

AFAICT, you cannot implement your plan of making the same API available for 3.x: the proxy classname logic is configurable in ProxyManager, so you will need the EntityManager to get the actual configuration, which a static method cannot do.

So we should suggest the metadata-based call as a replacement instead, for people to migrate.

Ocramius · 2019-03-14T11:36:34Z

@stof for the 99% of scenarios, assuming the default inflector will be sufficient. For an endpoint that is going to be deprecated, this is acceptable IMO.

malarzm · 2019-03-14T14:59:43Z

There's still a chance it'll break for folks using it in 3.x though

Ocramius · 2019-03-14T15:31:49Z

Yes, that is acceptable though, IMO. Can also document it to explain that.

akomm · 2019-11-08T13:26:31Z

Is it actually safe to test for Proxy interface (doctrine common) and then \get_parent_class ?

Ocramius · 2019-11-08T13:28:43Z

That's a valid solution, but the proxy interface changes in ORM 3.x and ODM 2.x

TerjeBr mentioned this issue Mar 13, 2019

The future of Common 3.0 #826

Open

stof closed this as completed Mar 14, 2019

stof reopened this Mar 14, 2019

shadz3rg mentioned this issue Aug 30, 2019

Compatibility with doctrine/mongodb-odm v.2.0; Drop DoctrineClassUtils; dustin10/VichUploaderBundle#1026

Merged

maxhelias mentioned this issue Dec 8, 2019

Update DoctrineHelper DamienHarper/auditor-bundle#143

Merged

beberlei mentioned this issue Dec 8, 2020

Introduce proxy class name resolvers doctrine/persistence#145

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doctrine\Common\Util\ClassUtils being deprecated #867

Doctrine\Common\Util\ClassUtils being deprecated #867

TerjeBr commented Mar 13, 2019 •

edited

Loading

TerjeBr commented Mar 13, 2019

Ocramius commented Mar 13, 2019 via email

TerjeBr commented Mar 13, 2019

Ocramius commented Mar 13, 2019 via email

TerjeBr commented Mar 13, 2019

Ocramius commented Mar 13, 2019 via email

TerjeBr commented Mar 13, 2019

Ocramius commented Mar 13, 2019 via email

TerjeBr commented Mar 13, 2019 •

edited

Loading

Ocramius commented Mar 13, 2019 via email

TerjeBr commented Mar 14, 2019

Ocramius commented Mar 14, 2019 via email

TerjeBr commented Mar 14, 2019

TerjeBr commented Mar 14, 2019

Ocramius commented Mar 14, 2019 via email

stof commented Mar 14, 2019

Ocramius commented Mar 14, 2019

malarzm commented Mar 14, 2019

Ocramius commented Mar 14, 2019

akomm commented Nov 8, 2019

Ocramius commented Nov 8, 2019

Doctrine\Common\Util\ClassUtils being deprecated #867

Doctrine\Common\Util\ClassUtils being deprecated #867

Comments

TerjeBr commented Mar 13, 2019 • edited Loading

TerjeBr commented Mar 13, 2019

Ocramius commented Mar 13, 2019 via email

TerjeBr commented Mar 13, 2019

Ocramius commented Mar 13, 2019 via email

TerjeBr commented Mar 13, 2019

Ocramius commented Mar 13, 2019 via email

TerjeBr commented Mar 13, 2019

Ocramius commented Mar 13, 2019 via email

TerjeBr commented Mar 13, 2019 • edited Loading

Ocramius commented Mar 13, 2019 via email

TerjeBr commented Mar 14, 2019

Ocramius commented Mar 14, 2019 via email

TerjeBr commented Mar 14, 2019

TerjeBr commented Mar 14, 2019

Ocramius commented Mar 14, 2019 via email

stof commented Mar 14, 2019

Ocramius commented Mar 14, 2019

malarzm commented Mar 14, 2019

Ocramius commented Mar 14, 2019

akomm commented Nov 8, 2019

Ocramius commented Nov 8, 2019

TerjeBr commented Mar 13, 2019 •

edited

Loading

TerjeBr commented Mar 13, 2019 •

edited

Loading