RuleEvaluator.php — WooCommerce 10.9.4

woocommerce / src / Admin / RemoteSpecs / RuleProcessors / RuleEvaluator.php

woocommerce / src / Admin / RemoteSpecs / RuleProcessors Last commit date

RuleEvaluator.php

96 lines

1	<?php
2	/**
3	* Evaluate the given rules as an AND operation - return false early if a
4	* rule evaluates to false.
5	*/
6
7	namespace Automattic\WooCommerce\Admin\RemoteSpecs\RuleProcessors;
8
9	defined( 'ABSPATH' ) \|\| exit;
10
11	/**
12	* Evaluate the given rules as an AND operation - return false early if a
13	* rule evaluates to false.
14	*/
15	class RuleEvaluator {
16
17	/**
18	* GetRuleProcessor to use.
19	*
20	* @var GetRuleProcessor
21	*/
22	private $get_rule_processor;
23
24	/**
25	* Constructor.
26	*
27	* @param GetRuleProcessor $get_rule_processor The GetRuleProcessor to use.
28	*/
29	public function __construct( $get_rule_processor = null ) {
30	$this->get_rule_processor = null === $get_rule_processor
31	? new GetRuleProcessor()
32	: $get_rule_processor;
33	}
34
35	/**
36	* Evaluate the given rules as an AND operation - return false early if a
37	* rule evaluates to false.
38	*
39	* @param array\|object $rules The rule or rules being processed.
40	* @param object\|null $stored_state Stored state.
41	* @param array $logger_args Arguments for the rule evaluator logger. `slug` is required.
42	*
43	* @throws \InvalidArgumentException Thrown when $logger_args is missing slug.
44	*
45	* @return bool The result of the operation.
46	*/
47	public function evaluate( $rules, $stored_state = null, $logger_args = array() ) {
48
49	if ( is_bool( $rules ) ) {
50	return $rules;
51	}
52
53	if ( ! is_array( $rules ) ) {
54	$rules = array( $rules );
55	}
56
57	if ( 0 === count( $rules ) ) {
58	return false;
59	}
60
61	$evaluation_logger = null;
62
63	if ( count( $logger_args ) ) {
64	if ( ! array_key_exists( 'slug', $logger_args ) ) {
65	throw new \InvalidArgumentException( 'Missing required field: slug in $logger_args.' );
66	}
67
68	$source = isset( $logger_args['source'] ) ? $logger_args['source'] : null;
69
70	$evaluation_logger = new EvaluationLogger( $logger_args['slug'], $source );
71	}
72
73	foreach ( $rules as $rule ) {
74	if ( ! is_object( $rule ) ) {
75	$evaluation_logger && $evaluation_logger->add_result( 'rule not an object', false );
76	$evaluation_logger && $evaluation_logger->log();
77
78	return false;
79	}
80
81	$processor = $this->get_rule_processor->get_processor( $rule->type );
82	$processor_result = $processor->process( $rule, $stored_state );
83	$evaluation_logger && $evaluation_logger->add_result( $rule->type, $processor_result );
84
85	if ( ! $processor_result ) {
86	$evaluation_logger && $evaluation_logger->log();
87	return false;
88	}
89	}
90
91	$evaluation_logger && $evaluation_logger->log();
92
93	return true;
94	}
95	}
96