ProductsStore.php
284 lines
| 1 | <?php |
| 2 | declare(strict_types=1); |
| 3 | |
| 4 | namespace Automattic\WooCommerce\Blocks\SharedStores; |
| 5 | |
| 6 | use Automattic\WooCommerce\Blocks\Domain\Services\Hydration; |
| 7 | use Automattic\WooCommerce\Blocks\Package; |
| 8 | use InvalidArgumentException; |
| 9 | |
| 10 | /** |
| 11 | * Shared store that hydrates the `woocommerce/products` Interactivity API |
| 12 | * store with product and variation data in Store API format. |
| 13 | * |
| 14 | * The store exposes two planes: |
| 15 | * - Raw data (`products`, `productVariations`) populated by the `load_*` |
| 16 | * methods below, each keyed by ID. |
| 17 | * - Selection (`productId`, `variationId`) — set by callers via |
| 18 | * `wp_interactivity_state` (global) or `data-wp-context` (per-element) — |
| 19 | * plus the derived getters (`mainProductInContext`, |
| 20 | * `productVariationInContext`, `productInContext`) registered by |
| 21 | * `register_getters()`. |
| 22 | * |
| 23 | * The derived getters are mirrored in the JS store |
| 24 | * (client/blocks/assets/js/base/stores/woocommerce/products.ts) so that |
| 25 | * directive bindings like `state.productInContext.sku` resolve during |
| 26 | * server-side rendering as well as on the client. |
| 27 | * |
| 28 | * See client/blocks/assets/js/base/stores/woocommerce/README.md for the |
| 29 | * full model and consumer examples. |
| 30 | * |
| 31 | * This is an experimental API and may change in future versions. |
| 32 | */ |
| 33 | class ProductsStore { |
| 34 | |
| 35 | /** |
| 36 | * The consent statement for using this experimental API. |
| 37 | * |
| 38 | * @var string |
| 39 | */ |
| 40 | private static string $consent_statement = 'I acknowledge that using experimental APIs means my theme or plugin will inevitably break in the next version of WooCommerce'; |
| 41 | |
| 42 | /** |
| 43 | * The namespace for the store. |
| 44 | * |
| 45 | * @var string |
| 46 | */ |
| 47 | private static string $store_namespace = 'woocommerce/products'; |
| 48 | |
| 49 | /** |
| 50 | * Products that have been loaded into state. |
| 51 | * |
| 52 | * @var array |
| 53 | */ |
| 54 | private static array $products = array(); |
| 55 | |
| 56 | /** |
| 57 | * Product variations that have been loaded into state. |
| 58 | * |
| 59 | * @var array |
| 60 | */ |
| 61 | private static array $product_variations = array(); |
| 62 | |
| 63 | /** |
| 64 | * Parent product IDs whose variations have already been loaded. |
| 65 | * |
| 66 | * @var array<int, true> |
| 67 | */ |
| 68 | private static array $loaded_variation_parents = array(); |
| 69 | |
| 70 | /** |
| 71 | * Whether the derived-state getters have been registered. |
| 72 | * |
| 73 | * @var bool |
| 74 | */ |
| 75 | private static bool $getters_registered = false; |
| 76 | |
| 77 | /** |
| 78 | * Check that the consent statement was passed. |
| 79 | * |
| 80 | * @param string $consent_statement The consent statement string. |
| 81 | * @return true |
| 82 | * @throws InvalidArgumentException If the statement does not match. |
| 83 | */ |
| 84 | private static function check_consent( string $consent_statement ): bool { |
| 85 | if ( $consent_statement !== self::$consent_statement ) { |
| 86 | throw new InvalidArgumentException( 'This method cannot be called without consenting that the API may change.' ); |
| 87 | } |
| 88 | |
| 89 | return true; |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * Register the derived-state getters once. |
| 94 | * |
| 95 | * These closures mirror the JS getters in |
| 96 | * client/blocks/assets/js/base/stores/woocommerce/products.ts so that |
| 97 | * directives referencing state.mainProductInContext / |
| 98 | * state.productVariationInContext / state.productInContext resolve |
| 99 | * during SSR. Because they read from |
| 100 | * wp_interactivity_state() at call time, they only need to be |
| 101 | * registered once regardless of how many products are added. |
| 102 | * |
| 103 | * @return void |
| 104 | */ |
| 105 | private static function register_getters(): void { |
| 106 | if ( self::$getters_registered ) { |
| 107 | return; |
| 108 | } |
| 109 | |
| 110 | self::$getters_registered = true; |
| 111 | |
| 112 | wp_interactivity_state( |
| 113 | self::$store_namespace, |
| 114 | array( |
| 115 | 'mainProductInContext' => function () { |
| 116 | $context = wp_interactivity_get_context(); |
| 117 | $state = wp_interactivity_state( self::$store_namespace ); |
| 118 | $product_id = array_key_exists( 'productId', $context ) |
| 119 | ? $context['productId'] |
| 120 | : ( $state['productId'] ?? null ); |
| 121 | |
| 122 | if ( ! $product_id ) { |
| 123 | return null; |
| 124 | } |
| 125 | |
| 126 | return $state['products'][ $product_id ] ?? null; |
| 127 | }, |
| 128 | 'productVariationInContext' => function () { |
| 129 | $context = wp_interactivity_get_context(); |
| 130 | $state = wp_interactivity_state( self::$store_namespace ); |
| 131 | $variation_id = array_key_exists( 'variationId', $context ) |
| 132 | ? $context['variationId'] |
| 133 | : ( $state['variationId'] ?? null ); |
| 134 | |
| 135 | if ( ! $variation_id ) { |
| 136 | return null; |
| 137 | } |
| 138 | |
| 139 | return $state['productVariations'][ $variation_id ] ?? null; |
| 140 | }, |
| 141 | 'productInContext' => function () { |
| 142 | $state = wp_interactivity_state( self::$store_namespace ); |
| 143 | $selected = $state['productVariationInContext'] instanceof \Closure |
| 144 | ? $state['productVariationInContext']() |
| 145 | : $state['productVariationInContext']; |
| 146 | |
| 147 | if ( $selected ) { |
| 148 | return $selected; |
| 149 | } |
| 150 | |
| 151 | return $state['mainProductInContext'] instanceof \Closure |
| 152 | ? $state['mainProductInContext']() |
| 153 | : $state['mainProductInContext']; |
| 154 | }, |
| 155 | ) |
| 156 | ); |
| 157 | } |
| 158 | |
| 159 | /** |
| 160 | * Load a product into state. |
| 161 | * |
| 162 | * @param string $consent_statement The consent statement string. |
| 163 | * @param int $product_id The product ID. |
| 164 | * @return array The product data. |
| 165 | * @throws InvalidArgumentException If consent statement doesn't match. |
| 166 | */ |
| 167 | public static function load_product( string $consent_statement, int $product_id ): array { |
| 168 | self::check_consent( $consent_statement ); |
| 169 | |
| 170 | // Skip loading if product is already in state. |
| 171 | if ( isset( self::$products[ $product_id ] ) ) { |
| 172 | return self::$products[ $product_id ]; |
| 173 | } |
| 174 | |
| 175 | $response = Package::container()->get( Hydration::class )->get_rest_api_response_data( '/wc/store/v1/products/' . $product_id ); |
| 176 | |
| 177 | self::$products[ $product_id ] = $response['body'] ?? array(); |
| 178 | self::register_getters(); |
| 179 | wp_interactivity_state( |
| 180 | self::$store_namespace, |
| 181 | array( 'products' => array( $product_id => self::$products[ $product_id ] ) ) |
| 182 | ); |
| 183 | |
| 184 | return self::$products[ $product_id ]; |
| 185 | } |
| 186 | |
| 187 | /** |
| 188 | * Load all purchasable child products of a parent product into state. |
| 189 | * |
| 190 | * @param string $consent_statement The consent statement string. |
| 191 | * @param int $parent_id The parent product ID. |
| 192 | * @return array The purchasable child products keyed by ID. |
| 193 | * @throws InvalidArgumentException If consent statement doesn't match. |
| 194 | */ |
| 195 | public static function load_purchasable_child_products( string $consent_statement, int $parent_id ): array { |
| 196 | self::check_consent( $consent_statement ); |
| 197 | |
| 198 | // Get the parent product to retrieve child IDs. |
| 199 | $parent_product = wc_get_product( $parent_id ); |
| 200 | if ( ! $parent_product ) { |
| 201 | return array(); |
| 202 | } |
| 203 | |
| 204 | // Get child product IDs (for grouped products, these are linked products). |
| 205 | $child_ids = $parent_product->get_children(); |
| 206 | if ( empty( $child_ids ) ) { |
| 207 | return array(); |
| 208 | } |
| 209 | |
| 210 | // Query child products using include[] filter. |
| 211 | // The parent[] filter doesn't work for grouped products because |
| 212 | // their children are standalone products, not variations. |
| 213 | $include_params = array_map( |
| 214 | fn( $id ) => 'include[]=' . $id, |
| 215 | $child_ids |
| 216 | ); |
| 217 | $query_string = implode( '&', $include_params ); |
| 218 | |
| 219 | $response = Package::container()->get( Hydration::class )->get_rest_api_response_data( '/wc/store/v1/products?' . $query_string ); |
| 220 | |
| 221 | if ( empty( $response['body'] ) ) { |
| 222 | return array(); |
| 223 | } |
| 224 | |
| 225 | // Filter to only purchasable products. |
| 226 | $purchasable_products = array_filter( |
| 227 | $response['body'], |
| 228 | fn( $product ) => $product['is_purchasable'] |
| 229 | ); |
| 230 | |
| 231 | // Re-key array by product ID and merge into state. |
| 232 | // Use array_replace instead of array_merge to preserve numeric keys. |
| 233 | $keyed_products = array_column( $purchasable_products, null, 'id' ); |
| 234 | self::$products = array_replace( self::$products, $keyed_products ); |
| 235 | self::register_getters(); |
| 236 | wp_interactivity_state( |
| 237 | self::$store_namespace, |
| 238 | array( 'products' => $keyed_products ) |
| 239 | ); |
| 240 | |
| 241 | return $keyed_products; |
| 242 | } |
| 243 | |
| 244 | /** |
| 245 | * Load all variations of a variable product into state. |
| 246 | * |
| 247 | * @param string $consent_statement The consent statement string. |
| 248 | * @param int $parent_id The parent product ID. |
| 249 | * @return array The variations keyed by ID. |
| 250 | * @throws InvalidArgumentException If consent statement doesn't match. |
| 251 | */ |
| 252 | public static function load_variations( string $consent_statement, int $parent_id ): array { |
| 253 | self::check_consent( $consent_statement ); |
| 254 | |
| 255 | // Skip loading if variations for this parent have already been loaded. |
| 256 | if ( isset( self::$loaded_variation_parents[ $parent_id ] ) ) { |
| 257 | return array_filter( |
| 258 | self::$product_variations, |
| 259 | fn( $variation ) => ( $variation['parent'] ?? 0 ) === $parent_id |
| 260 | ); |
| 261 | } |
| 262 | |
| 263 | $response = Package::container()->get( Hydration::class )->get_rest_api_response_data( '/wc/store/v1/products?parent[]=' . $parent_id . '&type=variation' ); |
| 264 | |
| 265 | self::$loaded_variation_parents[ $parent_id ] = true; |
| 266 | |
| 267 | if ( empty( $response['body'] ) ) { |
| 268 | return array(); |
| 269 | } |
| 270 | |
| 271 | // Re-key array by variation ID and merge into state. |
| 272 | // Use array_replace instead of array_merge to preserve numeric keys. |
| 273 | $keyed_variations = array_column( $response['body'], null, 'id' ); |
| 274 | self::$product_variations = array_replace( self::$product_variations, $keyed_variations ); |
| 275 | self::register_getters(); |
| 276 | wp_interactivity_state( |
| 277 | self::$store_namespace, |
| 278 | array( 'productVariations' => $keyed_variations ) |
| 279 | ); |
| 280 | |
| 281 | return $keyed_variations; |
| 282 | } |
| 283 | } |
| 284 |