Move is_in_array_comparison() utility method to dedicated ContextHelper + fixes
#2234
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
…elper` The `is_in_array_comparison()` utility method is only used by a small set of sniffs, so is better placed in a dedicated class. This commit moves the `is_in_array_comparison()` method and the associated `$arrayCompareFunctions` property to the new `WordPressCS\WordPress\Helpers\ContextHelper` class and starts using that class in the relevant sniffs. Related to 1465 This method will be tested via the `WordPress.Security.NonceVerification` sniff (via pre-existing and new tests).
Function names are case-insensitive. The `ContextHelper::is_in_function_call()` method already handles this correctly, but the `ContextHelper::is_in_array_comparison()` method did not, which could result in `Undefined array key` error notices. Tested by adjusting one of the tests.
…d parameters With named parameters, the function call may have two parameters, without the required `$filter_value` param being one of them. Would make for an invalid function call, but that's not the concern of this sniff. Fixed now by looking for a specific named parameter. Includes tests in the `WordPress.Security.NonceVerification` test file (which include PHP 7.3+ trailing commas in function calls).
dingo-d
approved these changes
Apr 24, 2023
GaryJones
deleted the
feature/move-is_in_array_comparison-to-helper-class
branch
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.
Move is_in_array_comparison() utility method to dedicated
ContextHelperThe
is_in_array_comparison()utility method is only used by a small set of sniffs, so is better placed in a dedicated class.This commit moves the
is_in_array_comparison()method and the associated$arrayCompareFunctionsproperty to the newWordPressCS\WordPress\Helpers\ContextHelperclass and starts using that class in the relevant sniffs.Related to #1465
This method will be tested via the
WordPress.Security.NonceVerificationsniff (via pre-existing and new tests).ContextHelper::is_in_array_comparison(): bug fix for case-insensitivity
Function names are case-insensitive. The
ContextHelper::is_in_function_call()method already handles this correctly, but theContextHelper::is_in_array_comparison()method did not, which could result inUndefined array keyerror notices.Tested by adjusting one of the tests.
ContextHelper::is_in_array_comparison(): add support for PHP 8.0 named parameters
With named parameters, the function call may have two parameters, without the required
$filter_valueparam being one of them. Would make for an invalid function call, but that's not the concern of this sniff.Fixed now by looking for a specific named parameter.
Includes tests in the
WordPress.Security.NonceVerificationtest file (which include PHP 7.3+ trailing commas in function calls).