Automattic\WooCommerce\Admin\RemoteSpecs\RuleProcessors

PluginVersionRuleProcessor{} │ WC 1.0└─ RuleProcessorInterface

Rule processor for sending when the provided plugin is activated and matches the specified version.

Usage

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

Methods

1. public __construct( $plugins_provider = null )
2. public process( $rule, $stored_state )
3. public validate( $rule )

PluginVersionRuleProcessor{} PluginVersionRuleProcessor{} code ^{WC 10.3.3}

class PluginVersionRuleProcessor implements RuleProcessorInterface {

	/**
	 * Plugins provider instance.
	 *
	 * @var PluginsProviderInterface
	 */
	private $plugins_provider;


	/**
	 * Constructor.
	 *
	 * @param PluginsProviderInterface $plugins_provider The plugins provider.
	 */
	public function __construct( $plugins_provider = null ) {
		$this->plugins_provider = null === $plugins_provider
			? new PluginsProvider()
			: $plugins_provider;
	}

	/**
	 * Process the rule.
	 *
	 * @param object $rule         The specific rule being processed by this rule processor.
	 * @param object $stored_state Stored state.
	 *
	 * @return bool Whether the rule passes or not.
	 */
	public function process( $rule, $stored_state ) {
		$active_plugin_slugs = $this->plugins_provider->get_active_plugin_slugs();
		/**
		 * Filters a plugin dependency’s slug before matching to the WordPress.org slug format.
		 *
		 * @since 9.0.0
		 *
		 * @param string $plugin_name requested plugin name
		 */
		$plugin_name = apply_filters( 'wp_plugin_dependencies_slug', $rule->plugin );

		if ( ! in_array( $plugin_name, $active_plugin_slugs, true ) ) {
			return false;
		}

		$plugin_data = $this->plugins_provider->get_plugin_data( $plugin_name );

		if ( ! is_array( $plugin_data ) || ! array_key_exists( 'Version', $plugin_data ) ) {
			return false;
		}

		$plugin_version = $plugin_data['Version'];

		return version_compare( $plugin_version, $rule->version, $rule->operator );
	}

	/**
	 * Validates the rule.
	 *
	 * @param object $rule The rule to validate.
	 *
	 * @return bool Pass/fail.
	 */
	public function validate( $rule ) {
		if ( ! isset( $rule->plugin ) ) {
			return false;
		}

		if ( ! isset( $rule->version ) ) {
			return false;
		}

		if ( ! isset( $rule->operator ) ) {
			return false;
		}

		return true;
	}
}