WC_REST_Coupons_V2_Controller::get_formatted_item_data() │ protected │ WC 3.0.0

Get formatted item data.

Method of the class: WC_REST_Coupons_V2_Controller{}

No Hooks.

Return

Array.

Usage

// protected - for code of main (parent) or child class
$result = $this->get_formatted_item_data( $object );

$object(WC_Data) (required)

WC_Data instance.

Changelog

WC_REST_Coupons_V2_Controller::get_formatted_item_data() WC REST Coupons V2 Controller::get formatted item data code ^{WC 7.7.0}

protected function get_formatted_item_data( $object ) {
	$data = $object->get_data();

	$format_decimal = array( 'amount', 'minimum_amount', 'maximum_amount' );
	$format_date    = array( 'date_created', 'date_modified', 'date_expires' );
	$format_null    = array( 'usage_limit', 'usage_limit_per_user', 'limit_usage_to_x_items' );

	// Format decimal values.
	foreach ( $format_decimal as $key ) {
		$data[ $key ] = wc_format_decimal( $data[ $key ], 2 );
	}

	// Format date values.
	foreach ( $format_date as $key ) {
		$datetime              = $data[ $key ];
		$data[ $key ]          = wc_rest_prepare_date_response( $datetime, false );
		$data[ $key . '_gmt' ] = wc_rest_prepare_date_response( $datetime );
	}

	// Format null values.
	foreach ( $format_null as $key ) {
		$data[ $key ] = $data[ $key ] ? $data[ $key ] : null;
	}

	return array(
		'id'                          => $object->get_id(),
		'code'                        => $data['code'],
		'amount'                      => $data['amount'],
		'status'                      => $data['status'],
		'date_created'                => $data['date_created'],
		'date_created_gmt'            => $data['date_created_gmt'],
		'date_modified'               => $data['date_modified'],
		'date_modified_gmt'           => $data['date_modified_gmt'],
		'discount_type'               => $data['discount_type'],
		'description'                 => $data['description'],
		'date_expires'                => $data['date_expires'],
		'date_expires_gmt'            => $data['date_expires_gmt'],
		'usage_count'                 => $data['usage_count'],
		'individual_use'              => $data['individual_use'],
		'product_ids'                 => $data['product_ids'],
		'excluded_product_ids'        => $data['excluded_product_ids'],
		'usage_limit'                 => $data['usage_limit'],
		'usage_limit_per_user'        => $data['usage_limit_per_user'],
		'limit_usage_to_x_items'      => $data['limit_usage_to_x_items'],
		'free_shipping'               => $data['free_shipping'],
		'product_categories'          => $data['product_categories'],
		'excluded_product_categories' => $data['excluded_product_categories'],
		'exclude_sale_items'          => $data['exclude_sale_items'],
		'minimum_amount'              => $data['minimum_amount'],
		'maximum_amount'              => $data['maximum_amount'],
		'email_restrictions'          => $data['email_restrictions'],
		'used_by'                     => $data['used_by'],
		'meta_data'                   => $data['meta_data'],
	);
}