[REF] Cleanup uses of CRM_Utils_Array::value related to numbers #16778
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
|
(Standard links)
|
colemanw
commented
Mar 15, 2020
| @@ -341,7 +341,7 @@ public static function recipientListing() { | |||
| * Used by jstree to incrementally load tags | |||
| */ | |||
| public static function getTagTree() { | |||
| $parent = CRM_Utils_Type::escape(CRM_Utils_Array::value('parent_id', $_GET, 0), 'Integer'); | |||
| $parent = CRM_Utils_Type::escape(($_GET['parent_id'] ?? 0), 'Integer'); | |||
There was a problem hiding this comment.
Before/after should work the same given that it's being passed into CRM_Utils_Type::escape()
colemanw
commented
Mar 15, 2020
| @@ -373,7 +373,6 @@ public static function buildAdminLinks(&$menu) { | |||
| $values[$item['adminGroup']] = array(); | |||
| $values[$item['adminGroup']]['fields'] = array(); | |||
| } | |||
| $weight = CRM_Utils_Array::value('weight', $item, 0); | |||
There was a problem hiding this comment.
This variable was unused.
colemanw
commented
Mar 15, 2020
| $params['name'], | ||
| CRM_Utils_Array::value('addSequence', $params, 0) | ||
| ); | ||
| return CRM_Core_Key::get($params['name'], $params['addSequence'] ?? FALSE); |
There was a problem hiding this comment.
This is better because CRM_Core_Key::get() expects a boolean not an int.
colemanw
commented
Mar 15, 2020
| $is_count = $params['options']['is_count'] ?? FALSE; | ||
| $offset = $params['options']['offset'] ?? $offset; | ||
| $limit = CRM_Utils_Array::value('limit', $params['options'], $limit); | ||
| $sort = $params['options']['sort'] ?? $sort; |
There was a problem hiding this comment.
I left $limit alone here b/c there are more edge cases around a non-falsey default of 25. But defaulting to 0 is pretty simple with coalesce.
colemanw
commented
Mar 15, 2020
| elseif (in_array($n, $otherVars)) { | ||
| } | ||
| else { | ||
| elseif (!in_array($n, $otherVars)) { |
Some manual cleanup around the areas of code where CRM_Utils_Array::value is used for a number defaulting to 0
colemanw
commented
Mar 15, 2020
| @@ -73,7 +73,7 @@ function _civicrm_api3_dashboard_contact_create_spec(&$params) { | |||
| function _civicrm_api3_dashboard_contact_check_params(&$params) { | |||
| $dashboard_id = CRM_Utils_Array::value('dashboard_id', $params); | |||
| if ($dashboard_id) { | |||
| $allDashlets = CRM_Core_BAO_Dashboard::getDashlets(TRUE, CRM_Utils_Array::value('check_permissions', $params, 0)); | |||
| $allDashlets = CRM_Core_BAO_Dashboard::getDashlets(TRUE, $params['check_permissions'] ?? FALSE); | |||
There was a problem hiding this comment.
Better because CRM_Core_BAO_Dashboard::getDashlets() expects a boolean not an int.
|
OK - I managed to work through these & they all make sense - merging |
|
Thanks @eileenmcnaughton! |
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.
Overview
Some manual cleanup around the areas of code where CRM_Utils_Array::value is used for a number defaulting to 0. Fixes test failures in #16768.
Before
Messier code.
After
Neater code.
Technical Details
This was manual cleanup, not regex find/replace. The expressions are not always identical before/after, but should work the same in their particular contexts of possible inputs and expected outputs.