<?php

[0] Fix | Delete

[1] Fix | Delete

declare(strict_types=1);

[2] Fix | Delete

[3] Fix | Delete

namespace Automattic\WooCommerce\Blocks\Utils;

[4] Fix | Delete

[5] Fix | Delete

use InvalidArgumentException;

[6] Fix | Delete

use Automattic\WooCommerce\Blocks\Package;

[7] Fix | Delete

use Automattic\WooCommerce\Blocks\Domain\Services\Hydration;

[8] Fix | Delete

[9] Fix | Delete

/**

[10] Fix | Delete

* Manages the registration of interactivity config and state that is commonly shared by WooCommerce blocks.

[11] Fix | Delete

* Initialization only happens on the first call to load_store_config.

[12] Fix | Delete

*

[13] Fix | Delete

* This is a private API and may change in future versions.

[14] Fix | Delete

*/

[15] Fix | Delete

class BlocksSharedState {

[16] Fix | Delete

[17] Fix | Delete

/**

[18] Fix | Delete

* The consent statement for using private APIs of this class.

[19] Fix | Delete

*

[20] Fix | Delete

* @var string

[21] Fix | Delete

*/

[22] Fix | Delete

private static string $consent_statement = 'I acknowledge that using private APIs means my theme or plugin will inevitably break in the next version of WooCommerce';

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* The namespace for the config.

[26] Fix | Delete

*

[27] Fix | Delete

* @var string

[28] Fix | Delete

*/

[29] Fix | Delete

private static string $settings_namespace = 'woocommerce';

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Whether the core config has been registered.

[33] Fix | Delete

*

[34] Fix | Delete

* @var bool

[35] Fix | Delete

*/

[36] Fix | Delete

private static bool $core_config_registered = false;

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Cart state.

[40] Fix | Delete

*

[41] Fix | Delete

* @var array|null

[42] Fix | Delete

*/

[43] Fix | Delete

private static ?array $blocks_shared_cart_state = null;

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* Prevent caching on certain pages.

[47] Fix | Delete

*

[48] Fix | Delete

* @return void

[49] Fix | Delete

*/

[50] Fix | Delete

private static function prevent_cache(): void {

[51] Fix | Delete

\WC_Cache_Helper::set_nocache_constants();

[52] Fix | Delete

nocache_headers();

[53] Fix | Delete

}

[54] Fix | Delete

[55] Fix | Delete

/**

[56] Fix | Delete

* Check that the consent statement was passed.

[57] Fix | Delete

*

[58] Fix | Delete

* @param string $consent_statement The consent statement string.

[59] Fix | Delete

* @return true

[60] Fix | Delete

* @throws InvalidArgumentException If the statement does not match.

[61] Fix | Delete

*/

[62] Fix | Delete

private static function check_consent( string $consent_statement ): bool {

[63] Fix | Delete

if ( $consent_statement !== self::$consent_statement ) {

[64] Fix | Delete

throw new InvalidArgumentException( 'This method cannot be called without consenting the API may change.' );

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

return true;

[68] Fix | Delete

}

[69] Fix | Delete

[70] Fix | Delete

/**

[71] Fix | Delete

* Load store config (currency, locale, core data) into interactivity config.

[72] Fix | Delete

*

[73] Fix | Delete

* @param string $consent_statement The consent statement string.

[74] Fix | Delete

* @return void

[75] Fix | Delete

* @throws InvalidArgumentException If consent statement doesn't match.

[76] Fix | Delete

*/

[77] Fix | Delete

public static function load_store_config( string $consent_statement ): void {

[78] Fix | Delete

self::check_consent( $consent_statement );

[79] Fix | Delete

[80] Fix | Delete

if ( self::$core_config_registered ) {

[81] Fix | Delete

return;

[82] Fix | Delete

}

[83] Fix | Delete

[84] Fix | Delete

self::$core_config_registered = true;

[85] Fix | Delete

[86] Fix | Delete

wp_interactivity_config( self::$settings_namespace, self::get_currency_data() );

[87] Fix | Delete

wp_interactivity_config( self::$settings_namespace, self::get_locale_data() );

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

/**

[91] Fix | Delete

* Load cart state into interactivity state.

[92] Fix | Delete

*

[93] Fix | Delete

* @param string $consent_statement The consent statement string.

[94] Fix | Delete

* @return void

[95] Fix | Delete

* @throws InvalidArgumentException If consent statement doesn't match.

[96] Fix | Delete

*/

[97] Fix | Delete

public static function load_cart_state( string $consent_statement ): void {

[98] Fix | Delete

self::check_consent( $consent_statement );

[99] Fix | Delete

[100] Fix | Delete

if ( null === self::$blocks_shared_cart_state ) {

[101] Fix | Delete

$cart_exists = isset( WC()->cart );

[102] Fix | Delete

$cart_has_contents = $cart_exists && ! WC()->cart->is_empty();

[103] Fix | Delete

if ( $cart_exists ) {

[104] Fix | Delete

$cart_response = Package::container()->get( Hydration::class )->get_rest_api_response_data( '/wc/store/v1/cart' );

[105] Fix | Delete

self::$blocks_shared_cart_state = $cart_response['body'] ?? array();

[106] Fix | Delete

} else {

[107] Fix | Delete

self::$blocks_shared_cart_state = array();

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

if ( $cart_has_contents ) {

[111] Fix | Delete

self::prevent_cache();

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

wp_interactivity_state(

[115] Fix | Delete

'woocommerce',

[116] Fix | Delete

array(

[117] Fix | Delete

'cart' => self::$blocks_shared_cart_state,

[118] Fix | Delete

'nonce' => wp_create_nonce( 'wc_store_api' ),

[119] Fix | Delete

'noticeId' => '',

[120] Fix | Delete

'restUrl' => get_rest_url(),

[121] Fix | Delete

)

[122] Fix | Delete

);

[123] Fix | Delete

}

[124] Fix | Delete

}

[125] Fix | Delete

[126] Fix | Delete

/**

[127] Fix | Delete

* Get currency data to include in settings.

[128] Fix | Delete

*

[129] Fix | Delete

* @return array

[130] Fix | Delete

*/

[131] Fix | Delete

private static function get_currency_data(): array {

[132] Fix | Delete

$currency = get_woocommerce_currency();

[133] Fix | Delete

[134] Fix | Delete

return array(

[135] Fix | Delete

'currency' => array(

[136] Fix | Delete

'code' => $currency,

[137] Fix | Delete

'precision' => wc_get_price_decimals(),

[138] Fix | Delete

'symbol' => html_entity_decode( get_woocommerce_currency_symbol( $currency ) ),

[139] Fix | Delete

'symbolPosition' => get_option( 'woocommerce_currency_pos' ),

[140] Fix | Delete

'decimalSeparator' => wc_get_price_decimal_separator(),

[141] Fix | Delete

'thousandSeparator' => wc_get_price_thousand_separator(),

[142] Fix | Delete

'priceFormat' => html_entity_decode( get_woocommerce_price_format() ),

[143] Fix | Delete

),

[144] Fix | Delete

);

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete

/**

[148] Fix | Delete

* Get locale data to include in settings.

[149] Fix | Delete

*

[150] Fix | Delete

* @return array

[151] Fix | Delete

*/

[152] Fix | Delete

private static function get_locale_data(): array {

[153] Fix | Delete

global $wp_locale;

[154] Fix | Delete

[155] Fix | Delete

return array(

[156] Fix | Delete

'locale' => array(

[157] Fix | Delete

'siteLocale' => get_locale(),

[158] Fix | Delete

'userLocale' => get_user_locale(),

[159] Fix | Delete

'weekdaysShort' => array_values( $wp_locale->weekday_abbrev ),

[160] Fix | Delete

),

[161] Fix | Delete

);

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

/**

[165] Fix | Delete

* Load placeholder image into interactivity config.

[166] Fix | Delete

*

[167] Fix | Delete

* @param string $consent_statement The consent statement string.

[168] Fix | Delete

* @return void

[169] Fix | Delete

* @throws InvalidArgumentException If consent statement doesn't match.

[170] Fix | Delete

*/

[171] Fix | Delete

public static function load_placeholder_image( string $consent_statement ): void {

[172] Fix | Delete

self::check_consent( $consent_statement );

[173] Fix | Delete

[174] Fix | Delete

wp_interactivity_config(

[175] Fix | Delete

self::$settings_namespace,

[176] Fix | Delete

array( 'placeholderImgSrc' => wc_placeholder_img_src() )

[177] Fix | Delete

);

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

/**

[181] Fix | Delete

* Get cart errors formatted as notices for the store-notices interactivity store.

[182] Fix | Delete

*

[183] Fix | Delete

* Returns errors from the hydrated cart state in the format expected by

[184] Fix | Delete

* the store-notices store context.

[185] Fix | Delete

*

[186] Fix | Delete

* @param string $consent_statement The consent statement string.

[187] Fix | Delete

* @return array Array of notices with id, notice, type, and dismissible keys.

[188] Fix | Delete

* @throws InvalidArgumentException If consent statement doesn't match.

[189] Fix | Delete

*/

[190] Fix | Delete

public static function get_cart_error_notices( string $consent_statement ): array {

[191] Fix | Delete

self::check_consent( $consent_statement );

[192] Fix | Delete

[193] Fix | Delete

// Ensure cart state is loaded so this method works independently.

[194] Fix | Delete

if ( null === self::$blocks_shared_cart_state ) {

[195] Fix | Delete

self::load_cart_state( $consent_statement );

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

$errors = self::$blocks_shared_cart_state['errors'] ?? array();

[199] Fix | Delete

$notices = array();

[200] Fix | Delete

[201] Fix | Delete

foreach ( $errors as $error ) {

[202] Fix | Delete

$notices[] = array(

[203] Fix | Delete

'id' => wp_unique_id( 'store-notice-' ),

[204] Fix | Delete

'notice' => $error['message'] ?? '',

[205] Fix | Delete

'type' => 'error',

[206] Fix | Delete

'dismissible' => true,

[207] Fix | Delete

);

[208] Fix | Delete

}

[209] Fix | Delete

[210] Fix | Delete

return $notices;

[211] Fix | Delete

}

[212] Fix | Delete

}

[213] Fix | Delete

[214] Fix | Delete