woocommerce-subscriptions/includes/gifting/class-wcsg-product.php

<?php
/**
 * Integration with product pages on the frontend.
 *
 * @package WooCommerce Subscriptions Gifting
 */

if ( ! defined( 'ABSPATH' ) ) {
	exit; // Exit if accessed directly.
}

/**
 * Class for integrating with product pages.
 */
class WCSG_Product {

	/**
	 * Setup hooks & filters, when the class is initialised.
	 */
	public static function init() {

		add_filter( 'woocommerce_add_cart_item_data', __CLASS__ . '::add_recipient_data', 1, 1 );
		add_filter( 'woocommerce_get_cart_item_from_session', __CLASS__ . '::get_cart_items_from_session', 1, 2 );
		add_filter( 'woocommerce_available_variation', __CLASS__ . '::add_gifting_to_variation_data', 10, 3 );

		add_action( 'woocommerce_before_add_to_cart_button', __CLASS__ . '::add_gifting_option_product' );
	}

	/**
	 * Attaches recipient information to cart item data when a subscription is added to cart via product page.
	 * If the recipient email is invalid (incorrect email format or belongs to the current user) an exception is thrown
	 * and caught by WooCommerce add to cart function - preventing the product being entered into the cart.
	 *
	 * @param array $cart_item_data Cart item data.
	 * @return array New cart item data.
	 * @throws Exception In case of error.
	 */
	public static function add_recipient_data( $cart_item_data ) {

		if ( isset( $_POST['recipient_email'] ) && ! empty( $_POST['recipient_email'][0] ) ) {
			if ( ! empty( $_POST['_wcsgnonce'] ) && wp_verify_nonce( $_POST['_wcsgnonce'], 'wcsg_add_recipient' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized, WordPress.Security.ValidatedSanitizedInput.MissingUnslash

				if ( WCS_Gifting::validate_recipient_emails( wp_unslash( $_POST['recipient_email'] ) ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized

					$cart_item_data['wcsg_gift_recipients_email'] = sanitize_email( wp_unslash( $_POST['recipient_email'][0] ) );

				} else {
					// throw exception to be caught by WC add_to_cart(). validate_recipient_emails() will have added the relevant notices.
					throw new Exception();
				}
			} else {
				throw new Exception( __( 'There was an error with your request. Please try again.', 'woocommerce-subscriptions' ) );
			}
		}

		return $cart_item_data;
	}

	/**
	 * Adds the recipient information to the session cart item data.
	 *
	 * @param object $item The Session Data stored for an item in the cart.
	 * @param array  $values The data stored on a cart item.
	 * @return object The session data with added cart item recipient information.
	 */
	public static function get_cart_items_from_session( $item, $values ) {
		if ( array_key_exists( 'wcsg_gift_recipients_email', $values ) ) { // previously added at the product page via $cart_item_data.
			$item['wcsg_gift_recipients_email'] = $values['wcsg_gift_recipients_email'];
			unset( $values['wcsg_gift_recipients_email'] );
		}
		return $item;
	}

	/**
	 * Adds gifting ui elements to the subscription product page.
	 */
	public static function add_gifting_option_product() {
		global $product;
		if ( self::is_giftable( $product ) && ! isset( $_GET['switch-subscription'] ) ) {
			$email = '';
			if ( ! empty( $_POST['recipient_email'][0] ) && ! empty( $_POST['_wcsgnonce'] ) && wp_verify_nonce( $_POST['_wcsgnonce'], 'wcsg_add_recipient' ) ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized, WordPress.Security.ValidatedSanitizedInput.MissingUnslash
				$email = $_POST['recipient_email'][0]; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized, WordPress.Security.ValidatedSanitizedInput.MissingUnslash
			}

			WCS_Gifting::render_add_recipient_fields( $email );
		}
	}

	/**
	 * Checks if a given product is a giftable product
	 *
	 * @param int|WC_Product $product A WC_Product object or the ID of a product to check.
	 * @return bool
	 */
	public static function is_giftable( $product ) {

		if ( ! is_object( $product ) ) {
			$product = wc_get_product( $product );
		}

		$is_giftable = false;

		if ( WCSG_Admin::is_gifting_enabled() && WC_Subscriptions_Product::is_subscription( $product ) ) {
			// On variable subscription products, it's always true to load the checkbox,
			// let the variation handle showing the checkbox when it is giftable.
			if ( WC_Subscriptions_Product::is_variable_subscription( $product ) ) {
				$is_giftable = true;
			} else {
				// "Allow gifting" is set to "Enabled for all products".
				$is_giftable     = WCSG_Admin::is_gifting_enabled_for_all_products();
				$product_gifting = WC_Subscriptions_Product::get_gifting( $product );

				// Apply product-level override if it's set.
				if ( '' !== $product_gifting ) {
					$is_giftable = 'enabled' === $product_gifting;
				}
			}
		}

		/**
		 * Filter whether a product can be gifted.
		 *
		 * @param bool       $is_giftable Whether the product can be gifted.
		 * @param WC_Product $product     The product object.
		 *
		 * @since 7.8.0 - Originally implemented in WooCommerce Subscriptions Gifting 2.9.0.
		 */
		return apply_filters( 'wcsg_is_giftable_product', $is_giftable, $product );
	}

	/**
	 * Adds gifting data to the variation data.
	 * The variation data is used on the front-end as a value for the "found_variation" DOM event.
	 *
	 * @param array $variation_data The variation data.
	 * @param WC_Product $product The product object.
	 * @param WC_Product_Variation $variation The variation object.
	 * @return array The variation data with added gifting data.
	 */
	public static function add_gifting_to_variation_data( $variation_data, $product, $variation ) {
		if ( ! WC_Subscriptions_Product::is_subscription( $product ) ) {
			return $variation_data;
		}

		$variation_data['gifting'] = self::is_giftable( $variation );

		return $variation_data;
	}
}