<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* ApiUtil class file.

[2] Fix | Delete

*/

[3] Fix | Delete

[4] Fix | Delete

namespace Automattic\WooCommerce\Internal;

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Helper methods for the REST API.

[8] Fix | Delete

*

[9] Fix | Delete

* Class ApiUtil

[10] Fix | Delete

*

[11] Fix | Delete

* @package Automattic\WooCommerce\Internal

[12] Fix | Delete

*/

[13] Fix | Delete

class RestApiParameterUtil {

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* Converts a create refund request from the public API format:

[17] Fix | Delete

*

[18] Fix | Delete

* [

[19] Fix | Delete

* "reason" => "",

[20] Fix | Delete

* "api_refund" => "x",

[21] Fix | Delete

* "api_restock" => "x",

[22] Fix | Delete

* "line_items" => [

[23] Fix | Delete

* "id" => "111",

[24] Fix | Delete

* "quantity" => 222,

[25] Fix | Delete

* "refund_total" => 333,

[26] Fix | Delete

* "refund_tax" => [

[27] Fix | Delete

* [

[28] Fix | Delete

* "id": "444",

[29] Fix | Delete

* "refund_total": 555

[30] Fix | Delete

* ],...

[31] Fix | Delete

* ],...

[32] Fix | Delete

* ]

[33] Fix | Delete

*

[34] Fix | Delete

* ...to the internally used format:

[35] Fix | Delete

*

[36] Fix | Delete

* [

[37] Fix | Delete

* "reason" => null, (if it's missing or any empty value, set as null)

[38] Fix | Delete

* "api_refund" => true, (if it's missing or non-bool, set as "true")

[39] Fix | Delete

* "api_restock" => true, (if it's missing or non-bool, set as "true")

[40] Fix | Delete

* "line_items" => [ (convert sequential array to associative based on "id")

[41] Fix | Delete

* "111" => [

[42] Fix | Delete

* "qty" => 222, (rename "quantity" to "qty")

[43] Fix | Delete

* "refund_total" => 333,

[44] Fix | Delete

* "refund_tax" => [ (convert sequential array to associative based on "id" and "refund_total)

[45] Fix | Delete

* "444" => 555,...

[46] Fix | Delete

* ],...

[47] Fix | Delete

* ]

[48] Fix | Delete

* ]

[49] Fix | Delete

*

[50] Fix | Delete

* It also calculates the amount if missing and whenever possible, see maybe_calculate_refund_amount_from_line_items.

[51] Fix | Delete

*

[52] Fix | Delete

* The conversion is done in a way that if the request is already in the internal format,

[53] Fix | Delete

* then nothing is changed for compatibility. For example, if the line items array

[54] Fix | Delete

* is already an associative array or any of its elements

[55] Fix | Delete

* is missing the "id" key, then the entire array is left unchanged.

[56] Fix | Delete

* Same for the "refund_tax" array inside each line item.

[57] Fix | Delete

*

[58] Fix | Delete

* @param \WP_REST_Request $request The request to adjust.

[59] Fix | Delete

*/

[60] Fix | Delete

public static function adjust_create_refund_request_parameters( \WP_REST_Request &$request ) {

[61] Fix | Delete

if ( empty( $request['reason'] ) ) {

[62] Fix | Delete

$request['reason'] = null;

[63] Fix | Delete

}

[64] Fix | Delete

[65] Fix | Delete

if ( ! is_bool( $request['api_refund'] ) ) {

[66] Fix | Delete

$request['api_refund'] = true;

[67] Fix | Delete

}

[68] Fix | Delete

[69] Fix | Delete

if ( ! is_bool( $request['api_restock'] ) ) {

[70] Fix | Delete

$request['api_restock'] = true;

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

if ( empty( $request['line_items'] ) ) {

[74] Fix | Delete

$request['line_items'] = array();

[75] Fix | Delete

} else {

[76] Fix | Delete

$request['line_items'] = self::adjust_line_items_for_create_refund_request( $request['line_items'] );

[77] Fix | Delete

}

[78] Fix | Delete

[79] Fix | Delete

if ( ! isset( $request['amount'] ) ) {

[80] Fix | Delete

$amount = self::calculate_refund_amount_from_line_items( $request );

[81] Fix | Delete

if ( null !== $amount ) {

[82] Fix | Delete

$request['amount'] = strval( $amount );

[83] Fix | Delete

}

[84] Fix | Delete

}

[85] Fix | Delete

}

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* Calculate the "amount" parameter for the request based on the amounts found in line items.

[89] Fix | Delete

* This will ONLY be possible if ALL of the following is true:

[90] Fix | Delete

*

[91] Fix | Delete

* - "line_items" in the request is a non-empty array.

[92] Fix | Delete

* - All line items have a "refund_total" field with a numeric value.

[93] Fix | Delete

* - All values inside "refund_tax" in all line items are a numeric value.

[94] Fix | Delete

*

[95] Fix | Delete

* The request is assumed to be in internal format already.

[96] Fix | Delete

*

[97] Fix | Delete

* @param \WP_REST_Request $request The request to maybe calculate the total amount for.

[98] Fix | Delete

* @return number|null The calculated amount, or null if it can't be calculated.

[99] Fix | Delete

*/

[100] Fix | Delete

private static function calculate_refund_amount_from_line_items( $request ) {

[101] Fix | Delete

$line_items = $request['line_items'];

[102] Fix | Delete

[103] Fix | Delete

if ( ! is_array( $line_items ) || empty( $line_items ) ) {

[104] Fix | Delete

return null;

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

$amount = 0;

[108] Fix | Delete

[109] Fix | Delete

foreach ( $line_items as $item ) {

[110] Fix | Delete

if ( ! isset( $item['refund_total'] ) || ! is_numeric( $item['refund_total'] ) ) {

[111] Fix | Delete

return null;

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

$amount += $item['refund_total'];

[115] Fix | Delete

[116] Fix | Delete

if ( ! isset( $item['refund_tax'] ) ) {

[117] Fix | Delete

continue;

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

foreach ( $item['refund_tax'] as $tax ) {

[121] Fix | Delete

if ( ! is_numeric( $tax ) ) {

[122] Fix | Delete

return null;

[123] Fix | Delete

}

[124] Fix | Delete

$amount += $tax;

[125] Fix | Delete

}

[126] Fix | Delete

}

[127] Fix | Delete

[128] Fix | Delete

return $amount;

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

/**

[132] Fix | Delete

* Convert the line items of a refund request to internal format (see adjust_create_refund_request_parameters).

[133] Fix | Delete

*

[134] Fix | Delete

* @param array $line_items The line items to convert.

[135] Fix | Delete

* @return array The converted line items.

[136] Fix | Delete

*/

[137] Fix | Delete

private static function adjust_line_items_for_create_refund_request( $line_items ) {

[138] Fix | Delete

if ( ! is_array( $line_items ) || empty( $line_items ) || self::is_associative( $line_items ) ) {

[139] Fix | Delete

return $line_items;

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

$new_array = array();

[143] Fix | Delete

foreach ( $line_items as $item ) {

[144] Fix | Delete

if ( ! isset( $item['id'] ) ) {

[145] Fix | Delete

return $line_items;

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

if ( isset( $item['quantity'] ) && ! isset( $item['qty'] ) ) {

[149] Fix | Delete

$item['qty'] = $item['quantity'];

[150] Fix | Delete

}

[151] Fix | Delete

unset( $item['quantity'] );

[152] Fix | Delete

[153] Fix | Delete

if ( isset( $item['refund_tax'] ) ) {

[154] Fix | Delete

$item['refund_tax'] = self::adjust_taxes_for_create_refund_request_line_item( $item['refund_tax'] );

[155] Fix | Delete

}

[156] Fix | Delete

[157] Fix | Delete

$id = $item['id'];

[158] Fix | Delete

$new_array[ $id ] = $item;

[159] Fix | Delete

[160] Fix | Delete

unset( $new_array[ $id ]['id'] );

[161] Fix | Delete

}

[162] Fix | Delete

[163] Fix | Delete

return $new_array;

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

/**

[167] Fix | Delete

* Adjust the taxes array from a line item in a refund request, see adjust_create_refund_parameters.

[168] Fix | Delete

*

[169] Fix | Delete

* @param array $taxes_array The array to adjust.

[170] Fix | Delete

* @return array The adjusted array.

[171] Fix | Delete

*/

[172] Fix | Delete

private static function adjust_taxes_for_create_refund_request_line_item( $taxes_array ) {

[173] Fix | Delete

if ( ! is_array( $taxes_array ) || empty( $taxes_array ) || self::is_associative( $taxes_array ) ) {

[174] Fix | Delete

return $taxes_array;

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

$new_array = array();

[178] Fix | Delete

foreach ( $taxes_array as $item ) {

[179] Fix | Delete

if ( ! isset( $item['id'] ) || ! isset( $item['refund_total'] ) ) {

[180] Fix | Delete

return $taxes_array;

[181] Fix | Delete

}

[182] Fix | Delete

[183] Fix | Delete

$id = $item['id'];

[184] Fix | Delete

$refund_total = $item['refund_total'];

[185] Fix | Delete

$new_array[ $id ] = $refund_total;

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

return $new_array;

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

/**

[192] Fix | Delete

* Is an array sequential or associative?

[193] Fix | Delete

*

[194] Fix | Delete

* @param array $the_array The array to check.

[195] Fix | Delete

* @return bool True if the array is associative, false if it's sequential.

[196] Fix | Delete

*/

[197] Fix | Delete

private static function is_associative( array $the_array ) {

[198] Fix | Delete

return array_keys( $the_array ) !== range( 0, count( $the_array ) - 1 );

[199] Fix | Delete

}

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete