ProductPageIntegration.php — WooCommerce 10.9.3

woocommerce / src / Internal / StockNotifications / Frontend / ProductPageIntegration.php

woocommerce / src / Internal / StockNotifications / Frontend Last commit date

FormHandlerService.php 10 months ago NotificationManagementService.php 1 month ago ProductPageIntegration.php 10 months ago SignupResult.php 10 months ago SignupService.php 1 month ago

ProductPageIntegration.php

243 lines

1	<?php
2
3	declare( strict_types = 1 );
4
5	namespace Automattic\WooCommerce\Internal\StockNotifications\Frontend;
6
7	use Automattic\WooCommerce\Internal\StockNotifications\Config;
8	use Automattic\WooCommerce\Internal\StockNotifications\Utilities\EligibilityService;
9	use Automattic\WooCommerce\Internal\StockNotifications\Frontend\SignupService;
10	use Automattic\WooCommerce\Internal\StockNotifications\Notification;
11	use WC_Product;
12
13	/**
14	* Class for integrating with the product page.
15	*/
16	class ProductPageIntegration {
17
18	/**
19	* Runtime cache for preventing double rendering.
20	*
21	* @var array<int, bool>
22	*/
23	private array $rendered = array();
24
25	/**
26	* The eligibility service instance.
27	*
28	* @var EligibilityService
29	*/
30	private EligibilityService $eligibility_service;
31
32	/**
33	* The signup service instance.
34	*
35	* @var SignupService
36	*/
37	private SignupService $signup_service;
38
39	/**
40	* Init.
41	*
42	* @internal
43	*
44	* @param EligibilityService $eligibility_service The eligibility service instance.
45	* @param SignupService $signup_service The signup service instance.
46	*/
47	final public function init( EligibilityService $eligibility_service, SignupService $signup_service ): void {
48	$this->eligibility_service = $eligibility_service;
49	$this->signup_service = $signup_service;
50	}
51
52	/**
53	* Constructor.
54	*/
55	public function __construct() {
56	add_action( 'woocommerce_simple_add_to_cart', array( $this, 'maybe_render_form' ), 30 );
57	add_action( 'woocommerce_after_add_to_cart_form', array( $this, 'maybe_render_form' ), 30 );
58	}
59
60	/**
61	* Handle BIS form.
62	*
63	* @return void
64	*/
65	public function maybe_render_form() {
66
67	if ( ! Config::allows_signups() ) {
68	return;
69	}
70
71	global $product;
72	if ( ! is_product() \|\| ! is_a( $product, 'WC_Product' ) ) {
73	return;
74	}
75
76	if ( isset( $this->rendered[ $product->get_id() ] ) ) {
77	return;
78	}
79
80	$this->rendered[ $product->get_id() ] = true;
81
82	$is_variable = $product->is_type( 'variable' );
83	// Check if the product is in stock.
84	// Hint: This is negative logic. If the product is eligible for notifications, skip rendering.
85	// We avoid checking for variable products here because we want to render the form for out of stock variations.
86	if ( ! $is_variable && $this->eligibility_service->is_stock_status_eligible( $product->get_stock_status() ) ) {
87	return;
88	}
89
90	if ( ! $this->eligibility_service->is_product_eligible( $product ) ) {
91	return;
92	}
93
94	if ( ! $this->eligibility_service->product_allows_signups( $product ) ) {
95	return;
96	}
97
98	// Enqueue the script.
99	wp_enqueue_script( 'wc-back-in-stock-form' );
100
101	$this->render_form( $product );
102	}
103
104	/**
105	* Render the form.
106	*
107	* @param WC_Product $product Product object.
108	* @return void
109	*/
110	private function render_form( WC_Product $product ): void {
111
112	// Check if requires account.
113	if ( Config::requires_account() && ! is_user_logged_in() ) {
114	$this->display_account_required( $product );
115	return;
116	}
117
118	// Check if already signed up.
119	if ( $this->is_personalization_enabled() && is_user_logged_in() ) {
120	$user = \get_user_by( 'id', \get_current_user_id() );
121	$notification = $this->signup_service->is_already_signed_up( $product->get_id(), $user->ID, $user->user_email );
122	if ( $notification instanceof Notification ) {
123	$this->display_already_signed_up( $product, $notification );
124	return;
125	}
126	}
127
128	$this->display_form( $product );
129	}
130
131	/**
132	* Display the account required message.
133	*
134	* @param WC_Product $product Product object.
135	* @return void
136	*/
137	public function display_account_required( WC_Product $product ): void {
138
139	/**
140	* Filter the account required message HTML.
141	*
142	* @since 10.2.0
143	*
144	* @param string\|null $pre The message.
145	* @param WC_Product $product Product object.
146	* @return string\|null The message.
147	*/
148	$pre = apply_filters( 'woocommerce_customer_stock_notifications_account_required_message_html', null, $product );
149	if ( ! is_null( $pre ) ) {
150	echo wp_kses_post( $pre );
151	return;
152	}
153
154	$text = __( 'Please {login_link} to sign up for stock notifications.', 'woocommerce' );
155	$text = str_replace( '{login_link}', '<a href="' . wc_get_account_endpoint_url( 'my-account' ) . '">' . _x( 'log in', 'back in stock form', 'woocommerce' ) . '</a>', $text );
156	wc_print_notice( $text, 'notice' );
157	}
158
159	/**
160	* Display the already signed up message.
161	*
162	* @param WC_Product $product Product object.
163	* @param Notification $notification Notification object.
164	* @return void
165	*/
166	public function display_already_signed_up( WC_Product $product, Notification $notification ): void {
167
168	/**
169	* Filter the already signed up message HTML.
170	*
171	* @since 10.2.0
172	*
173	* @param string\|null $pre The message.
174	* @param WC_Product $product Product object.
175	* @param Notification $notification Notification object.
176	* @return string\|null The message.
177	*/
178	$pre = apply_filters( 'woocommerce_customer_stock_notifications_already_signed_up_message_html', null, $product, $notification );
179	if ( ! is_null( $pre ) ) {
180	echo wp_kses_post( $pre );
181	return;
182	}
183
184	$text = __( 'You have already joined the waitlist! Click {manage_account_link} to manage your notifications.', 'woocommerce' );
185	$text = str_replace( '{manage_account_link}', '<a href="' . wc_get_account_endpoint_url( 'stock-notifications' ) . '">' . _x( 'here', 'back in stock form', 'woocommerce' ) . '</a>', $text );
186	wc_print_notice( $text, 'notice' );
187	}
188
189	/**
190	* Display the form.
191	*
192	* @param WC_Product $product Product object.
193	* @return void
194	*/
195	public function display_form( WC_Product $product ): void {
196
197	$button_class = implode(
198	' ',
199	array_filter(
200	array(
201	'button',
202	\wc_wp_theme_get_element_class_name( 'button' ),
203	'wc_bis_form__button',
204	)
205	)
206	);
207
208	// When a variable has no purchasable variations, allow for signups on the parent product.
209	$is_visible = ! $product->is_type( 'variable' ) \|\| ( 'yes' === get_option( 'woocommerce_hide_out_of_stock_items' ) && ! $product->has_purchasable_variations() );
210
211	wc_get_template(
212	'single-product/back-in-stock-form.php',
213	array(
214	'product_id' => $product->get_parent_id() ? $product->get_parent_id() : $product->get_id(),
215	'show_checkbox' => ! is_user_logged_in() && Config::creates_account_on_signup() && ! Config::requires_account(),
216	'show_email_field' => ! is_user_logged_in() && ! Config::requires_account(),
217	'button_class' => $button_class,
218	'is_visible' => $is_visible,
219	)
220	);
221	}
222
223	/**
224	* Whether personalization is enabled.
225	*
226	* Personalization includes checking if the user is already signed up and displaying the 'already signed up' message.
227	*
228	* @return bool True if personalization is enabled, false otherwise.
229	*/
230	public static function is_personalization_enabled(): bool {
231
232	/**
233	* Filter whether personalization is enabled while rendering the form.
234	*
235	* @since 10.2.0
236	*
237	* @param bool $enabled Whether personalization is enabled.
238	* @return bool
239	*/
240	return (bool) apply_filters( 'woocommerce_customer_stock_notifications_personalization_enabled', false );
241	}
242	}
243