96: Fix output formats for the theme mod get command

Author: philipjohn

src/Theme_Mod_Command.php

@@ -85,51 +85,109 @@ public function get( $args = array(), $assoc_args = array() ) {
 			$args = array();
 		}
 
+		// This array will hold the list of theme mods in a format suitable for the WP CLI Formatter.
 		$list = array();
-		$mods = get_theme_mods();
+
+		// If specific mods are requested, filter out any that aren't requested.
+		$mods = ! empty( $args ) ? array_intersect_key( get_theme_mods(), array_flip( $args ) ) : get_theme_mods();
 		if ( ! is_array( $mods ) ) {
-			// If no mods are set (perhaps new theme), make sure foreach still works.
+			// If no mods are set (perhaps new theme), make sure array_intersect_key still works.
 			$mods = array();
 		}
-		foreach ( $mods as $k => $v ) {
-			// If mods were given, skip the others.
-			if ( ! empty( $args ) && ! in_array( $k, $args, true ) ) {
-				continue;
-			}
 
-			if ( is_array( $v ) ) {
-				$list[] = [
-					'key'   => $k,
-					'value' => '=>',
-				];
-				foreach ( $v as $_k => $_v ) {
-					$list[] = [
-						'key'   => "    $_k",
-						'value' => $_v,
-					];
-				}
-			} else {
-				$list[] = [
-					'key'   => $k,
-					'value' => $v,
-				];
+		// Generate the list of items ready for output. We use an initial separator that we can replace later depending on format.
+		$separator = '!!!';
+		array_walk(
+			$mods,
+			function( $value, $key ) use ( &$list, $separator ) {
+				$this->mod_to_string( $key, $value, $list, $separator );
 			}
-		}
+		);
 
-		// For unset mods, show blank value.
-		foreach ( $args as $mod ) {
-			if ( ! isset( $mods[ $mod ] ) ) {
-				$list[] = [
-					'key'   => $mod,
-					'value' => '',
-				];
-			}
+		// Take our Formatter-friendly list and adjust it according to the requested format.
+		switch ( \WP_CLI\Utils\get_flag_value( $assoc_args, 'format' ) ) {
+			// For tables we use a double space to indent child items.
+			case 'table':
+				$list = array_map(
+					function( $item ) {
+						$parts   = explode( '!!!', $item['key'] );
+						$new_key = array_pop( $parts );
+						if ( ! empty( $parts ) ) {
+							$new_key = str_repeat( '  ', count( $parts ) ) . $new_key;
+						}
+						return [
+							'key'   => $new_key,
+							'value' => $item['value'],
+						];
+					},
+					$list
+				);
+				break;
+
+			// For JSON, CSV, and YAML formats we use dot notation to show the hierarchy.
+			case 'csv':
+			case 'yaml':
+			case 'json':
+				$list = array_filter( array_map(
+					function( $item ) {
+						return [
+							'key'   => str_replace( '!!!', '.', $item['key'] ),
+							'value' => $item['value'],
+						];
+					},
+					$list
+				), function( $item ) {
+					return ! empty( $item['value'] );
+				} );
+				break;
 		}
 
+		// Output the list using the WP CLI Formatter.
 		$formatter = new \WP_CLI\Formatter( $assoc_args, $this->fields, 'thememods' );
 		$formatter->display_items( $list );
 	}
 
+	/**
+	 * Convert the theme mods to a flattened array with a string representation of the keys.
+	 *
+	 * @param string $key       The mod key
+	 * @param mixed  $value     The value of the mod.
+	 * @param array  $list      The list so far, passed by reference.
+	 * @param string $separator A string to separate keys to denote their place in the tree.
+	 */
+	private function mod_to_string( $key, $value, &$list, $separator ) {
+		if ( is_array( $value ) ){
+			if ( empty( $value ) ) {
+				// Explicitly handle empty arrays to ensure they are displayed.
+				$list[] = array(
+					'key'   => $key,
+					'value' => '[empty array]',
+				);
+				return;
+			}
+
+			// Arrays get their own entry in the list to allow for sensible table output.
+			$list[] = array(
+				'key'   => $key,
+				'value' => '',
+			);
+
+			foreach ( $value as $child_key => $child_value ) {
+				$this->mod_to_string( $key . $separator . $child_key, $child_value, $list, $separator );
+			}
+		} else {
+			// Explicitly handle false values to ensure they are displayed.
+			if ( false === $value ) {
+				$value = '[false]';
+			}
+
+			$list[] = array(
+				'key'   => $key,
+				'value' => $value,
+			);
+		}
+	}
+
 	/**
 	 * Gets a list of theme mods.
 	 *