Add propertyBag handling for getEmail when incoming uses email-5 #17267
Conversation
Calling code is often setting email-5. The property bag should iron out this inconsistency, and getEmail (and similar) should handle the appended billing id. We can't do this in the static property map as it is a calculated variable
|
(Standard links)
|
| $localPropertyBag = new PropertyBag(); | ||
| $localPropertyBag->mergeLegacyInputParams(['email-' . \CRM_Core_BAO_LocationType::getBilling() => 'a@b.com']); | ||
| $this->assertEquals('a@b.com', $localPropertyBag->getEmail()); | ||
| } |
There was a problem hiding this comment.
Perhaps it would be a good idea to also do
$this->assertEquals('a@b.com', $localPropertyBag['email-' . \CRM_Core_BAO_LocationType::getBilling()]);...to check the getter too. it should work because it uses the same legacy code but I assume that old code that sets it this way will also get it this way.
There was a problem hiding this comment.
Yeah - I'm on the fence about adding that - it implies it's supported but the goal is one day to only support a sensible set...
There was a problem hiding this comment.
I think adding a getter test just further confirms and documents the expectation. This PR is specifically about adding support for another legacy use case. All get/set that use array access issue a deprecation notice anyway, so I think it's still clear that it's not The Right Way, but while we're supporting hacks for legacy calls I think tests would have been an improvement. Not worth the effort of a separate PR now though.
|
This looks ok to me. It would be good to list the places where this is used in an issue so we can weed them out one day. |
|
test this please |
Overview
Update to PropertyBag to enable it to handle the fact that calling functions use some legacy params for billing fields not yet handled - ie
$params['email-5'] for Billing email.
With this change we encourage the use of setEmail but if the param was email-5 it can still be retrieved with getEmail
Before
$params['email-5'] not returned when calling getEmail
After
$params['email-5'] returned when calling getEmail
Also any other fields which match the correct field with an appended '-5' (Where 5 is the billing location ID)
Technical Details
Calling code is often setting email-5. The property bag should iron out this inconsistency, and getEmail (and similar)
should handle the appended billing id. We can't do this in the static property map as it is a calculated variable
Comments
@artfulrobot @mattwire