mailpoet
/
lib
/
EmailEditor
/
Integrations
/
MailPoet
/
ProductCollection
/
OrderProductCollectionProcessor.php
OrderProductCollectionProcessor.php
1 month ago
ProductCollectionEmailRendererRegistrar.php
1 month ago
index.php
1 month ago
OrderProductCollectionProcessor.php
353 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\EmailEditor\Integrations\MailPoet\ProductCollection; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\AutomaticEmails\WooCommerce\Events\AbandonedCart; |
| 9 | use MailPoet\Entities\SendingQueueEntity; |
| 10 | |
| 11 | /** |
| 12 | * Fills product collection blocks from MailPoet automation context. |
| 13 | * |
| 14 | * Order-aware collections use products derived from the order that triggered |
| 15 | * the email. Abandoned-cart emails expose the queued cart product snapshot to |
| 16 | * WooCommerce's cart-contents collection during rendering. |
| 17 | * |
| 18 | * The collection slug stored in the block's `collection` attribute is the |
| 19 | * marker — it is a declared block attribute, so it survives editing and |
| 20 | * re-saving the email in the block editor. The same slugs are registered in |
| 21 | * the editor (see assets/js/src/mailpoet-email-editor-integration/order-product-collections.ts) |
| 22 | * so merchants see what the block does. |
| 23 | * |
| 24 | * When a source yields no products, related products of the purchased items |
| 25 | * are used instead. When even those are missing, the block is left untouched |
| 26 | * and renders the generic store query authored in the pattern. |
| 27 | */ |
| 28 | class OrderProductCollectionProcessor { |
| 29 | public const COLLECTION_ORDER_CROSS_SELLS = 'mailpoet/product-collection/order-cross-sells'; |
| 30 | public const COLLECTION_ORDER_SAME_TAG = 'mailpoet/product-collection/order-same-tag'; |
| 31 | public const COLLECTION_ORDER_SAME_CATEGORY = 'mailpoet/product-collection/order-same-category'; |
| 32 | |
| 33 | public const ORDER_COLLECTIONS = [ |
| 34 | self::COLLECTION_ORDER_CROSS_SELLS, |
| 35 | self::COLLECTION_ORDER_SAME_TAG, |
| 36 | self::COLLECTION_ORDER_SAME_CATEGORY, |
| 37 | ]; |
| 38 | |
| 39 | private const PRODUCT_COLLECTION_BLOCK = 'woocommerce/product-collection'; |
| 40 | private const PERSISTENT_CART_META_KEY_PREFIX = '_woocommerce_persistent_cart_'; |
| 41 | private const MAX_PRODUCTS = 24; |
| 42 | private const RELATED_PRODUCTS_PER_ITEM = 8; |
| 43 | |
| 44 | /** |
| 45 | * Build a `woocommerce_email_blocks_renderer_parsed_blocks` filter bound to the |
| 46 | * order in the render context. Returns null when there is no order, leaving |
| 47 | * marked blocks to render their authored fallback query. |
| 48 | * |
| 49 | * @param array<string, mixed> $renderContext |
| 50 | */ |
| 51 | public function createBlocksFilter(array $renderContext): ?callable { |
| 52 | $order = $renderContext['order'] ?? null; |
| 53 | if (!$order instanceof \WC_Order) { |
| 54 | return null; |
| 55 | } |
| 56 | |
| 57 | return function (array $blocks) use ($order): array { |
| 58 | return $this->fillOrderCollections($blocks, $order); |
| 59 | }; |
| 60 | } |
| 61 | |
| 62 | /** |
| 63 | * WooCommerce's cart-contents collection reads products from persistent cart |
| 64 | * user meta during email rendering. MailPoet already stores the abandoned cart |
| 65 | * snapshot on the queue, so expose that snapshot only while rendering the queue. |
| 66 | * |
| 67 | * @param array<string, mixed> $renderContext |
| 68 | */ |
| 69 | public function createAbandonedCartPersistentCartFilter( |
| 70 | array $renderContext, |
| 71 | ?SendingQueueEntity $sendingQueue |
| 72 | ): ?callable { |
| 73 | $userId = isset($renderContext['user_id']) && is_numeric($renderContext['user_id']) |
| 74 | ? (int)$renderContext['user_id'] |
| 75 | : 0; |
| 76 | if (!$userId || !$sendingQueue) { |
| 77 | return null; |
| 78 | } |
| 79 | |
| 80 | $meta = $sendingQueue->getMeta() ?: []; |
| 81 | $productIds = $this->normalizeProductIds($meta[AbandonedCart::TASK_META_NAME] ?? []); |
| 82 | if (!$productIds) { |
| 83 | return null; |
| 84 | } |
| 85 | |
| 86 | $persistentCart = $this->buildPersistentCart($productIds); |
| 87 | // Return a single-element value list. get_metadata_raw() unwraps it to |
| 88 | // $persistentCart for $single calls (its $check[0]) and hands it back as an |
| 89 | // array of values otherwise. WooCommerce reads the persistent cart with |
| 90 | // $single = true, so returning the bare cart here would make WP read index 0 |
| 91 | // of an associative array and yield null. |
| 92 | return function($value, $objectId, $metaKey) use ($userId, $persistentCart) { |
| 93 | if ( |
| 94 | (int)$objectId !== $userId |
| 95 | || !is_string($metaKey) |
| 96 | || strpos($metaKey, self::PERSISTENT_CART_META_KEY_PREFIX) !== 0 |
| 97 | ) { |
| 98 | return $value; |
| 99 | } |
| 100 | |
| 101 | return [$persistentCart]; |
| 102 | }; |
| 103 | } |
| 104 | |
| 105 | /** |
| 106 | * Set hand-picked products on every product collection block using one of the |
| 107 | * order-aware collections, descending into inner blocks. Each collection is |
| 108 | * resolved at most once per call. |
| 109 | * |
| 110 | * @param array<array-key, mixed> $blocks |
| 111 | * @return array<array-key, mixed> |
| 112 | */ |
| 113 | public function fillOrderCollections(array $blocks, \WC_Order $order): array { |
| 114 | $resolvedIds = []; |
| 115 | return $this->walkBlocks($blocks, $order, $resolvedIds); |
| 116 | } |
| 117 | |
| 118 | /** |
| 119 | * @param mixed $productIds |
| 120 | * @return int[] |
| 121 | */ |
| 122 | private function normalizeProductIds($productIds): array { |
| 123 | if (!is_array($productIds)) { |
| 124 | return []; |
| 125 | } |
| 126 | |
| 127 | $normalized = []; |
| 128 | foreach ($productIds as $productId) { |
| 129 | if (!is_numeric($productId)) { |
| 130 | continue; |
| 131 | } |
| 132 | $productId = (int)$productId; |
| 133 | if ($productId > 0) { |
| 134 | $normalized[] = $productId; |
| 135 | } |
| 136 | } |
| 137 | |
| 138 | return array_values(array_unique($normalized)); |
| 139 | } |
| 140 | |
| 141 | /** |
| 142 | * @param int[] $productIds |
| 143 | * @return array{cart: array<string, array{product_id: int}>} |
| 144 | */ |
| 145 | private function buildPersistentCart(array $productIds): array { |
| 146 | $cart = []; |
| 147 | foreach ($productIds as $index => $productId) { |
| 148 | $cart['mailpoet_abandoned_cart_' . $index] = ['product_id' => $productId]; |
| 149 | } |
| 150 | return ['cart' => $cart]; |
| 151 | } |
| 152 | |
| 153 | /** |
| 154 | * Product IDs for an order-aware collection, excluding the purchased products |
| 155 | * themselves and products that are not displayable (unpublished, out of stock). |
| 156 | * Falls back to related products of the purchased items when the primary |
| 157 | * source yields nothing. |
| 158 | * |
| 159 | * @return int[] |
| 160 | */ |
| 161 | public function resolveProductIds(string $collection, \WC_Order $order): array { |
| 162 | $purchasedProducts = $this->getPurchasedProducts($order); |
| 163 | if (!$purchasedProducts) { |
| 164 | return []; |
| 165 | } |
| 166 | $purchasedIds = array_keys($purchasedProducts); |
| 167 | |
| 168 | switch ($collection) { |
| 169 | case self::COLLECTION_ORDER_CROSS_SELLS: |
| 170 | $ids = $this->getCrossSellIds($purchasedProducts); |
| 171 | break; |
| 172 | case self::COLLECTION_ORDER_SAME_TAG: |
| 173 | $ids = $this->getSameTermProductIds($purchasedProducts, 'product_tag_id'); |
| 174 | break; |
| 175 | case self::COLLECTION_ORDER_SAME_CATEGORY: |
| 176 | $ids = $this->getSameTermProductIds($purchasedProducts, 'product_category_id'); |
| 177 | break; |
| 178 | default: |
| 179 | return []; |
| 180 | } |
| 181 | |
| 182 | $ids = $this->filterDisplayable($ids, $purchasedIds); |
| 183 | if (!$ids) { |
| 184 | $ids = $this->filterDisplayable($this->getRelatedIds($purchasedIds), $purchasedIds); |
| 185 | } |
| 186 | |
| 187 | return array_slice($ids, 0, self::MAX_PRODUCTS); |
| 188 | } |
| 189 | |
| 190 | /** |
| 191 | * @param array<array-key, mixed> $blocks |
| 192 | * @param array<string, int[]> $resolvedIds |
| 193 | * @return array<array-key, mixed> |
| 194 | */ |
| 195 | private function walkBlocks(array $blocks, \WC_Order $order, array &$resolvedIds): array { |
| 196 | foreach ($blocks as $index => $block) { |
| 197 | if (!is_array($block)) { |
| 198 | continue; |
| 199 | } |
| 200 | |
| 201 | $collection = $this->getOrderCollectionSlug($block); |
| 202 | if ($collection !== null) { |
| 203 | if (!array_key_exists($collection, $resolvedIds)) { |
| 204 | $resolvedIds[$collection] = $this->resolveProductIds($collection, $order); |
| 205 | } |
| 206 | if ($resolvedIds[$collection]) { |
| 207 | $block = $this->setHandPickedProducts($block, $resolvedIds[$collection]); |
| 208 | } |
| 209 | } |
| 210 | |
| 211 | if (isset($block['innerBlocks']) && is_array($block['innerBlocks'])) { |
| 212 | $block['innerBlocks'] = $this->walkBlocks($block['innerBlocks'], $order, $resolvedIds); |
| 213 | } |
| 214 | |
| 215 | $blocks[$index] = $block; |
| 216 | } |
| 217 | |
| 218 | return $blocks; |
| 219 | } |
| 220 | |
| 221 | /** |
| 222 | * @param array<array-key, mixed> $block |
| 223 | */ |
| 224 | private function getOrderCollectionSlug(array $block): ?string { |
| 225 | if (($block['blockName'] ?? null) !== self::PRODUCT_COLLECTION_BLOCK) { |
| 226 | return null; |
| 227 | } |
| 228 | |
| 229 | $attrs = $block['attrs'] ?? null; |
| 230 | $collection = is_array($attrs) ? ($attrs['collection'] ?? null) : null; |
| 231 | return is_string($collection) && in_array($collection, self::ORDER_COLLECTIONS, true) ? $collection : null; |
| 232 | } |
| 233 | |
| 234 | /** |
| 235 | * @param array<array-key, mixed> $block |
| 236 | * @param int[] $productIds |
| 237 | * @return array<array-key, mixed> |
| 238 | */ |
| 239 | private function setHandPickedProducts(array $block, array $productIds): array { |
| 240 | $attrs = is_array($block['attrs'] ?? null) ? $block['attrs'] : []; |
| 241 | $query = is_array($attrs['query'] ?? null) ? $attrs['query'] : []; |
| 242 | $query['woocommerceHandPickedProducts'] = $productIds; |
| 243 | $attrs['query'] = $query; |
| 244 | $block['attrs'] = $attrs; |
| 245 | return $block; |
| 246 | } |
| 247 | |
| 248 | /** |
| 249 | * Purchased products keyed by product ID. Uses the parent product for |
| 250 | * variations because cross-sells and taxonomy terms live on the parent. |
| 251 | * |
| 252 | * @return array<int, \WC_Product> |
| 253 | */ |
| 254 | private function getPurchasedProducts(\WC_Order $order): array { |
| 255 | $products = []; |
| 256 | foreach ($order->get_items() as $item) { |
| 257 | if (!$item instanceof \WC_Order_Item_Product) { |
| 258 | continue; |
| 259 | } |
| 260 | $productId = $item->get_product_id(); |
| 261 | if (!$productId || isset($products[$productId])) { |
| 262 | continue; |
| 263 | } |
| 264 | $product = wc_get_product($productId); |
| 265 | if ($product instanceof \WC_Product) { |
| 266 | $products[$productId] = $product; |
| 267 | } |
| 268 | } |
| 269 | return $products; |
| 270 | } |
| 271 | |
| 272 | /** |
| 273 | * @param array<int, \WC_Product> $purchasedProducts |
| 274 | * @return int[] |
| 275 | */ |
| 276 | private function getCrossSellIds(array $purchasedProducts): array { |
| 277 | $ids = []; |
| 278 | foreach ($purchasedProducts as $product) { |
| 279 | foreach ($product->get_cross_sell_ids() as $crossSellId) { |
| 280 | $ids[] = (int)$crossSellId; |
| 281 | } |
| 282 | } |
| 283 | return $ids; |
| 284 | } |
| 285 | |
| 286 | /** |
| 287 | * Products sharing taxonomy terms with the purchased products. |
| 288 | * |
| 289 | * @param array<int, \WC_Product> $purchasedProducts |
| 290 | * @param string $termQueryArg WC_Product_Query taxonomy argument ('product_tag_id' or 'product_category_id'). |
| 291 | * @return int[] |
| 292 | */ |
| 293 | private function getSameTermProductIds(array $purchasedProducts, string $termQueryArg): array { |
| 294 | $termIds = []; |
| 295 | foreach ($purchasedProducts as $product) { |
| 296 | $productTermIds = $termQueryArg === 'product_tag_id' ? $product->get_tag_ids() : $product->get_category_ids(); |
| 297 | foreach ($productTermIds as $termId) { |
| 298 | $termIds[] = (int)$termId; |
| 299 | } |
| 300 | } |
| 301 | $termIds = array_values(array_unique($termIds)); |
| 302 | if (!$termIds) { |
| 303 | return []; |
| 304 | } |
| 305 | |
| 306 | // Purchased products are not excluded here (the exclude/post__not_in query |
| 307 | // parameter scales poorly); filterDisplayable() removes them afterwards. |
| 308 | $ids = wc_get_products([ |
| 309 | 'status' => 'publish', |
| 310 | 'limit' => self::MAX_PRODUCTS + count($purchasedProducts), |
| 311 | 'orderby' => 'date', |
| 312 | 'order' => 'DESC', |
| 313 | $termQueryArg => $termIds, |
| 314 | 'return' => 'ids', |
| 315 | ]); |
| 316 | return is_array($ids) ? array_map('intval', $ids) : []; |
| 317 | } |
| 318 | |
| 319 | /** |
| 320 | * @param int[] $purchasedIds |
| 321 | * @return int[] |
| 322 | */ |
| 323 | private function getRelatedIds(array $purchasedIds): array { |
| 324 | $ids = []; |
| 325 | foreach ($purchasedIds as $purchasedId) { |
| 326 | foreach (wc_get_related_products($purchasedId, self::RELATED_PRODUCTS_PER_ITEM) as $relatedId) { |
| 327 | $ids[] = (int)$relatedId; |
| 328 | } |
| 329 | } |
| 330 | return $ids; |
| 331 | } |
| 332 | |
| 333 | /** |
| 334 | * Deduplicates, removes purchased products, and keeps only products a |
| 335 | * customer can still see and buy. |
| 336 | * |
| 337 | * @param int[] $ids |
| 338 | * @param int[] $excludeIds |
| 339 | * @return int[] |
| 340 | */ |
| 341 | private function filterDisplayable(array $ids, array $excludeIds): array { |
| 342 | $ids = array_values(array_unique(array_map('intval', $ids))); |
| 343 | $ids = array_values(array_diff($ids, $excludeIds)); |
| 344 | |
| 345 | return array_values(array_filter($ids, function (int $id): bool { |
| 346 | $product = wc_get_product($id); |
| 347 | return $product instanceof \WC_Product |
| 348 | && $product->get_status() === 'publish' |
| 349 | && $product->get_stock_status() !== 'outofstock'; |
| 350 | })); |
| 351 | } |
| 352 | } |
| 353 |