<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* CartEventTracker class file.

[2] Fix | Delete

*/

[3] Fix | Delete

[4] Fix | Delete

declare( strict_types=1 );

[5] Fix | Delete

[6] Fix | Delete

namespace Automattic\WooCommerce\Internal\FraudProtection;

[7] Fix | Delete

[8] Fix | Delete

defined( 'ABSPATH' ) || exit;

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Tracks cart events for fraud protection analysis.

[12] Fix | Delete

*

[13] Fix | Delete

* This class provides methods to track cart events (add, update, remove, restore)

[14] Fix | Delete

* for fraud protection. Event-specific data is passed

[15] Fix | Delete

* to the SessionDataCollector which handles session data storage internally.

[16] Fix | Delete

*

[17] Fix | Delete

* @since 10.5.0

[18] Fix | Delete

* @internal This class is part of the internal API and is subject to change without notice.

[19] Fix | Delete

*/

[20] Fix | Delete

class CartEventTracker {

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Session data collector instance.

[24] Fix | Delete

*

[25] Fix | Delete

* @var SessionDataCollector

[26] Fix | Delete

*/

[27] Fix | Delete

private SessionDataCollector $session_data_collector;

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* Initialize with dependencies.

[31] Fix | Delete

*

[32] Fix | Delete

* @internal

[33] Fix | Delete

*

[34] Fix | Delete

* @param SessionDataCollector $session_data_collector The session data collector instance.

[35] Fix | Delete

*/

[36] Fix | Delete

final public function init( SessionDataCollector $session_data_collector ): void {

[37] Fix | Delete

$this->session_data_collector = $session_data_collector;

[38] Fix | Delete

}

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* Track cart page loaded event.

[42] Fix | Delete

*

[43] Fix | Delete

* Collects session data when the cart page is initially loaded.

[44] Fix | Delete

* This captures the initial session state before any user interactions.

[45] Fix | Delete

*

[46] Fix | Delete

* @internal

[47] Fix | Delete

* @return void

[48] Fix | Delete

*/

[49] Fix | Delete

public function track_cart_page_loaded(): void {

[50] Fix | Delete

$this->session_data_collector->collect( 'cart_page_loaded', array() );

[51] Fix | Delete

}

[52] Fix | Delete

[53] Fix | Delete

/**

[54] Fix | Delete

* Track cart item added event.

[55] Fix | Delete

*

[56] Fix | Delete

* Collects session data when an item is added to the cart.

[57] Fix | Delete

*

[58] Fix | Delete

* @internal

[59] Fix | Delete

*

[60] Fix | Delete

* @param string $cart_item_key Cart item key.

[61] Fix | Delete

* @param int $product_id Product ID.

[62] Fix | Delete

* @param int $quantity Quantity added.

[63] Fix | Delete

* @param int $variation_id Variation ID.

[64] Fix | Delete

* @return void

[65] Fix | Delete

*/

[66] Fix | Delete

public function track_cart_item_added( $cart_item_key, $product_id, $quantity, $variation_id ): void {

[67] Fix | Delete

$event_data = $this->build_cart_event_data(

[68] Fix | Delete

'item_added',

[69] Fix | Delete

$product_id,

[70] Fix | Delete

$quantity,

[71] Fix | Delete

$variation_id

[72] Fix | Delete

);

[73] Fix | Delete

[74] Fix | Delete

$this->session_data_collector->collect( 'cart_item_added', $event_data );

[75] Fix | Delete

}

[76] Fix | Delete

[77] Fix | Delete

/**

[78] Fix | Delete

* Track cart item quantity updated event.

[79] Fix | Delete

*

[80] Fix | Delete

* Collects session data when cart item quantity is updated.

[81] Fix | Delete

*

[82] Fix | Delete

* @internal

[83] Fix | Delete

*

[84] Fix | Delete

* @param string $cart_item_key Cart item key.

[85] Fix | Delete

* @param int $quantity New quantity.

[86] Fix | Delete

* @param int $old_quantity Old quantity.

[87] Fix | Delete

* @param object $cart Cart object.

[88] Fix | Delete

* @return void

[89] Fix | Delete

*/

[90] Fix | Delete

public function track_cart_item_updated( $cart_item_key, $quantity, $old_quantity, $cart ): void {

[91] Fix | Delete

$cart_item = $cart->cart_contents[ $cart_item_key ] ?? null;

[92] Fix | Delete

[93] Fix | Delete

if ( (int) $quantity === (int) $old_quantity || ! $cart_item ) {

[94] Fix | Delete

return;

[95] Fix | Delete

}

[96] Fix | Delete

[97] Fix | Delete

$product_id = $cart_item['product_id'] ?? 0;

[98] Fix | Delete

$variation_id = $cart_item['variation_id'] ?? 0;

[99] Fix | Delete

[100] Fix | Delete

$event_data = $this->build_cart_event_data(

[101] Fix | Delete

'item_updated',

[102] Fix | Delete

$product_id,

[103] Fix | Delete

(int) $quantity,

[104] Fix | Delete

$variation_id

[105] Fix | Delete

);

[106] Fix | Delete

[107] Fix | Delete

$event_data['old_quantity'] = (int) $old_quantity;

[108] Fix | Delete

[109] Fix | Delete

$this->session_data_collector->collect( 'cart_item_updated', $event_data );

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete

/**

[113] Fix | Delete

* Track cart item removed event.

[114] Fix | Delete

*

[115] Fix | Delete

* Collects session data when an item is removed from the cart.

[116] Fix | Delete

*

[117] Fix | Delete

* @internal

[118] Fix | Delete

*

[119] Fix | Delete

* @param string $cart_item_key Cart item key.

[120] Fix | Delete

* @param object $cart Cart object.

[121] Fix | Delete

* @return void

[122] Fix | Delete

*/

[123] Fix | Delete

public function track_cart_item_removed( $cart_item_key, $cart ): void {

[124] Fix | Delete

$cart_item = $cart->removed_cart_contents[ $cart_item_key ] ?? null;

[125] Fix | Delete

[126] Fix | Delete

if ( ! $cart_item ) {

[127] Fix | Delete

return;

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

$product_id = $cart_item['product_id'] ?? 0;

[131] Fix | Delete

$variation_id = $cart_item['variation_id'] ?? 0;

[132] Fix | Delete

$quantity = $cart_item['quantity'] ?? 0;

[133] Fix | Delete

[134] Fix | Delete

$event_data = $this->build_cart_event_data(

[135] Fix | Delete

'item_removed',

[136] Fix | Delete

$product_id,

[137] Fix | Delete

$quantity,

[138] Fix | Delete

$variation_id

[139] Fix | Delete

);

[140] Fix | Delete

[141] Fix | Delete

$this->session_data_collector->collect( 'cart_item_removed', $event_data );

[142] Fix | Delete

}

[143] Fix | Delete

[144] Fix | Delete

/**

[145] Fix | Delete

* Track cart item restored event.

[146] Fix | Delete

*

[147] Fix | Delete

* Collects session data when a removed item is restored to the cart.

[148] Fix | Delete

*

[149] Fix | Delete

* @internal

[150] Fix | Delete

*

[151] Fix | Delete

* @param string $cart_item_key Cart item key.

[152] Fix | Delete

* @param object $cart Cart object.

[153] Fix | Delete

* @return void

[154] Fix | Delete

*/

[155] Fix | Delete

public function track_cart_item_restored( $cart_item_key, $cart ): void {

[156] Fix | Delete

$cart_item = $cart->cart_contents[ $cart_item_key ] ?? null;

[157] Fix | Delete

[158] Fix | Delete

if ( ! $cart_item ) {

[159] Fix | Delete

return;

[160] Fix | Delete

}

[161] Fix | Delete

[162] Fix | Delete

$product_id = $cart_item['product_id'] ?? 0;

[163] Fix | Delete

$variation_id = $cart_item['variation_id'] ?? 0;

[164] Fix | Delete

$quantity = $cart_item['quantity'] ?? 0;

[165] Fix | Delete

[166] Fix | Delete

$event_data = $this->build_cart_event_data(

[167] Fix | Delete

'item_restored',

[168] Fix | Delete

$product_id,

[169] Fix | Delete

$quantity,

[170] Fix | Delete

$variation_id

[171] Fix | Delete

);

[172] Fix | Delete

[173] Fix | Delete

$this->session_data_collector->collect( 'cart_item_restored', $event_data );

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

/**

[177] Fix | Delete

* Build cart event-specific data.

[178] Fix | Delete

*

[179] Fix | Delete

* Prepares the cart event data including action type, product details,

[180] Fix | Delete

* and current cart state. This data will be merged with comprehensive

[181] Fix | Delete

* session data during event dispatching.

[182] Fix | Delete

*

[183] Fix | Delete

* @param string $action Action type (item_added, item_updated, item_removed, item_restored).

[184] Fix | Delete

* @param int $product_id Product ID.

[185] Fix | Delete

* @param int $quantity Quantity.

[186] Fix | Delete

* @param int $variation_id Variation ID.

[187] Fix | Delete

* @return array Cart event data.

[188] Fix | Delete

*/

[189] Fix | Delete

private function build_cart_event_data( string $action, int $product_id, int $quantity, int $variation_id ): array {

[190] Fix | Delete

$cart_item_count = 0;

[191] Fix | Delete

[192] Fix | Delete

// Get current cart item count if cart is available.

[193] Fix | Delete

if ( WC()->cart instanceof \WC_Cart ) {

[194] Fix | Delete

$cart_item_count = WC()->cart->get_cart_contents_count();

[195] Fix | Delete

}

[196] Fix | Delete

[197] Fix | Delete

return array(

[198] Fix | Delete

'action' => $action,

[199] Fix | Delete

'product_id' => $product_id,

[200] Fix | Delete

'quantity' => $quantity,

[201] Fix | Delete

'variation_id' => $variation_id,

[202] Fix | Delete

'cart_item_count' => $cart_item_count,

[203] Fix | Delete

);

[204] Fix | Delete

}

[205] Fix | Delete

}

[206] Fix | Delete

[207] Fix | Delete