Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.Updated: Comment #N
Problem/Motivation
In #2195753: Changes to config entities that use plugins are not propagated to the plugins, I theorized that traits would serve us well.
Well, now that we have 5.4, I tried it, and it doesn't work at all.
First, I did not know that classes cannot redeclare a property that comes from a trait, which is pretty useless:
http://us3.php.net/language.oop5.traits#language.oop5.traits.properties
I intended to have a default $pluginConfigKey property with a sane value, and let the classes override it if needed. That way we could rely on the property in code...
But that's a fatal!
The second thing I wanted to do was make getPluginBag() protected. But @alexpott said something in IRC about this interface being very useful for finding config entity dependencies, so we want to leave this public.
Proposed resolution
Remove all of the hopeful comments about making this a trait.
Remaining tasks
N/A
User interface changes
N/A
API changes
N/A
| Comment | File | Size | Author |
|---|---|---|---|
| #5 | entitypluginbag-trait-2208015-5.patch | 2.29 KB | tim.plunkett |
| #1 | womp-womp-2208015-1.patch | 2.33 KB | tim.plunkett |
Comments
Comment #1
tim.plunkettComment #2
tim.plunkettIf I misrepresented @alexpott here, and we don't need getPluginBag() to be public, then we can make $pluginConfigKey into a protected getter and still use a trait.
Comment #3
alexpottI don't think we need getPluginBag() to be public as its usefulness in calculating config entity dependencies is when you call it from calculateDependencies() see https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Config%21... - so it is always the entity class calling it.
Comment #4
tim.plunkettSo there are three problems with class_uses():
1) It only works if the class checked uses the trait, not any parent classes (http://www.php.net/manual/en/function.class-uses.php)
2) PHPUnit doesn't support it (https://github.com/sebastianbergmann/phpunit/issues/767#issuecomment-119...)
3) Apparently class_uses() violates the Flattening Property https://wiki.php.net/rfc/horizontalreuse#the_flattening_property
Comment #5
tim.plunkettI have no idea what else to do. Just a reroll.
Comment #6
dawehnerYeah traits do actually suck in reality. Glad that everyone planned them as a tool to solve all the problems.
Comment #7
alexpottCommitted da91e5a and pushed to 8.x. Thanks!