OwlCyberSecurity - MANAGER

Edit File: PaymentsExtensionSuggestionIncentives.php

<?php
declare( strict_types=1 );

namespace Automattic\WooCommerce\Internal\Admin\Suggestions;

use Automattic\WooCommerce\Internal\Admin\Suggestions\Incentives\Incentive;
use Automattic\WooCommerce\Internal\Admin\Suggestions\Incentives\WooPayments;

defined( 'ABSPATH' ) || exit;

/**
 * Partner payments extension suggestion incentives provider class.
 */
class PaymentsExtensionSuggestionIncentives {
	/**
	 * The map of suggestion IDs to their respective incentives provider classes.
	 *
	 * @var array|\class-string[]
	 */
	private array $suggestion_incentives_class_map = array(
		PaymentsExtensionSuggestions::WOOPAYMENTS => WooPayments::class,
	);

/**
	 * The instances of the incentives providers.
	 *
	 * @var Incentive[]
	 */
	private array $instances = array();

/**
	 * Get the first found incentive details for a specific payment extension suggestion.
	 *
	 * @param string $suggestion_id         The suggestion ID.
	 * @param string $country_code          The business location country code to get incentives for.
	 * @param string $incentive_type        Optional. The type of incentive to check for.
	 * @param bool   $skip_visibility_check Optional. Whether to skip the visibility check for the incentives.
	 *
	 * @return ?array The incentive details. Returns null if there is no incentive available.
	 */
	public function get_incentive( string $suggestion_id, string $country_code, string $incentive_type = '', bool $skip_visibility_check = false ): ?array {
		$incentives = $this->get_incentives( $suggestion_id, $country_code, $incentive_type, $skip_visibility_check );
		if ( empty( $incentives ) ) {
			return null;
		}

return reset( $incentives );
	}

/**
	 * Get the incentives list for a specific payment extension suggestion.
	 *
	 * @param string $suggestion_id         The suggestion ID.
	 * @param string $country_code          The business location country code to get incentives for.
	 * @param string $incentive_type        Optional. The type of incentive to check for.
	 *                                      If not provided, all incentives for the suggestion will be returned.
	 * @param bool   $skip_visibility_check Optional. Whether to skip the visibility check for the incentives.
	 *
	 * @return array The incentives list.
	 */
	public function get_incentives( string $suggestion_id, string $country_code, string $incentive_type = '', bool $skip_visibility_check = false ): array {
		$provider = $this->get_incentive_instance( $suggestion_id );
		if ( null === $provider ) {
			return array();
		}

$incentives = $provider->get_all( $country_code, $incentive_type );

if ( ! $skip_visibility_check ) {
			$incentives = array_filter(
				$incentives,
				fn( $incentive ) => $provider->is_visible( $incentive['id'], $country_code )
			);
		}

return array_values( $incentives );
	}

/**
	 * Check if an incentive is visible.
	 *
	 * @param string $incentive_id                The incentive ID.
	 * @param string $suggestion_id               The suggestion ID this incentive is for.
	 * @param string $country_code                The business location country code to get incentives for.
	 * @param bool   $skip_extension_active_check Whether to skip the check for the extension plugin being active.
	 *
	 * @return bool Whether there is a visible incentive for the suggestion.
	 */
	public function is_incentive_visible(
		string $incentive_id,
		string $suggestion_id,
		string $country_code,
		bool $skip_extension_active_check = false
	): bool {
		$provider = $this->get_incentive_instance( $suggestion_id );
		if ( null === $provider ) {
			return false;
		}

return $provider->is_visible( $incentive_id, $country_code, $skip_extension_active_check );
	}

/**
	 * Check if an incentive has been dismissed for a specific payment extension suggestion.
	 *
	 * @param string $incentive_id  The incentive ID.
	 * @param string $suggestion_id The suggestion ID.
	 * @param string $context       Optional. The context ID in which the incentive is checked.
	 *
	 * @return bool Whether the incentive has been dismissed for the suggestion.
	 */
	public function is_incentive_dismissed( string $incentive_id, string $suggestion_id, string $context = '' ): bool {
		$provider = $this->get_incentive_instance( $suggestion_id );
		if ( null === $provider ) {
			return false;
		}

return $provider->is_dismissed( $incentive_id, $context );
	}

/**
	 * Get the dismissals (contexts) for an incentive.
	 *
	 * @param string $incentive_id The incentive ID.
	 * @param string $suggestion_id The suggestion ID.
	 *
	 * @return string[] The contexts in which the incentive has been dismissed.
	 */
	public function get_incentive_dismissals( string $incentive_id, string $suggestion_id ): array {
		$provider = $this->get_incentive_instance( $suggestion_id );
		if ( null === $provider ) {
			return array();
		}

return $provider->get_dismissals( $incentive_id );
	}

/**
	 * Dismiss an incentive for a specific payment extension suggestion.
	 *
	 * @param string $incentive_id  The incentive ID.
	 * @param string $suggestion_id The suggestion ID.
	 * @param string $context       Optional. The context ID for which the incentive should be dismissed.
	 *                              If not provided, the incentive will be dismissed for all contexts.
	 *
	 * @return bool True if the incentive was not previously dismissed and now it is. False otherwise.
	 * @throws \Exception If no incentives provider is available for the suggestion.
	 */
	public function dismiss_incentive( string $incentive_id, string $suggestion_id, string $context = 'all' ): bool {
		$provider = $this->get_incentive_instance( $suggestion_id );
		if ( null === $provider ) {
			throw new \Exception( 'No incentives provider for the suggestion.' );
		}

return $provider->dismiss( $incentive_id, $context );
	}

/**
	 * Get the incentive provider instance for a specific payment extension suggestion.
	 *
	 * @param string $suggestion_id The suggestion ID.
	 *
	 * @return ?Incentive The incentives provider instance for the suggestion.
	 *                    Returns null if no provider is available for the suggestion.
	 */
	public function get_incentive_instance( string $suggestion_id ): ?Incentive {
		if ( isset( $this->instances[ $suggestion_id ] ) ) {
			return $this->instances[ $suggestion_id ];
		}

// If the suggestion ID is not mapped to an incentives provider class, return null.
		if ( ! isset( $this->suggestion_incentives_class_map[ $suggestion_id ] ) ) {
			$this->instances[ $suggestion_id ] = null;

return null;
		}

// Create an instance of the incentives provider class.
		$provider_class                    = $this->suggestion_incentives_class_map[ $suggestion_id ];
		$this->instances[ $suggestion_id ] = new $provider_class( $suggestion_id );

return $this->instances[ $suggestion_id ];
	}

/**
	 * Check if a specific payment extension suggestion has an incentive provider registered.
	 *
	 * @param string $suggestion_id The suggestion ID.
	 *
	 * @return bool Whether the suggestion has an incentive provider registered.
	 */
	public function has_incentive_provider( string $suggestion_id ): bool {
		return null !== $this->get_incentive_instance( $suggestion_id );
	}
}