[REF] Add a note in documentation of CRM_Utils_Mail::send to clarify … #26803
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…array keys are case specific and replace some CRM_Utils_Array::value
|
Thank you for contributing to CiviCRM! ❤️ We will need to test and review the PR. 👷 Introduction for new contributors
Quick links for reviewers |
| @@ -223,10 +224,10 @@ public static function send(array &$params): bool { | |||
| $headers['Content-Type'] = $htmlMessage ? 'multipart/mixed; charset=utf-8' : 'text/plain; charset=utf-8'; | |||
| $headers['Content-Disposition'] = 'inline'; | |||
| $headers['Content-Transfer-Encoding'] = '8bit'; | |||
| $headers['Return-Path'] = CRM_Utils_Array::value('returnPath', $params, $defaultReturnPath); | |||
| $headers['Return-Path'] = $params['returnPath'] ?? $defaultReturnPath; | |||
There was a problem hiding this comment.
When there's a 3rd param it's not always a 1-1 swap so just need to consciously think about null (philosophy question: Is it physically possible to think about nothing?). This case is ok, and probably more like what was actually intended originally, e.g. before null would result in null, whereas now it's more like you might expect:
$params['returnPath'] = NULL;
var_dump(CRM_Utils_Array::value('returnPath', $params, '[email protected]'));
var_dump($params['returnPath'] ?? '[email protected]');outputs:
NULL
string(20) "[email protected]"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
…array keys are case specific and replace some CRM_Utils_Array::value
Overview
This adds a note to clarify that the array_keys of the params are case specific and replace some CRM_Utils_Array
Before
Documentation isn't that clear that the keys are case specific
After
Documentation is clearer and deprecated code style removed
ping @colemanw @demeritcowboy