Automattic\WooCommerce\Admin\Features\PaymentGatewaySuggestions

EvaluateSuggestion{}WC 1.0

Evaluates the spec and returns the evaluated suggestion.

No Hooks.

Usage

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

Methods

  1. public static evaluate( $spec, $logger_args = array() )
  2. public static evaluate_specs( $specs, $logger_args = array() )
  3. private static get_memo_key( $specs )
  4. public static reset_memo()

EvaluateSuggestion{} code WC 9.6.1

class EvaluateSuggestion {
	/**
	 * Stores memoized results of evaluate_specs.
	 *
	 * @var array
	 */
	protected static $memo = array();

	/**
	 * Evaluates the spec and returns the suggestion.
	 *
	 * @param object|array $spec        The suggestion to evaluate.
	 * @param array        $logger_args Optional. Arguments for the rule evaluator logger.
	 *
	 * @return object The evaluated suggestion.
	 */
	public static function evaluate( $spec, $logger_args = array() ) {
		$rule_evaluator = new RuleEvaluator();
		$suggestion     = is_array( $spec ) ? (object) $spec : clone $spec;

		if ( isset( $suggestion->is_visible ) ) {
			// Determine the suggestion's logger slug.
			$logger_slug = ! empty( $suggestion->id ) ? $suggestion->id : '';
			// If the suggestion has no ID, use the title to generate a slug.
			if ( empty( $logger_slug ) ) {
				$logger_slug = ! empty( $suggestion->title ) ? sanitize_title_with_dashes( trim( $suggestion->title ) ) : 'anonymous-suggestion';
			}

			// Evaluate the visibility of the suggestion.
			$is_visible = $rule_evaluator->evaluate(
				$suggestion->is_visible,
				null,
				array(
					'slug'   => $logger_slug,
					'source' => $logger_args['source'] ?? 'wc-payment-gateway-suggestions',
				)
			);

			$suggestion->is_visible = $is_visible;
		}

		return $suggestion;
	}

	/**
	 * Evaluates the specs and returns the visible suggestions.
	 *
	 * @param array $specs payment suggestion spec array.
	 * @param array $logger_args Optional. Arguments for the rule evaluator logger.
	 *
	 * @return array The visible suggestions and errors.
	 */
	public static function evaluate_specs( $specs, $logger_args = array() ) {
		$specs_key = self::get_memo_key( $specs );

		if ( isset( self::$memo[ $specs_key ] ) ) {
			return self::$memo[ $specs_key ];
		}

		$suggestions = array();
		$errors      = array();

		foreach ( $specs as $spec ) {
			try {
				$suggestion = self::evaluate( $spec, $logger_args );
				if ( ! property_exists( $suggestion, 'is_visible' ) || $suggestion->is_visible ) {
					$suggestions[] = $suggestion;
				}
			} catch ( \Throwable $e ) {
				$errors[] = $e;
			}
		}

		$result = array(
			'suggestions' => $suggestions,
			'errors'      => $errors,
		);

		// Memoize results, with a fail safe to prevent unbounded memory growth.
		// This limit is unlikely to be reached under normal circumstances.
		if ( count( self::$memo ) > 50 ) {
			self::reset_memo();
		}
		self::$memo[ $specs_key ] = $result;

		return $result;
	}

	/**
	 * Resets the memoized results. Useful for testing.
	 */
	public static function reset_memo() {
		self::$memo = array();
	}

	/**
	 * Returns a memoization key for the given specs.
	 *
	 * @param array $specs The specs to generate a key for.
	 *
	 * @return string The memoization key.
	 */
	private static function get_memo_key( $specs ) {
		$data = wp_json_encode( $specs );

		if ( function_exists( 'hash' ) && in_array( 'xxh3', hash_algos(), true ) ) {
			// Use xxHash (xxh3) if available.
			return hash( 'xxh3', $data );
		}
		// Fall back to CRC32.
		return (string) crc32( $data );
	}
}