Automattic\WooCommerce\Internal\PushNotifications

PushNotifications{} │ WC 10.4.0

WC Push Notifications

Class for setting up the WooCommerce-driven push notifications.

No Hooks.

Usage

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

Methods

1. public register()
2. public should_be_enabled()

Changelog

PushNotifications{} PushNotifications{} code ^{WC 10.4.3}

class PushNotifications {
	/**
	 * Feature name for the push notifications feature.
	 */
	const FEATURE_NAME = 'push_notifications';

	/**
	 * Roles that can receive push notifications.
	 *
	 * This will be used to gate functionality access to just these roles.
	 */
	const ROLES_WITH_PUSH_NOTIFICATIONS_ENABLED = array(
		'administrator',
		'shop_manager',
	);

	/**
	 * 'Memoized' enablement flag.
	 *
	 * @var bool|null
	 */
	private ?bool $enabled = null;

	/**
	 * Loads the push notifications class.
	 *
	 * @return void
	 *
	 * @since 10.4.0
	 */
	public function register(): void {
		if ( ! $this->should_be_enabled() ) {
			return;
		}

		// Library endpoints and scheduled tasks will be registered here.
	}

	/**
	 * Determines if local push notification functionality should be enabled.
	 * Push notifications require both the feature flag to be enabled and
	 * Jetpack to be connected. Memoize the value so we only check once per
	 * request.
	 *
	 * @return bool
	 *
	 * @since 10.4.0
	 */
	public function should_be_enabled(): bool {
		if ( null !== $this->enabled ) {
			return $this->enabled;
		}

		if ( ! FeaturesUtil::feature_is_enabled( self::FEATURE_NAME ) ) {
			$this->enabled = false;
			return $this->enabled;
		}

		try {
			$proxy = wc_get_container()->get( LegacyProxy::class );

			$this->enabled = (
				class_exists( JetpackConnectionManager::class )
				&& $proxy->get_instance_of( JetpackConnectionManager::class )->is_connected()
			);
		} catch ( Exception $e ) {
			$logger = wc_get_container()->get( LegacyProxy::class )->call_function( 'wc_get_logger' );
			$logger->error( 'Error determining if PushNotifications feature should be enabled: ' . $e->getMessage() );

			$this->enabled = false;
		}

		return $this->enabled;
	}
}