Changeset 54959

Timestamp:

12/12/2022 07:37:43 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-includes/pomo/po.php.

While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.

This commit renames the $string parameter to $input_string in:

• PO::poify()
• PO::unpoify()
• PO::prepend_each_line()

Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947], [54948], [54950], [54951], [54952], [54956].

Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.

File:

• trunk/src/wp-includes/pomo/po.php (modified) (5 diffs)

trunk/src/wp-includes/pomo/po.php

@@ -111 +111 @@
          * Formats a string in PO-style
          *
-         * @param string $string the string to format
+         * @param string $input_string the string to format
          * @return string the poified string
          */
-        public static function poify( $string ) {
+        public static function poify( $input_string ) {
             $quote   = '"';
             $slash   = '\\';
@@ -125 +125 @@
             );
 
-            $string = str_replace( array_keys( $replaces ), array_values( $replaces ), $string );
-
-            $po = $quote . implode( "{$slash}n{$quote}{$newline}{$quote}", explode( $newline, $string ) ) . $quote;
+            $input_string = str_replace( array_keys( $replaces ), array_values( $replaces ), $input_string );
+
+            $po = $quote . implode( "{$slash}n{$quote}{$newline}{$quote}", explode( $newline, $input_string ) ) . $quote;
             // Add empty string on first line for readbility.
-            if ( false !== strpos( $string, $newline ) &&
-                ( substr_count( $string, $newline ) > 1 || substr( $string, -strlen( $newline ) ) !== $newline ) ) {
+            if ( false !== strpos( $input_string, $newline ) &&
+                ( substr_count( $input_string, $newline ) > 1 || substr( $input_string, -strlen( $newline ) ) !== $newline ) ) {
                 $po = "$quote$quote$newline$po";
             }
@@ -141 +141 @@
          * Gives back the original string from a PO-formatted string
          *
-         * @param string $string PO-formatted string
+         * @param string $input_string PO-formatted string
          * @return string enascaped string
          */
-        public static function unpoify( $string ) {
+        public static function unpoify( $input_string ) {
             $escapes               = array(
                 't'  => "\t",
@@ -151 +151 @@
                 '\\' => '\\',
             );
-            $lines                 = array_map( 'trim', explode( "\n", $string ) );
+            $lines                 = array_map( 'trim', explode( "\n", $input_string ) );
             $lines                 = array_map( array( 'PO', 'trim_quotes' ), $lines );
             $unpoified             = '';
@@ -179 +179 @@
 
         /**
-         * Inserts $with in the beginning of every new line of $string and
+         * Inserts $with in the beginning of every new line of $input_string and
          * returns the modified string
          *
-         * @param string $string prepend lines in this string
-         * @param string $with prepend lines with this string
-         */
-        public static function prepend_each_line( $string, $with ) {
-            $lines  = explode( "\n", $string );
+         * @param string $input_string prepend lines in this string
+         * @param string $with         prepend lines with this string
+         */
+        public static function prepend_each_line( $input_string, $with ) {
+            $lines  = explode( "\n", $input_string );
             $append = '';
-            if ( "\n" === substr( $string, -1 ) && '' === end( $lines ) ) {
+            if ( "\n" === substr( $input_string, -1 ) && '' === end( $lines ) ) {
                 /*
-                 * Last line might be empty because $string was terminated
+                 * Last line might be empty because $input_string was terminated
                  * with a newline, remove it from the $lines array,
                  * we'll restore state by re-terminating the string at the end.