Re: Revisiting proposal for addition of `get_class_constants()`

From: Date: Fri, 12 Jun 2020 04:31:58 +0000
Subject: Re: Revisiting proposal for addition of `get_class_constants()`
References: 1 2  Groups: php.internals 
Request: Send a blank email to internals+get-110493@lists.php.net to get a copy of this message
Hey Nikita, Thanks for the thoughts. > Could you please explain in more detail *why* we should duplicate existing reflection > functionality into free-standing functions? In terms of the *why*, there were three main reasons: 1. It aligns with the addition of the functions referenced in the original post (str_[contains|starts_with|ends_with]()), and one their stated reasons of simplifying the API for userland developers. While (new \ReflectionClass(MyClass::class))->getConstants() isn't the most difficult thing to grasp, it's not immediately clear to new developers, and is more verbose than get_class_constants(MyClass::class) 2. get_class_[methods|vars]() existing as built-in functions, creates a gap to retrieving class constants in the same way. If I start down the path of class inspection using get_class_*(), but find I can't retrieve constants in the same way, this is an inconsistency. 3. When using Reflection, accessibility is not respected as it is with the get_class family of functions. In the event that a developer is looking for constants which are accessible to the current context, there's no way (that I'm seeing, anyway) to retrieve _only_ constants accessible in the current context. > I believe the existence of functions like get_class_methods() is a historical artifact, because > they were introduced before Reflection was a thing. Unless there is a strong reason to the contrary, > I would prefer reflection functionality to stay inside Reflection... This is good background that I wasn't aware of (I knew the Reflection API was newer than the built-in functions, but not that the get_class_* functions were generally frowned upon). It does bring up 2 questions: 1. Obviously this is a much larger discussion, but is there any appetite to deprecate & remove the existing functions in favor of the Reflection API? 2. An alternative to adding get_class_constants() would be to introduce ReflectionConstant as a return type from ReflectionClass::getConstants to match ReflectionMethod & ReflectionProperty, which would solve point 3 above. Would this be a preferable approach? > You do mention performance as a benefit, but it's not immediately obvious to me which > use-cases are bottlenecked by class constant reflection. Enum implementations are the big case for this. While the libs I've looked at use an internal cache, these caches are per-request, so reflection will need to be used as many times as there are enums in a given system. Depending on the scale, this could be an appreciable amount. Obviously external caches could be leveraged, but that then requires additional development lift, instead of using battle-tested enum libs. Thanks for the thoughts, and thank you for all your work on internals! Thanks! Troy McCabe

« previous php.internals (#110493) next »