(REF) dev/core#1744 - Cleanup event naming #17240
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This is a cleanup in that it consolidates the code-style by which certain events are organized.
Discussion/rationale: https://lab.civicrm.org/dev/core/-/issues/1744
Before
For any given event, there are up to 3 distinct names -- the class-name (eg
TokenRegisterEvent
), the event-name (egcivi.token.list
), and the constant-name (egTOKEN_REGISTER
).The usage of event-name vs constant-name is inconsistent. You find numerous examples of both these formulations in
civicrm-core
After
The constants are mostly removed/deprecated. This string-literal formulation is canonical:
Technical Details
Normalizing/consolidating this involved a few changes:
@deprecated
, but retain it for any third-party code or any unrecognized edge-cases.TOKEN_REGISTER
) and a class (TokenRegisterEvent
). Docblocks describing the event could be on either. Any docblocks on the constant have been moved into the corresponding class.