Automattic\WooCommerce\Blueprint\ResultFormatters

JsonResultFormatter::format │ public │ WC 1.0

Format the results.

Method of the class: JsonResultFormatter{}

No Hooks.

Returns

Array.

Usage

$JsonResultFormatter = new JsonResultFormatter();
$JsonResultFormatter->format( $message_type );

$message_type(string)

The message type to format.
Default: 'all'

JsonResultFormatter::format() JsonResultFormatter::format code ^{WC 9.9.5}

public function format( $message_type = 'all' ) {
	$data = array(
		'is_success' => $this->is_success(),
		'messages'   => array(),
	);

	foreach ( $this->results as $result ) {
		$step_name = $result->get_step_name();
		foreach ( $result->get_messages( $message_type ) as $message ) {
			if ( ! isset( $data['messages'][ $message['type'] ] ) ) {
				$data['messages'][ $message['type'] ] = array();
			}
			$data['messages'][ $message['type'] ][] = array(
				'step'    => $step_name,
				'type'    => $message['type'],
				'message' => $message['message'],
			);
		}
	}

	return $data;
}