Automattic\WooCommerce\Internal\OrderWithdrawal

OrderWithdrawalFeatureHighlightNotification{} │ final │ WC 1.0└─ RegisterHooksInterface

Adds an inbox notification about the order withdrawal feature for eligible stores.

No Hooks.

Usage

$OrderWithdrawalFeatureHighlightNotification = new OrderWithdrawalFeatureHighlightNotification();
// use class methods

Methods

1. public maybe_add_note_when_store_goes_live( $old_value, $value )
2. public possibly_add_note()
3. public register()
4. private get_note()
5. private has_note_been_created()
6. private is_applicable()
7. private store_sells_to_eu_or_all_countries()

OrderWithdrawalFeatureHighlightNotification{} OrderWithdrawalFeatureHighlightNotification{} code ^{WC 11.1.2}

final class OrderWithdrawalFeatureHighlightNotification implements RegisterHooksInterface {

	public const NOTE_NAME      = 'wc-admin-order-withdrawal-feature';
	public const CREATED_OPTION = 'woocommerce_order_withdrawal_inbox_notification_created';

	private const COMING_SOON_OPTION    = 'woocommerce_coming_soon';
	private const FEATURES_SETTINGS_URL = 'admin.php?page=wc-settings&tab=advanced&section=features';
	private const DOCUMENTATION_URL     = 'https://woocommerce.com/document/customer-order-withdrawal/';

	/**
	 * Register hooks.
	 *
	 * @since 11.1.0
	 */
	public function register(): void {
		add_action(
			'update_option_' . self::COMING_SOON_OPTION,
			array( $this, 'maybe_add_note_when_store_goes_live' ),
			10,
			2
		);
		add_action( 'wc_admin_daily', array( $this, 'possibly_add_note' ) );
	}

	/**
	 * Add the note when the store is changed from coming soon to live.
	 *
	 * This is called when the `woocommerce_coming_soon` option is updated. It checks if the store has gone live and if so, it calls the `possibly_add_note` method to add the note.
	 *
	 * @internal
	 * @since 11.1.0
	 *
	 * @param mixed $old_value Previous option value.
	 * @param mixed $value     New option value.
	 */
	public function maybe_add_note_when_store_goes_live( $old_value, $value ): void {
		if ( 'yes' !== $old_value || 'no' !== $value ) {
			return;
		}

		$this->possibly_add_note();
	}

	/**
	 * Add the note if the store is eligible and it has never been created before.
	 */
	public function possibly_add_note(): void {
		try {
			if ( $this->has_note_been_created() ) {
				return;
			}

			if ( ! $this->is_applicable() ) {
				return;
			}

			if ( ! add_option( self::CREATED_OPTION, 'yes', '', false ) ) {
				return;
			}

			$this->get_note()->save();
		} catch ( Exception $exception ) {
			delete_option( self::CREATED_OPTION );
			wc_get_logger()->error(
				'Unable to create the order withdrawal inbox notification.',
				array(
					'source'    => 'order-withdrawal',
					'exception' => $exception,
				)
			);
		}
	}

	/**
	 * Whether the notification is relevant for the current store settings.
	 */
	private function is_applicable(): bool {
		return 'no' === get_option( self::COMING_SOON_OPTION, 'yes' )
			&& $this->store_sells_to_eu_or_all_countries();
	}

	/**
	 * Get the inbox note.
	 */
	private function get_note(): Note {
		$note = new Note();

		$note->set_title(
			__( 'Enable order withdrawal for EU regulatory requirements', 'woocommerce' )
		);
		$note->set_content(
			__(
				'Stores selling to EU countries may need to offer customers a way to withdraw from qualifying orders. Review how to enable the order withdrawal feature in the Advanced settings.',
				'woocommerce'
			)
		);
		$note->set_content_data( (object) array() );
		$note->set_type( Note::E_WC_ADMIN_NOTE_INFORMATIONAL );
		$note->set_name( self::NOTE_NAME );
		$note->set_source( 'woocommerce-admin' );
		$note->add_action(
			'review-feature-settings',
			__( 'Get started', 'woocommerce' ),
			admin_url( self::FEATURES_SETTINGS_URL ),
			Note::E_WC_ADMIN_NOTE_ACTIONED,
			true
		);
		$note->add_action(
			'learn-more',
			__( 'Learn more', 'woocommerce' ),
			self::DOCUMENTATION_URL,
			Note::E_WC_ADMIN_NOTE_UNACTIONED
		);

		return $note;
	}

	/**
	 * Whether this note has already been created, including soft-deleted notes.
	 */
	private function has_note_been_created(): bool {
		if ( 'yes' === get_option( self::CREATED_OPTION, 'no' ) ) {
			return true;
		}

		/**
		 * Data store instance.
		 *
		 * @var NotesDataStore $data_store
		 */
		$data_store = Notes::load_data_store();
		$note_ids   = $data_store->get_notes_with_name( self::NOTE_NAME );

		if ( empty( $note_ids ) ) {
			return false;
		}

		update_option( self::CREATED_OPTION, 'yes', false );

		return true;
	}

	/**
	 * Whether the store sells to at least one EU country.
	 */
	private function store_sells_to_eu_or_all_countries(): bool {
		$woocommerce = function_exists( 'WC' ) ? WC() : null;

		if ( ! $woocommerce || ! $woocommerce->countries instanceof \WC_Countries ) {
			return false;
		}

		return ! empty(
			array_intersect(
				$woocommerce->countries->get_european_union_countries(),
				array_keys( $woocommerce->countries->get_allowed_countries() )
			)
		);
	}
}