Skip to content

Commit

Permalink
Code Modernization: Allow some parameters with reserved keywords in `…
Browse files Browse the repository at this point in the history
…wp-includes/class-wp-text-diff-renderer-*.php`.

This commit adds inline comments instructing PHPCS to ignore parameters with reserved keywords in the affected methods that should not be renamed:
* `$string` parameter in `WP_Text_Diff_Renderer_inline::_splitOnWords()`
* `$final` parameter in `WP_Text_Diff_Renderer_Table::_changed()` and `::interleave_changed_lines()`

This resolves a few WPCS warnings along the lines of:
{{{
It is recommended not to use reserved keyword "string" as function parameter name. Found: $string
It is recommended not to use reserved keyword "final" as function parameter name. Found: $final
}}}

The two `WP_Text_Diff_Renderer_*` classes in question extend the `Text_Diff_Renderer_inline` and `Text_Diff_Renderer` classes from the `Text_Diff` package and should have the same parameters as the parent class methods, per the Task 1 section of ticket #51553.

The `Text_Diff` library currently included in WordPress core is no longer kept in sync with the upstream project and can be considered “adopted”, so the `$string` and `$final` parameters in the  parent class methods can technically be renamed, e.g. to `$input_string` and `$modified`, respectively.

However, the “final” wording is also used to represent modified content in other parts the library, so it is more internally consistent to keep these parameters as is for now.

Follow-up to [7747], [38352], [55136].

See #56788.

git-svn-id: https://develop.svn.wordpress.org/trunk@55163 602fd350-edb4-49c9-b593-d223f7449a82
  • Loading branch information
SergeyBiryukov committed Jan 30, 2023
1 parent 51e9aed commit b74cfa8
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion src/wp-includes/class-wp-text-diff-renderer-inline.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class WP_Text_Diff_Renderer_inline extends Text_Diff_Renderer_inline {
* @param string $newlineEscape
* @return string
*/
public function _splitOnWords( $string, $newlineEscape = "\n" ) {
public function _splitOnWords( $string, $newlineEscape = "\n" ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.stringFound
$string = str_replace( "\0", '', $string );
$words = preg_split( '/([^\w])/u', $string, -1, PREG_SPLIT_DELIM_CAPTURE );
$words = str_replace( "\n", $newlineEscape, $words );
Expand Down
4 changes: 2 additions & 2 deletions src/wp-includes/class-wp-text-diff-renderer-table.php
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ public function _context( $lines, $encode = true ) {
* @param array $final
* @return string
*/
public function _changed( $orig, $final ) {
public function _changed( $orig, $final ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.finalFound
$r = '';

/*
Expand Down Expand Up @@ -358,7 +358,7 @@ public function _changed( $orig, $final ) {
* Value < 0 indicates a blank row.
* }
*/
public function interleave_changed_lines( $orig, $final ) {
public function interleave_changed_lines( $orig, $final ) { // phpcs:ignore Universal.NamingConventions.NoReservedKeywordParameterNames.finalFound

// Contains all pairwise string comparisons. Keys are such that this need only be a one dimensional array.
$matches = array();
Expand Down

0 comments on commit b74cfa8

Please sign in to comment.