Completed
Push — milestone/2_0/react-ui ( 54c726...f44dc3 )
by
unknown
04:19
created

Fulfillable_Collection::when_collection()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 7
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
cc 1
eloc 6
c 0
b 0
f 0
nc 1
nop 2
dl 0
loc 7
ccs 0
cts 6
cp 0
crap 2
rs 9.4285
1
<?php
2
3
namespace Carbon_Fields\Container\Fulfillable;
4
5
use Carbon_Fields\Container\Condition\Factory;
6
use Carbon_Fields\Container\Fulfillable\Translator\Array_Translator;
7
use Carbon_Fields\Exception\Incorrect_Syntax_Exception;
8
9
class Fulfillable_Collection implements Fulfillable {
10
11
	/**
12
	 * Condition factory used to translated condition types
13
	 * 
14
	 * @var Factory
15
	 */
16
	protected $condition_factory;
17
18
	/**
19
	 * Array translator used to support array representations of fulfillables
20
	 * 
21
	 * @var Array_Translator
22
	 */
23
	protected $array_translator;
24
25
	/**
26
	 * Array of fulfillables in this collection
27
	 * 
28
	 * @var array<array>
29
	 */
30
	protected $fulfillables = array();
31
32
	/**
33
	 * Array of supported fulfillable comparisons
34
	 * 
35
	 * @var array<string>
36
	 */
37
	protected $supported_fulfillable_comparisons = array( 'AND', 'OR' );
38
39
	/**
40
	 * Array of allowed condition types which propagate to child collections
41
	 * 
42
	 * @var array<string>
43
	 */
44
	protected $condition_type_list = array();
45
46
	/**
47
	 * Whether the condition type list is a whitelist or a blacklist
48
	 * 
49
	 * @var bool
50
	 */
51
	protected $condition_type_list_whitelist = false;
52
53
	/**
54
	 * Constructor
55
	 * 
56
	 * @param Factory $condition_factory
57
	 * @param Array_Translator $array_translator
58
	 */
59
	public function __construct( Factory $condition_factory, Array_Translator $array_translator ) {
60
		$this->condition_factory = $condition_factory;
61
		$this->array_translator = $array_translator;
62
	}
63
64
	/**
65
	 * Get an array of the fulfillables in this collection
66
	 * 
67
	 * @return array<Fulfillable>
68
	 */
69 1
	public function get_fulfillables() {
70 1
		return $this->fulfillables;
71
	}
72
73
	/**
74
	 * Get array of allowed condition types
75
	 * 
76
	 * @return array<string>
77
	 */
78
	public function get_condition_type_list() {
79
		return $this->condition_type_list;
80
	}
81
82
	/**
83
	 * Set array of allowed condition types
84
	 * WARNING: this will NOT remove already added conditions which are no longer allowed
85
	 * 
86
	 * @param  array<string>          $condition_type_list
87
	 * @param  bool                   $whitelist
88
	 * @return Fulfillable_Collection $this
89
	 */
90
	public function set_condition_type_list( $condition_type_list, $whitelist ) {
91
		$this->condition_type_list_whitelist = $whitelist;
92
		$this->condition_type_list = $condition_type_list;
93
		$this->propagate_condition_type_list();
94
		return $this;
95
	}
96
97
	/**
98
	 * Check if conditions types list is a whitelist
99
	 * 
100
	 * @return bool
101
	 */
102
	public function is_condition_type_list_whitelist() {
103
		return $this->condition_type_list_whitelist;
104
	}
105
106
	/**
107
	 * Check if condition type is allowed
108
	 *
109
	 * @param  string $condition_type
110
	 * @return bool
111
	 */
112
	public function is_condition_type_allowed( $condition_type ) {
113
		$in_list = in_array( $condition_type, $this->get_condition_type_list() );
114
		if ( $this->is_condition_type_list_whitelist() ) {
115
			return $in_list;
116
		}
117
		return ! $in_list;
118
	}
119
120
	/**
121
	 * Propagate allowed condition types to child collections
122
	 */
123
	protected function propagate_condition_type_list() {
124
		$condition_type_list = $this->get_condition_type_list();
125
		$fulfillables = $this->get_fulfillables();
126
		foreach ( $fulfillables as $fulfillable ) {
127
			if ( is_a( $fulfillable['fulfillable'], get_class() ) ) {
128
				$fulfillable->set_condition_type_list( $condition_type_list, $this->is_condition_type_list_whitelist() );
129
			}
130
		}
131
	}
132
	
133
	/**
134
	 * Shorthand for where with OR comparison
135
	 * 
136
	 * @param  string|array|callable  $condition_type
137
	 * @param  string                 $comparison_operator Can be skipped. Defaults to "="
138
	 * @param  mixed                  $value
139
	 * @return Fulfillable_Collection $this
140
	 */
141
	public function or_where( $condition_type, $comparison_operator = '=', $value = null ) {
142
		$this->where( $condition_type, $comparison_operator, $value, 'OR' );
143
		return $this;
144
	}
145
146
	/**
147
	 * Add fulfillable with optional comparison_operator
148
	 * This method assumes there is no fulfillable that can be compared with literal NULL
149
	 * 
150
	 * @param  string|array|callable  $condition_type
151
	 * @param  string                 $comparison_operator Can be skipped. Defaults to "="
152
	 * @param  mixed                  $value
153
	 * @param  string                 $fulfillable_comparison
154
	 * @return Fulfillable_Collection $this
155
	 */
156 9
	public function where( $condition_type, $comparison_operator = '=', $value = null, $fulfillable_comparison = 'AND' ) {
157 9
		if ( is_array( $condition_type ) ) {
158 2
			return $this->where_array( $condition_type, $fulfillable_comparison );
159
		}
160
161 7
		if ( is_callable( $condition_type ) ) {
162 2
			return $this->where_collection( $condition_type, $fulfillable_comparison );
163
		}
164
165 7
		if ( ! $this->is_condition_type_allowed( $condition_type ) ) {
166
			Incorrect_Syntax_Exception::raise( 'Unsupported container condition used: ' . $condition_type );
167
			return $this;
168
		}
169
170 7
		if ( $value === null ) {
171
			// We do not have a supplied comparison_operator so we default to "="
172 5
			$value = $comparison_operator;
173 5
			$comparison_operator = '=';
174 5
		}
175
176 7
		$condition = $this->condition_factory->make( $condition_type );
177 6
		$condition->set_comparison_operator( $comparison_operator );
178 6
		$condition->set_value( $value );
179 6
		$this->add_fulfillable( $condition, $fulfillable_comparison );
180 6
		return $this;
181
	}
182
183
	/**
184
	 * Add a Fulfillable through array representation
185
	 *
186
	 * @param  array                  $fulfillable_as_array
187
	 * @param  string                 $fulfillable_comparison
188
	 * @return Fulfillable_Collection $this
189
	 */
190
	protected function where_array( $fulfillable_as_array, $fulfillable_comparison) {
191
		$fulfillable = $this->array_translator->foreign_to_fulfillable( $fulfillable_as_array );
192
		$this->add_fulfillable( $fulfillable, $fulfillable_comparison );
193
		return $this;
194
	}
195
196
	/**
197
	 * Add a Fulfillable_Collection for nested logic
198
	 *
199
	 * @param  callable               $collection_callable
200
	 * @param  string                 $fulfillable_comparison
201
	 * @return Fulfillable_Collection $this
202
	 */
203
	protected function where_collection( $collection_callable, $fulfillable_comparison) {
204
		$collection = \Carbon_Fields\Carbon_Fields::resolve( 'container_condition_fulfillable_collection' );
205
		$collection->set_condition_type_list( $this->get_condition_type_list(), $this->is_condition_type_list_whitelist() );
206
		$collection_callable( $collection );
207
		$this->add_fulfillable( $collection, $fulfillable_comparison );
208
		return $this;
209
	}
210
211
	/**
212
	 * Add fulfillable to collection
213
	 * 
214
	 * @param Fulfillable $fulfillable
215
	 * @param string      $fulfillable_comparison See static::$supported_fulfillable_comparisons
216
	 */
217 2
	public function add_fulfillable( Fulfillable $fulfillable, $fulfillable_comparison ) {
218 2
		if ( ! in_array( $fulfillable_comparison, $this->supported_fulfillable_comparisons ) ) {
219 1
			Incorrect_Syntax_Exception::raise( 'Invalid fulfillable comparison passed: ' . $fulfillable_comparison );
220
			return;
221
		}
222
223 1
		$this->fulfillables[] = array(
224 1
			'fulfillable_comparison' => $fulfillable_comparison,
225 1
			'fulfillable' => $fulfillable,
226
		);
227 1
	}
228
229
	/**
230
	 * Remove fulfillable from collection
231
	 * 
232
	 * @param Fulfillable $fulfillable
233
	 * @return bool Fulfillable found and removed
234
	 */
235
	public function remove_fulfillable( Fulfillable $fulfillable ) {
236
		$fulfillables = $this->get_fulfillables();
237
		foreach ( $fulfillables as $index => $fulfillable_tuple ) {
238
			if ( $fulfillable_tuple['fulfillable'] === $fulfillable ) {
239
				$fulfillables_copy = $fulfillables; // introduce a copy array to highlight array_splice mutation
240
				array_splice( $fulfillables_copy, $index, 1 );
241
				$this->fulfillables = array_values( $fulfillables_copy ); // make sure our array is indexed cleanly
242
				return true;
243
			}
244
		}
245
		return false;
246
	}
247
248
	/**
249
	 * Get a copy of the collection with conditions not in the whitelist filtered out
250
	 * 
251
	 * @param  array<string>          $condition_whitelist
252
	 * @return Fulfillable_Collection
253
	 */
254 2
	public function filter( $condition_whitelist ) {
255 2
		$fulfillables = $this->get_fulfillables();
256
257 2
		$collection = \Carbon_Fields\Carbon_Fields::resolve( 'container_condition_fulfillable_collection' );
258 2
		foreach ( $fulfillables as $fulfillable_tuple ) {
259 2
			$fulfillable = $fulfillable_tuple['fulfillable'];
260 2
			$fulfillable_comparison = $fulfillable_tuple['fulfillable_comparison'];
261
262 2
			if ( is_a( $fulfillable, get_class() ) ) {
263 1
				$filtered_collection = $fulfillable->filter( $condition_whitelist );
264 1
				$filtered_collection_fulfillables = $filtered_collection->get_fulfillables();
265 1
				if ( empty( $filtered_collection_fulfillables ) ) {
266 1
					continue; // skip empty collections to reduce clutter
267
				}
268
				$collection->add_fulfillable( $filtered_collection, $fulfillable_comparison );
269
			} else {
270 2
				$type = $this->condition_factory->get_type( get_class( $fulfillable ) );
271 2
				if ( ! in_array( $type, $condition_whitelist ) ) {
272 2
					continue;
273
				}
274
275 2
				$fulfillable_clone = clone $fulfillable;
276 2
				$collection->add_fulfillable( $fulfillable_clone, $fulfillable_comparison );
277
			}
278 2
		}
279 2
		return $collection;
280
	}
281
282
	/**
283
	 * Get a copy of the collection with passed conditions evaluated into boolean conditions
284
	 * Useful when evaluating only certain condition types but preserving the rest
285
	 * or when passing dynamic conditions to the front-end
286
	 * 
287
	 * @param  array<string>          $condition_types
288
	 * @param  array|boolean          $environment Environment array or a boolean value to force on conditions
289
	 * @param  array                  $comparison_operators Array of comparison operators to evaluate regardless of condition type
290
	 * @return Fulfillable_Collection
291
	 */
292 3
	public function evaluate( $condition_types, $environment, $comparison_operators = array() ) {
293 3
		$fulfillables = $this->get_fulfillables();
294
295 3
		$collection = \Carbon_Fields\Carbon_Fields::resolve( 'container_condition_fulfillable_collection' );
296 3
		foreach ( $fulfillables as $fulfillable_tuple ) {
297 3
			$fulfillable = $fulfillable_tuple['fulfillable'];
298 3
			$fulfillable_comparison = $fulfillable_tuple['fulfillable_comparison'];
299
300 3
			if ( is_a( $fulfillable, get_class() ) ) {
301
				$evaluated_collection = $fulfillable->evaluate( $condition_types, $environment, $comparison_operators );
302
				$collection->add_fulfillable( $evaluated_collection, $fulfillable_comparison );
303
			} else {
304 3
				$type = $this->condition_factory->get_type( get_class( $fulfillable ) );
305 3
				$comparison_operator = $fulfillable->get_comparison_operator();
306 3
				if ( in_array( $type, $condition_types ) || in_array( $comparison_operator, $comparison_operators ) ) {
307 3
					$boolean_condition = \Carbon_Fields\Carbon_Fields::resolve( 'container_condition_type_boolean' );
308 3
					$boolean_condition->set_comparison_operator( '=' );
309
310 3
					$value = is_bool( $environment ) ? $environment : $fulfillable->is_fulfilled( $environment );
311 3
					$boolean_condition->set_value( $value );
312 3
					$collection->add_fulfillable( $boolean_condition, $fulfillable_comparison );
313 3
				} else {
314 3
					$collection->add_fulfillable( clone $fulfillable, $fulfillable_comparison );
315
				}
316
			}
317 3
		}
318 3
		return $collection;
319
	}
320
	
321
	/**
322
	 * Check if all fulfillables are fulfilled taking into account their fulfillable comparison
323
	 * 
324
	 * @param  array $environment
325
	 * @return bool
326
	 */
327 14
	public function is_fulfilled( $environment ) {
328 14
		$fulfilled = true; // return true for empty collections
329 14
		$fulfillables = $this->get_fulfillables();
330
331 14
		foreach ( $fulfillables as $i => $fulfillable_tuple ) {
332 13
			$fulfillable = $fulfillable_tuple['fulfillable'];
333 13
			$fulfillable_comparison = $fulfillable_tuple['fulfillable_comparison'];
334
335 13
			if ( $i === 0 ) {
336
				// Ignore first comparison as we need a base fulfillment value
337 13
				$fulfilled = $fulfillable->is_fulfilled( $environment );
338 13
				continue;
339
			}
340
341
			// minor optimization - avoid unnecessary AND check if $fulfilled is currently false
342
			// false && whatever is always false
343 4
			if ( $fulfillable_comparison === 'AND' && $fulfilled ) {
344 2
				$fulfilled = $fulfillable->is_fulfilled( $environment );
345 2
			}
346
347
			// minor optimization - avoid unnecessary OR check if $fulfilled is currently true
348
			// true || whatever is always true
349 4
			if ( $fulfillable_comparison === 'OR' && ! $fulfilled ) {
350 1
				$fulfilled = $fulfillable->is_fulfilled( $environment );
351 1
			}
352 14
		}
353
354 14
		return $fulfilled;
355
	}
356
}