HasConditions.php
5.57 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<?php
/**
* @license GPL-2.0-or-later
*
* Modified by learndash on 20-September-2023 using Strauss.
* @see https://github.com/BrianHenryIE/strauss
*/
declare(strict_types=1);
namespace StellarWP\Learndash\StellarWP\FieldConditions\Concerns;
use Closure;
use StellarWP\Learndash\StellarWP\FieldConditions\Config;
use StellarWP\Learndash\StellarWP\FieldConditions\Contracts\Condition;
use StellarWP\Learndash\StellarWP\FieldConditions\Contracts\ConditionSet;
use StellarWP\Learndash\StellarWP\FieldConditions\FieldCondition;
use StellarWP\Learndash\StellarWP\FieldConditions\NestedCondition;
/**
* @template C of Condition
* @template-extends ConditionSet<C>
*/
trait HasConditions
{
/**
* @var array<C>
*/
protected $conditions = [];
/**
* Append condition instances to the end of the conditions array.
*
* @since 1.0.0
*
* @param Condition ...$conditions
*/
public function append(...$conditions)
{
foreach ($conditions as $condition) {
$this->validateCondition($condition);
$this->conditions[] = $condition;
}
}
/**
* Returns all internal conditions.
*
* @since 1.0.0
*
* @return array<C>
*/
public function getConditions(): array
{
return $this->conditions;
}
/**
* Returns whether the condition set has any conditions.
*
* @since 1.1.0
*/
public function hasConditions(): bool
{
return ! empty($this->conditions);
}
/**
* @since 1.1.1 return ConditionSet type for PHP 7.0 compatibility
* @since 1.0.0
*
* @param string|C|Closure $condition
* @param string|null $comparisonOperator
* @param mixed|null $value
*/
public function where($condition, string $comparisonOperator = null, $value = null): ConditionSet
{
return $this->and($condition, $comparisonOperator, $value);
}
/**
* @since 1.1.1 return ConditionSet type for PHP 7.0 compatibility
* @since 1.0.0
*
* @param string|C|Closure $condition
* @param string|null $comparisonOperator
* @param mixed|null $value
*/
public function and($condition, string $comparisonOperator = null, $value = null): ConditionSet
{
$this->conditions[] = $this->createCondition($condition, $comparisonOperator, $value, 'and');
return $this;
}
/**
* @since 1.1.1 return ConditionSet type for PHP 7.0 compatibility
* @since 1.0.0
*
* @param string|C|Closure $condition
* @param string|null $comparisonOperator
* @param mixed|null $value
*/
public function or($condition, string $comparisonOperator = null, $value = null): ConditionSet
{
$this->conditions[] = $this->createCondition($condition, $comparisonOperator, $value, 'or');
return $this;
}
/**
* @param C|Closure|string $condition
* @param string|null $comparisonOperator
* @param mixed $value
* @param string $logicalOperator
*
* @return Condition|FieldCondition|NestedCondition
*/
private function createCondition($condition, string $comparisonOperator = null, $value = null, string $logicalOperator = null)
{
$baseConditionClass = static::getBaseConditionClass();
if ($condition instanceof $baseConditionClass) {
return $condition;
}
if ($condition instanceof Closure) {
$nestedCondition = new NestedCondition([], $logicalOperator);
$condition($nestedCondition);
return $nestedCondition;
}
return new FieldCondition($condition, $comparisonOperator, $value, $logicalOperator);
}
/**
* @since 1.0.0
*/
public function passes(array $values): bool
{
return array_reduce(
$this->conditions,
static function ($carry, Condition $condition) use ($values) {
return $condition->getLogicalOperator() === 'and'
? $carry && $condition->passes($values)
: $carry || $condition->passes($values);
},
true
);
}
/**
* @since 1.0.0
*/
public function fails(array $values): bool
{
return ! $this->passes($values);
}
/**
* Returns the Condition interface/class used as the base for this ConditionSet. By default, this is Condition,
* but this allows for creating a ConditionSet that only accepts a specific type of Condition.
*
* @since 1.0.0
*
* @return class-string<C>
*/
protected static function getBaseConditionClass(): string
{
return Condition::class;
}
/**
* Validates the condition based on the base condition class.
*
* @since 1.0.0
*
* @param $condition
*
* @return void
*/
protected function validateCondition($condition)
{
$baseConditionClass = static::getBaseConditionClass();
if ( ! $condition instanceof $baseConditionClass) {
Config::throwInvalidArgumentException(
sprintf(
'Condition must be an instance of %s, %s given.',
$baseConditionClass,
is_object($condition) ? get_class($condition) : gettype($condition)
)
);
}
}
/**
* Validates the conditions based on the base condition class.
*
* @since 1.0.0
*/
protected function validateConditions(array $conditions)
{
foreach ($conditions as $condition) {
$this->validateCondition($condition);
}
}
}