Merge pull request #5928 from tfirdaus/fix/5542-boolean-output

swissspidy · web-flow · commit 46051eac0386 · 2024-04-26T10:35:05.000+02:00
diff --git a/features/formatter.feature b/features/formatter.feature
@@ -153,3 +153,41 @@ Feature: Format output
       | [33mgaa/gaa-log[0m      | *          | [32m✔[0m      |
       | [33mgaa/gaa-nonsense[0m | v3.0.11    | [31m🛇[0m      |
       | [33mgaa/gaa-100%new[0m  | v100%new   | [32m✔[0m      |
+
+  Scenario: Format data with boolean value
+    Given an empty directory
+    And a file.php file:
+      """
+      <?php
+      $items = array(
+        array(
+          'id' => 1,
+          'status' => true,
+          'object' => new stdClass(),
+          'number' => 10,
+          'string' => 'foo',
+        ),
+        array(
+          'id' => 2,
+          'status' => false,
+          'object' => new stdClass(),
+          'number' => 20,
+          'string' => 'bar',
+        ),
+      );
+      $iterator = \WP_CLI\Utils\iterator_map(
+          $items,
+          function (array $item) {
+              return $item;
+          }
+      );
+      $assoc_args = array( 'format' => 'table' );
+      $formatter = new WP_CLI\Formatter( $assoc_args, array( 'id', 'status', 'object', 'number', 'string' ) );
+      $formatter->display_items($iterator);
+      """
+
+    When I run `wp eval-file file.php --skip-wordpress`
+    Then STDOUT should be a table containing rows:
+      | id | status | object | number | string |
+      | 1  | true   | {}     | 10     | foo    |
+      | 2  | false  | {}     | 20     | bar    |
diff --git a/php/WP_CLI/Formatter.php b/php/WP_CLI/Formatter.php
@@ -347,7 +347,7 @@ private function assoc_array_to_rows( $fields ) {
 	}
 
 	/**
-	 * Transforms objects and arrays to JSON as necessary
+	 * Transforms into shell-friendly output, as necessary
 	 *
 	 * @param mixed $item
 	 * @return mixed
@@ -356,12 +356,28 @@ public function transform_item_values_to_json( $item ) {
 		foreach ( $this->args['fields'] as $field ) {
 			$true_field = $this->find_item_key( $item, $field );
 			$value      = is_object( $item ) ? $item->$true_field : $item[ $true_field ];
+
+			// Transform into JSON.
 			if ( is_array( $value ) || is_object( $value ) ) {
 				if ( is_object( $item ) ) {
 					$item->$true_field = json_encode( $value );
 				} elseif ( is_array( $item ) ) {
 					$item[ $true_field ] = json_encode( $value );
 				}
+
+				continue;
+			}
+
+			// Transform boolean.
+			// See: https://github.com/wp-cli/wp-cli/issues/5542
+			if ( is_bool( $value ) ) {
+				if ( is_object( $item ) ) {
+					$item->$true_field = $value ? 'true' : 'false';
+				} elseif ( is_array( $item ) ) {
+					$item[ $true_field ] = $value ? 'true' : 'false';
+				}
+
+				continue;
 			}
 		}
 		return $item;
