Remove GuardEvent::getContext() method and add HasContextTrait trait
#51493
Conversation
e9c9d72 to
16b7e82
Compare
| */ | ||
| trait HasContextTrait | ||
| { | ||
| private array $context = []; |
There was a problem hiding this comment.
I made the property private instead of protected as all concrete classes using this trait are already all final. Although it may be a potential BC break, it should not as event classes are final and internal. Application code should are not supposed to extend the base abstract Event class to produce new subtypes of workflow events.
| * @author Grégoire Pineau <lyrixx@lyrixx.info> | ||
| * @author Hugo Hamon <hugohamon@neuf.fr> | ||
| * | ||
| * @internal |
There was a problem hiding this comment.
Trait is marked internal as it's not supposed to be used outside of the Workflow component itself.
| * | ||
| * @internal | ||
| */ | ||
| trait HasContextTrait |
There was a problem hiding this comment.
I'm not sure about the naming of this trait although it's purely made for an internal use. I was also thinking of naming it HoldContextTrait. Any other better suggestions are welcome and appreciated.
16b7e82 to
56e8101
Compare
GuardEvent::getContext() method and add HasContextTrait traitGuardEvent::getContext() method and add HasContextTrait trait
56e8101 to
2aee3ae
Compare
GuardEvent::getContext() method and add HasContextTrait traitGuardEvent::getContext() method and add HasContextTrait trait
|
Thank you @hhamon. |
As discussed with @lyrixx, the
GuardEvent::getContextmethod was confusing as the context given as the 3rd argument to the WorflowInterface::appy() method is never passed along to the guard events. According to @lyrixx, the guard listeners must take any decisions based on the subject itself and not on the given contextual data (which are supposed to remain metadata). As a consequence, calling theGuardEvent::getContext()method always returned an empty context array so far.To prevent this confusion any longer, the method has been deprecated in Symfony 6.4 (see #51484) and removed in this PR. The
GuardEventclass hierarchy no longer has thegetContextmethod while other event classes keep having it.