Completed
Pull Request — master (#21)
by James
03:38
created
src/Axolotl/Dictionary.php 1 patch
Indentation   +368 added lines, -368 removed lines patch added patch discarded remove patch
@@ -14,372 +14,372 @@
 block discarded – undo
14 14
  */
15 15
 class Dictionary implements DictionaryContract {
16 16
 
17
-	/**
18
-	 * Dictionary storage array.
19
-	 *
20
-	 * @var array
21
-	 */
22
-	protected $storage = array();
23
-
24
-	/**
25
-	 * Key Type service.
26
-	 *
27
-	 * @var Type
28
-	 */
29
-	protected $key_type;
30
-
31
-	/**
32
-	 * Value Type service.
33
-	 *
34
-	 * @var Type
35
-	 */
36
-	protected $val_type;
37
-
38
-	/**
39
-	 * Where Dictionary is in loop.
40
-	 *
41
-	 * @var int
42
-	 */
43
-	protected $position = 0;
44
-
45
-	/**
46
-	 * Dictionary keys.
47
-	 *
48
-	 * @var array
49
-	 */
50
-	protected $keys = array();
51
-
52
-	/**
53
-	 * Dictionary constructor.
54
-	 *
55
-	 * @param string $key_type
56
-	 * @param string $val_type
57
-	 * @param array  $storage
58
-	 *
59
-	 * @throws InvalidArgumentException
60
-	 */
61
-	public function __construct( $key_type, $val_type, array $storage = array() ) {
62
-		$this->key_type = new Type( $key_type, true );
63
-		$this->val_type = new Type( $val_type );
64
-
65
-		foreach ( $storage as $key => $val ) {
66
-			$this->key_type->validate_element( $key );
67
-			$this->val_type->validate_element( $val );
68
-
69
-			$this->storage[ $key ] = $val;
70
-		}
71
-	}
72
-
73
-	/**
74
-	 * {@inheritdoc}
75
-	 *
76
-	 * @return string
77
-	 */
78
-	public function get_key_type() {
79
-		return $this->key_type->get_type();
80
-	}
81
-
82
-	/**
83
-	 * {@inheritdoc}
84
-	 *
85
-	 * @return string
86
-	 */
87
-	public function get_value_type() {
88
-		return $this->val_type->get_type();
89
-	}
90
-
91
-	/**
92
-	 * {@inheritdoc}
93
-	 *
94
-	 * @param mixed $key Key to check.
95
-	 *
96
-	 * @return bool
97
-	 */
98
-	public function exists( $key ) {
99
-		return array_key_exists( $key, $this->storage );
100
-	}
101
-
102
-	/**
103
-	 * {@inheritdoc}
104
-	 *
105
-	 * @param mixed $key Key to get.
106
-	 *
107
-	 * @return mixed|null
108
-	 */
109
-	public function get( $key ) {
110
-		return $this->exists( $key ) ? $this->storage[ $key ] : null;
111
-	}
112
-
113
-	/**
114
-	 * {@inheritdoc}
115
-	 *
116
-	 * @param mixed $key Key to remove.
117
-	 *
118
-	 * @return DictionaryContract
119
-	 */
120
-	public function delete( $key ) {
121
-		$storage = $this->storage;
122
-		if ( $this->exists( $key ) ) {
123
-			unset( $storage[ $key ] );
124
-		}
125
-
126
-		return new static( $this->get_key_type(), $this->get_value_type(), $storage );
127
-	}
128
-
129
-	/**
130
-	 * {@inheritdoc}
131
-	 *
132
-	 * @param mixed $value Value to validate.
133
-	 *
134
-	 * @return bool
135
-	 */
136
-	public function value_exists( $value ) {
137
-		return in_array( $value, $this->storage );
138
-	}
139
-
140
-	/**
141
-	 * {@inheritdoc}
142
-	 */
143
-	public function count() {
144
-		return count( $this->storage );
145
-	}
146
-
147
-	/**
148
-	 * {@inheritdoc}
149
-	 */
150
-	public function clear() {
151
-		return new static( $this->get_key_type(), $this->get_value_type() );
152
-	}
153
-
154
-	/**
155
-	 * {@inheritdoc}
156
-	 *
157
-	 * @return array
158
-	 */
159
-	public function to_array() {
160
-		return $this->storage;
161
-	}
162
-
163
-	/**
164
-	 * {@inheritdoc}
165
-	 *
166
-	 * @param callable $condition Conditional callback.
167
-	 *
168
-	 * @return DictionaryContract
169
-	 */
170
-	public function filter( $condition ) {
171
-		$storage = array();
172
-
173
-		foreach ( $this->storage as $key => $value ) {
174
-			if ( call_user_func( $condition, $value, $key ) ) {
175
-				$storage[ $key ] = $value;
176
-			}
177
-		}
178
-
179
-		return new static( $this->get_key_type(), $this->get_value_type(), $storage );
180
-	}
181
-
182
-	/**
183
-	 * {@inheritdoc}
184
-	 *
185
-	 * @param callable $condition Callback condition.
186
-	 *
187
-	 * @return DictionaryContract
188
-	 */
189
-	public function reject( $condition ) {
190
-		return $this->filter( function ( $v, $k ) use ( $condition ) {
191
-			return ! call_user_func( $condition, $v, $k );
192
-		} );
193
-	}
194
-
195
-	/**
196
-	 * {@inheritdoc}
197
-	 *
198
-	 * @param mixed $key   Key to add.
199
-	 * @param mixed $value Value to add.
200
-	 *
201
-	 * @return DictionaryContract
202
-	 */
203
-	public function add( $key, $value ) {
204
-		$storage         = $this->storage;
205
-		$storage[ $key ] = $value;
206
-
207
-		return new static( $this->get_key_type(), $this->get_value_type(), $storage );
208
-	}
209
-
210
-	/**
211
-	 * {@inheritdoc}
212
-	 *
213
-	 * @param callable $callable Function to call.
214
-	 */
215
-	public function each( $callable ) {
216
-		foreach ( $this->storage as $key => $value ) {
217
-			call_user_func( $callable, $value, $key );
218
-		}
219
-	}
220
-
221
-	/**
222
-	 * {@inheritdoc}
223
-	 *
224
-	 * @param mixed $key     Key to fetch.
225
-	 * @param mixed $default Default to return if key is missing.
226
-	 *
227
-	 * @return mixed
228
-	 */
229
-	public function get_or_else( $key, $default ) {
230
-		return ( $this->exists( $key ) ) ? $this->get( $key ) : $default;
231
-	}
232
-
233
-	/**
234
-	 * {@inheritdoc}
235
-	 */
236
-	public function keys() {
237
-		return array_keys( $this->storage );
238
-	}
239
-
240
-	/**
241
-	 * {@inheritdoc}
242
-	 */
243
-	public function values() {
244
-		return array_values( $this->storage );
245
-	}
246
-
247
-	/**
248
-	 * {@inheritdoc}
249
-	 *
250
-	 * @param callable $callable Function to call.
251
-	 *
252
-	 * @return DictionaryContract
253
-	 */
254
-	public function map( $callable ) {
255
-		$items = array();
256
-		$val_type = null;
257
-
258
-		foreach ( $this->storage as $key => $val ) {
259
-			$v = call_user_func( $callable, $val, $key );
260
-
261
-			if ( ! isset( $val_type ) ) {
262
-				$val_type = gettype( $v );
263
-			}
264
-
265
-			$items[ $key ] = $v;
266
-		}
267
-
268
-		return new static( $this->get_key_type(), $val_type ? : $this->get_value_type(), $items );
269
-	}
270
-
271
-	/**
272
-	 * {@inheritdoc}
273
-	 *
274
-	 * @param array|DictionaryContract $source Source to merge.
275
-	 *
276
-	 * @return DictionaryContract
277
-	 *
278
-	 * @throws InvalidArgumentException
279
-	 */
280
-	public function merge( $source ) {
281
-		if ( $source instanceof self ) {
282
-			$source = $source->to_array();
283
-		}
284
-
285
-		if ( ! is_array( $source ) ) {
286
-			throw new InvalidArgumentException( 'Combine must be a Dictionary or an array' );
287
-		}
288
-
289
-		return new static( $this->get_key_type(), $this->get_value_type(), array_merge( $this->storage, $source ) );
290
-	}
291
-
292
-
293
-	/**
294
-	 * {@inheritdoc}
295
-	 *
296
-	 * @param callable $callable
297
-	 *
298
-	 * @return bool
299
-	 */
300
-	public function contains( $callable ) {
301
-		foreach ( $this->storage as $key => $value ) {
302
-			if ( call_user_func( $callable, $value, $key ) ) {
303
-				return true;
304
-			}
305
-		}
306
-
307
-		return false;
308
-	}
309
-
310
-	/**
311
-	 * {@inheritdoc}
312
-	 *
313
-	 * @param callable $callable
314
-	 * @param mixed    $initial
315
-	 *
316
-	 * @return mixed
317
-	 */
318
-	public function reduce( $callable, $initial ) {
319
-		$carry = $initial;
320
-
321
-		foreach ( $this->storage as $key => $value ) {
322
-			$carry = $callable( $carry, $value, $key );
323
-		}
324
-
325
-		return $carry;
326
-	}
327
-
328
-	/**
329
-	 * Return the current element.
330
-	 *
331
-	 * @return mixed
332
-	 */
333
-	public function current() {
334
-		$key = $this->keys[ $this->position ];
335
-		return $this->storage[ $key ];
336
-	}
337
-
338
-	/**
339
-	 * Move forward to next element.
340
-	 */
341
-	public function next() {
342
-		$this->position ++;
343
-	}
344
-
345
-	/**
346
-	 * Return the key of the current element.
347
-	 *
348
-	 * @return mixed
349
-	 */
350
-	public function key() {
351
-		return $this->keys[ $this->position ];
352
-	}
353
-
354
-	/**
355
-	 * Checks if current position is valid.
356
-	 *
357
-	 * @return bool
358
-	 */
359
-	public function valid() {
360
-		return isset( $this->keys[ $this->position ] );
361
-	}
362
-
363
-	/**
364
-	 * Rewind the Iterator to the first element.
365
-	 */
366
-	public function rewind() {
367
-		$this->position = 0;
368
-		$this->keys = array_keys( $this->storage );
369
-	}
370
-
371
-	/**
372
-	 * {@inheritDoc}
373
-	 *
374
-	 * @return array
375
-	 */
376
-	public function serialize() {
377
-		return $this->map(function( $val ) {
378
-			if ( $val instanceof Serializes ) {
379
-				$val = $val->serialize();
380
-			}
381
-
382
-			return $val;
383
-		})->to_array();
384
-	}
17
+    /**
18
+     * Dictionary storage array.
19
+     *
20
+     * @var array
21
+     */
22
+    protected $storage = array();
23
+
24
+    /**
25
+     * Key Type service.
26
+     *
27
+     * @var Type
28
+     */
29
+    protected $key_type;
30
+
31
+    /**
32
+     * Value Type service.
33
+     *
34
+     * @var Type
35
+     */
36
+    protected $val_type;
37
+
38
+    /**
39
+     * Where Dictionary is in loop.
40
+     *
41
+     * @var int
42
+     */
43
+    protected $position = 0;
44
+
45
+    /**
46
+     * Dictionary keys.
47
+     *
48
+     * @var array
49
+     */
50
+    protected $keys = array();
51
+
52
+    /**
53
+     * Dictionary constructor.
54
+     *
55
+     * @param string $key_type
56
+     * @param string $val_type
57
+     * @param array  $storage
58
+     *
59
+     * @throws InvalidArgumentException
60
+     */
61
+    public function __construct( $key_type, $val_type, array $storage = array() ) {
62
+        $this->key_type = new Type( $key_type, true );
63
+        $this->val_type = new Type( $val_type );
64
+
65
+        foreach ( $storage as $key => $val ) {
66
+            $this->key_type->validate_element( $key );
67
+            $this->val_type->validate_element( $val );
68
+
69
+            $this->storage[ $key ] = $val;
70
+        }
71
+    }
72
+
73
+    /**
74
+     * {@inheritdoc}
75
+     *
76
+     * @return string
77
+     */
78
+    public function get_key_type() {
79
+        return $this->key_type->get_type();
80
+    }
81
+
82
+    /**
83
+     * {@inheritdoc}
84
+     *
85
+     * @return string
86
+     */
87
+    public function get_value_type() {
88
+        return $this->val_type->get_type();
89
+    }
90
+
91
+    /**
92
+     * {@inheritdoc}
93
+     *
94
+     * @param mixed $key Key to check.
95
+     *
96
+     * @return bool
97
+     */
98
+    public function exists( $key ) {
99
+        return array_key_exists( $key, $this->storage );
100
+    }
101
+
102
+    /**
103
+     * {@inheritdoc}
104
+     *
105
+     * @param mixed $key Key to get.
106
+     *
107
+     * @return mixed|null
108
+     */
109
+    public function get( $key ) {
110
+        return $this->exists( $key ) ? $this->storage[ $key ] : null;
111
+    }
112
+
113
+    /**
114
+     * {@inheritdoc}
115
+     *
116
+     * @param mixed $key Key to remove.
117
+     *
118
+     * @return DictionaryContract
119
+     */
120
+    public function delete( $key ) {
121
+        $storage = $this->storage;
122
+        if ( $this->exists( $key ) ) {
123
+            unset( $storage[ $key ] );
124
+        }
125
+
126
+        return new static( $this->get_key_type(), $this->get_value_type(), $storage );
127
+    }
128
+
129
+    /**
130
+     * {@inheritdoc}
131
+     *
132
+     * @param mixed $value Value to validate.
133
+     *
134
+     * @return bool
135
+     */
136
+    public function value_exists( $value ) {
137
+        return in_array( $value, $this->storage );
138
+    }
139
+
140
+    /**
141
+     * {@inheritdoc}
142
+     */
143
+    public function count() {
144
+        return count( $this->storage );
145
+    }
146
+
147
+    /**
148
+     * {@inheritdoc}
149
+     */
150
+    public function clear() {
151
+        return new static( $this->get_key_type(), $this->get_value_type() );
152
+    }
153
+
154
+    /**
155
+     * {@inheritdoc}
156
+     *
157
+     * @return array
158
+     */
159
+    public function to_array() {
160
+        return $this->storage;
161
+    }
162
+
163
+    /**
164
+     * {@inheritdoc}
165
+     *
166
+     * @param callable $condition Conditional callback.
167
+     *
168
+     * @return DictionaryContract
169
+     */
170
+    public function filter( $condition ) {
171
+        $storage = array();
172
+
173
+        foreach ( $this->storage as $key => $value ) {
174
+            if ( call_user_func( $condition, $value, $key ) ) {
175
+                $storage[ $key ] = $value;
176
+            }
177
+        }
178
+
179
+        return new static( $this->get_key_type(), $this->get_value_type(), $storage );
180
+    }
181
+
182
+    /**
183
+     * {@inheritdoc}
184
+     *
185
+     * @param callable $condition Callback condition.
186
+     *
187
+     * @return DictionaryContract
188
+     */
189
+    public function reject( $condition ) {
190
+        return $this->filter( function ( $v, $k ) use ( $condition ) {
191
+            return ! call_user_func( $condition, $v, $k );
192
+        } );
193
+    }
194
+
195
+    /**
196
+     * {@inheritdoc}
197
+     *
198
+     * @param mixed $key   Key to add.
199
+     * @param mixed $value Value to add.
200
+     *
201
+     * @return DictionaryContract
202
+     */
203
+    public function add( $key, $value ) {
204
+        $storage         = $this->storage;
205
+        $storage[ $key ] = $value;
206
+
207
+        return new static( $this->get_key_type(), $this->get_value_type(), $storage );
208
+    }
209
+
210
+    /**
211
+     * {@inheritdoc}
212
+     *
213
+     * @param callable $callable Function to call.
214
+     */
215
+    public function each( $callable ) {
216
+        foreach ( $this->storage as $key => $value ) {
217
+            call_user_func( $callable, $value, $key );
218
+        }
219
+    }
220
+
221
+    /**
222
+     * {@inheritdoc}
223
+     *
224
+     * @param mixed $key     Key to fetch.
225
+     * @param mixed $default Default to return if key is missing.
226
+     *
227
+     * @return mixed
228
+     */
229
+    public function get_or_else( $key, $default ) {
230
+        return ( $this->exists( $key ) ) ? $this->get( $key ) : $default;
231
+    }
232
+
233
+    /**
234
+     * {@inheritdoc}
235
+     */
236
+    public function keys() {
237
+        return array_keys( $this->storage );
238
+    }
239
+
240
+    /**
241
+     * {@inheritdoc}
242
+     */
243
+    public function values() {
244
+        return array_values( $this->storage );
245
+    }
246
+
247
+    /**
248
+     * {@inheritdoc}
249
+     *
250
+     * @param callable $callable Function to call.
251
+     *
252
+     * @return DictionaryContract
253
+     */
254
+    public function map( $callable ) {
255
+        $items = array();
256
+        $val_type = null;
257
+
258
+        foreach ( $this->storage as $key => $val ) {
259
+            $v = call_user_func( $callable, $val, $key );
260
+
261
+            if ( ! isset( $val_type ) ) {
262
+                $val_type = gettype( $v );
263
+            }
264
+
265
+            $items[ $key ] = $v;
266
+        }
267
+
268
+        return new static( $this->get_key_type(), $val_type ? : $this->get_value_type(), $items );
269
+    }
270
+
271
+    /**
272
+     * {@inheritdoc}
273
+     *
274
+     * @param array|DictionaryContract $source Source to merge.
275
+     *
276
+     * @return DictionaryContract
277
+     *
278
+     * @throws InvalidArgumentException
279
+     */
280
+    public function merge( $source ) {
281
+        if ( $source instanceof self ) {
282
+            $source = $source->to_array();
283
+        }
284
+
285
+        if ( ! is_array( $source ) ) {
286
+            throw new InvalidArgumentException( 'Combine must be a Dictionary or an array' );
287
+        }
288
+
289
+        return new static( $this->get_key_type(), $this->get_value_type(), array_merge( $this->storage, $source ) );
290
+    }
291
+
292
+
293
+    /**
294
+     * {@inheritdoc}
295
+     *
296
+     * @param callable $callable
297
+     *
298
+     * @return bool
299
+     */
300
+    public function contains( $callable ) {
301
+        foreach ( $this->storage as $key => $value ) {
302
+            if ( call_user_func( $callable, $value, $key ) ) {
303
+                return true;
304
+            }
305
+        }
306
+
307
+        return false;
308
+    }
309
+
310
+    /**
311
+     * {@inheritdoc}
312
+     *
313
+     * @param callable $callable
314
+     * @param mixed    $initial
315
+     *
316
+     * @return mixed
317
+     */
318
+    public function reduce( $callable, $initial ) {
319
+        $carry = $initial;
320
+
321
+        foreach ( $this->storage as $key => $value ) {
322
+            $carry = $callable( $carry, $value, $key );
323
+        }
324
+
325
+        return $carry;
326
+    }
327
+
328
+    /**
329
+     * Return the current element.
330
+     *
331
+     * @return mixed
332
+     */
333
+    public function current() {
334
+        $key = $this->keys[ $this->position ];
335
+        return $this->storage[ $key ];
336
+    }
337
+
338
+    /**
339
+     * Move forward to next element.
340
+     */
341
+    public function next() {
342
+        $this->position ++;
343
+    }
344
+
345
+    /**
346
+     * Return the key of the current element.
347
+     *
348
+     * @return mixed
349
+     */
350
+    public function key() {
351
+        return $this->keys[ $this->position ];
352
+    }
353
+
354
+    /**
355
+     * Checks if current position is valid.
356
+     *
357
+     * @return bool
358
+     */
359
+    public function valid() {
360
+        return isset( $this->keys[ $this->position ] );
361
+    }
362
+
363
+    /**
364
+     * Rewind the Iterator to the first element.
365
+     */
366
+    public function rewind() {
367
+        $this->position = 0;
368
+        $this->keys = array_keys( $this->storage );
369
+    }
370
+
371
+    /**
372
+     * {@inheritDoc}
373
+     *
374
+     * @return array
375
+     */
376
+    public function serialize() {
377
+        return $this->map(function( $val ) {
378
+            if ( $val instanceof Serializes ) {
379
+                $val = $val->serialize();
380
+            }
381
+
382
+            return $val;
383
+        })->to_array();
384
+    }
385 385
 }
Please login to merge, or discard this patch.
src/Assets/Register.php 1 patch
Indentation   +204 added lines, -204 removed lines patch added patch discarded remove patch
@@ -12,208 +12,208 @@
 block discarded – undo
12 12
  * @subpackage Register
13 13
  */
14 14
 class Register implements RegisterContract {
15
-	/**
16
-	 * Minification string for enqueued assets.
17
-	 *
18
-	 * @var string
19
-	 */
20
-	private $min = '.min';
21
-
22
-	/**
23
-	 * Url to the plugin directory.
24
-	 *
25
-	 * @var string
26
-	 */
27
-	protected $url;
28
-
29
-	/**
30
-	 * Script/plugin version.
31
-	 *
32
-	 * @var string
33
-	 */
34
-	protected $version;
35
-
36
-	/**
37
-	 * Array of script definition arrays.
38
-	 *
39
-	 * @var array
40
-	 */
41
-	private $scripts = array();
42
-
43
-	/**
44
-	 * Array of style definition arrays.
45
-	 *
46
-	 * @var array
47
-	 */
48
-	private $styles = array();
49
-
50
-	/**
51
-	 * Instantiates a new instance of the Register class.
52
-	 *
53
-	 * The URL param should be relative to the plugin directory. The URL
54
-	 * form should always end with a '/'. All asset location definitions
55
-	 * should not begin with a slash and should be relative to the plugin's
56
-	 * root directory. The URL provided by default from the Application
57
-	 * class is compatible.
58
-	 *
59
-	 * @param string $url
60
-	 * @param string $version
61
-	 */
62
-	public function __construct( $url, $version = null ) {
63
-		$this->url     = $url;
64
-		$this->version = $version ?: null; // Empty string should remain null.
65
-	}
66
-
67
-	/**
68
-	 * {@inheritdoc}
69
-	 *
70
-	 * @param bool $debug
71
-	 */
72
-	public function set_debug( $debug ) {
73
-		if ( $debug ) {
74
-			$this->min = '';
75
-		} else {
76
-			$this->min = '.min';
77
-		}
78
-	}
79
-
80
-	/**
81
-	 * {@inheritdoc}
82
-	 *
83
-	 * @param array $script
84
-	 */
85
-	public function register_script( $script ) {
86
-		$this->scripts[] = $script;
87
-	}
88
-
89
-	/**
90
-	 * {@inheritdoc}
91
-	 *
92
-	 * @param array $style
93
-	 */
94
-	public function register_style( $style ) {
95
-		$this->styles[] = $style;
96
-	}
97
-
98
-	/**
99
-	 * {@inheritDoc}
100
-	 */
101
-	public function enqueue_web_scripts() {
102
-		foreach ( $this->scripts as $script ) {
103
-			if ( in_array( $script['type'], array( 'web', 'shared' ) ) ) {
104
-				$this->enqueue_script( $script );
105
-			}
106
-		}
107
-	}
108
-
109
-	/**
110
-	 * {@inheritDoc}
111
-	 */
112
-	public function enqueue_web_styles() {
113
-		foreach ( $this->styles as $style ) {
114
-			if ( in_array( $style['type'], array( 'web', 'shared' ) ) ) {
115
-				$this->enqueue_style( $style );
116
-			}
117
-		}
118
-	}
119
-
120
-	/**
121
-	 * {@inheritDoc}
122
-	 *
123
-	 * @param string $hook Passes a string representing the current page.
124
-	 */
125
-	public function enqueue_admin_scripts( $hook ) {
126
-		foreach ( $this->scripts as $script ) {
127
-			if ( in_array( $script['type'], array( 'admin', 'shared' ) ) ) {
128
-				$this->enqueue_script( $script, $hook );
129
-			}
130
-		}
131
-	}
132
-
133
-	/**
134
-	 * {@inheritDoc}
135
-	 *
136
-	 * @param string $hook Passes a string representing the current page.
137
-	 */
138
-	public function enqueue_admin_styles( $hook ) {
139
-		foreach ( $this->styles as $style ) {
140
-			if ( in_array( $style['type'], array( 'admin', 'shared' ) ) ) {
141
-				$this->enqueue_style( $style, $hook );
142
-			}
143
-		}
144
-	}
145
-
146
-	/**
147
-	 * {@inheritDoc}
148
-	 *
149
-	 * @return array[]
150
-	 */
151
-	public function action_hooks() {
152
-		return array(
153
-			array(
154
-				'hook'   => 'wp_enqueue_scripts',
155
-				'method' => 'enqueue_web_scripts',
156
-			),
157
-			array(
158
-				'hook'   => 'wp_enqueue_scripts',
159
-				'method' => 'enqueue_web_styles',
160
-			),
161
-			array(
162
-				'hook'   => 'admin_enqueue_scripts',
163
-				'method' => 'enqueue_admin_scripts',
164
-			),
165
-			array(
166
-				'hook'   => 'admin_enqueue_scripts',
167
-				'method' => 'enqueue_admin_styles',
168
-			),
169
-		);
170
-	}
171
-
172
-	/**
173
-	 * Enqueues an individual script if the style's condition is met.
174
-	 *
175
-	 * @param array  $script The script attachment callback.
176
-	 * @param string $hook   The location hook. Only passed on admin side.
177
-	 */
178
-	protected function enqueue_script( $script, $hook = null ) {
179
-		if ( $script['condition']( $hook ) ) {
180
-			wp_enqueue_script(
181
-				$script['handle'],
182
-				$this->url . $script['src'] . $this->min . '.js',
183
-				isset( $script['deps'] ) ? $script['deps'] : array(),
184
-				$this->version,
185
-				isset( $script['footer'] ) ? $script['footer'] : false
186
-			);
187
-
188
-			if ( isset( $script['localize'] ) ) {
189
-				if ( is_callable( $script['localize'] ) ) { // @todo make all properties callables
190
-					$script['localize'] = call_user_func( $script['localize'] );
191
-				}
192
-
193
-				wp_localize_script(
194
-					$script['handle'],
195
-					$script['localize']['name'],
196
-					$script['localize']['data']
197
-				);
198
-			}
199
-		}
200
-	}
201
-
202
-	/**
203
-	 * Enqueues an individual stylesheet if the style's condition is met.
204
-	 *
205
-	 * @param array  $style The style attachment callback.
206
-	 * @param string $hook  The location hook.
207
-	 */
208
-	protected function enqueue_style( $style, $hook = null ) {
209
-		if ( $style['condition']( $hook ) ) {
210
-			wp_enqueue_style(
211
-				$style['handle'],
212
-				$this->url . $style['src'] . $this->min . '.css',
213
-				isset( $style['deps'] ) ? $style['deps'] : array(),
214
-				$this->version,
215
-				isset( $style['media'] ) ? $style['media'] : 'all'
216
-			);
217
-		}
218
-	}
15
+    /**
16
+     * Minification string for enqueued assets.
17
+     *
18
+     * @var string
19
+     */
20
+    private $min = '.min';
21
+
22
+    /**
23
+     * Url to the plugin directory.
24
+     *
25
+     * @var string
26
+     */
27
+    protected $url;
28
+
29
+    /**
30
+     * Script/plugin version.
31
+     *
32
+     * @var string
33
+     */
34
+    protected $version;
35
+
36
+    /**
37
+     * Array of script definition arrays.
38
+     *
39
+     * @var array
40
+     */
41
+    private $scripts = array();
42
+
43
+    /**
44
+     * Array of style definition arrays.
45
+     *
46
+     * @var array
47
+     */
48
+    private $styles = array();
49
+
50
+    /**
51
+     * Instantiates a new instance of the Register class.
52
+     *
53
+     * The URL param should be relative to the plugin directory. The URL
54
+     * form should always end with a '/'. All asset location definitions
55
+     * should not begin with a slash and should be relative to the plugin's
56
+     * root directory. The URL provided by default from the Application
57
+     * class is compatible.
58
+     *
59
+     * @param string $url
60
+     * @param string $version
61
+     */
62
+    public function __construct( $url, $version = null ) {
63
+        $this->url     = $url;
64
+        $this->version = $version ?: null; // Empty string should remain null.
65
+    }
66
+
67
+    /**
68
+     * {@inheritdoc}
69
+     *
70
+     * @param bool $debug
71
+     */
72
+    public function set_debug( $debug ) {
73
+        if ( $debug ) {
74
+            $this->min = '';
75
+        } else {
76
+            $this->min = '.min';
77
+        }
78
+    }
79
+
80
+    /**
81
+     * {@inheritdoc}
82
+     *
83
+     * @param array $script
84
+     */
85
+    public function register_script( $script ) {
86
+        $this->scripts[] = $script;
87
+    }
88
+
89
+    /**
90
+     * {@inheritdoc}
91
+     *
92
+     * @param array $style
93
+     */
94
+    public function register_style( $style ) {
95
+        $this->styles[] = $style;
96
+    }
97
+
98
+    /**
99
+     * {@inheritDoc}
100
+     */
101
+    public function enqueue_web_scripts() {
102
+        foreach ( $this->scripts as $script ) {
103
+            if ( in_array( $script['type'], array( 'web', 'shared' ) ) ) {
104
+                $this->enqueue_script( $script );
105
+            }
106
+        }
107
+    }
108
+
109
+    /**
110
+     * {@inheritDoc}
111
+     */
112
+    public function enqueue_web_styles() {
113
+        foreach ( $this->styles as $style ) {
114
+            if ( in_array( $style['type'], array( 'web', 'shared' ) ) ) {
115
+                $this->enqueue_style( $style );
116
+            }
117
+        }
118
+    }
119
+
120
+    /**
121
+     * {@inheritDoc}
122
+     *
123
+     * @param string $hook Passes a string representing the current page.
124
+     */
125
+    public function enqueue_admin_scripts( $hook ) {
126
+        foreach ( $this->scripts as $script ) {
127
+            if ( in_array( $script['type'], array( 'admin', 'shared' ) ) ) {
128
+                $this->enqueue_script( $script, $hook );
129
+            }
130
+        }
131
+    }
132
+
133
+    /**
134
+     * {@inheritDoc}
135
+     *
136
+     * @param string $hook Passes a string representing the current page.
137
+     */
138
+    public function enqueue_admin_styles( $hook ) {
139
+        foreach ( $this->styles as $style ) {
140
+            if ( in_array( $style['type'], array( 'admin', 'shared' ) ) ) {
141
+                $this->enqueue_style( $style, $hook );
142
+            }
143
+        }
144
+    }
145
+
146
+    /**
147
+     * {@inheritDoc}
148
+     *
149
+     * @return array[]
150
+     */
151
+    public function action_hooks() {
152
+        return array(
153
+            array(
154
+                'hook'   => 'wp_enqueue_scripts',
155
+                'method' => 'enqueue_web_scripts',
156
+            ),
157
+            array(
158
+                'hook'   => 'wp_enqueue_scripts',
159
+                'method' => 'enqueue_web_styles',
160
+            ),
161
+            array(
162
+                'hook'   => 'admin_enqueue_scripts',
163
+                'method' => 'enqueue_admin_scripts',
164
+            ),
165
+            array(
166
+                'hook'   => 'admin_enqueue_scripts',
167
+                'method' => 'enqueue_admin_styles',
168
+            ),
169
+        );
170
+    }
171
+
172
+    /**
173
+     * Enqueues an individual script if the style's condition is met.
174
+     *
175
+     * @param array  $script The script attachment callback.
176
+     * @param string $hook   The location hook. Only passed on admin side.
177
+     */
178
+    protected function enqueue_script( $script, $hook = null ) {
179
+        if ( $script['condition']( $hook ) ) {
180
+            wp_enqueue_script(
181
+                $script['handle'],
182
+                $this->url . $script['src'] . $this->min . '.js',
183
+                isset( $script['deps'] ) ? $script['deps'] : array(),
184
+                $this->version,
185
+                isset( $script['footer'] ) ? $script['footer'] : false
186
+            );
187
+
188
+            if ( isset( $script['localize'] ) ) {
189
+                if ( is_callable( $script['localize'] ) ) { // @todo make all properties callables
190
+                    $script['localize'] = call_user_func( $script['localize'] );
191
+                }
192
+
193
+                wp_localize_script(
194
+                    $script['handle'],
195
+                    $script['localize']['name'],
196
+                    $script['localize']['data']
197
+                );
198
+            }
199
+        }
200
+    }
201
+
202
+    /**
203
+     * Enqueues an individual stylesheet if the style's condition is met.
204
+     *
205
+     * @param array  $style The style attachment callback.
206
+     * @param string $hook  The location hook.
207
+     */
208
+    protected function enqueue_style( $style, $hook = null ) {
209
+        if ( $style['condition']( $hook ) ) {
210
+            wp_enqueue_style(
211
+                $style['handle'],
212
+                $this->url . $style['src'] . $this->min . '.css',
213
+                isset( $style['deps'] ) ? $style['deps'] : array(),
214
+                $this->version,
215
+                isset( $style['media'] ) ? $style['media'] : 'all'
216
+            );
217
+        }
218
+    }
219 219
 }
Please login to merge, or discard this patch.
src/Core/Application.php 1 patch
Indentation   +151 added lines, -151 removed lines patch added patch discarded remove patch
@@ -13,155 +13,155 @@
 block discarded – undo
13 13
  * @package Intraxia\Jaxion
14 14
  */
15 15
 class Application extends Container implements ApplicationContract {
16
-	/**
17
-	 * Define plugin version on Application.
18
-	 */
19
-	const VERSION = '';
20
-
21
-	/**
22
-	 * Singleton instance of the Application object
23
-	 *
24
-	 * @var Application[]
25
-	 */
26
-	protected static $instances = array();
27
-
28
-	/**
29
-	 * Instantiates a new Application container.
30
-	 *
31
-	 * The Application constructor enforces the presence of of a single instance
32
-	 * of the Application. If an instance already exists, an Exception will be thrown.
33
-	 *
34
-	 * @param Config $config
35
-	 * @param array  $providers
36
-	 *
37
-	 * @throws ApplicationAlreadyBootedException
38
-	 */
39
-	public function __construct( $config, array $providers = array() ) {
40
-		if ( isset( static::$instances[ get_called_class() ] ) ) {
41
-			throw new ApplicationAlreadyBootedException;
42
-		}
43
-
44
-		static::$instances[ get_called_class() ] = $this;
45
-
46
-		if ( ! ( $config instanceof Config ) ) {
47
-			$config = new Config( ConfigType::PLUGIN, $config );
48
-		}
49
-
50
-		$this->register_constants( $config );
51
-		$this->register_core_services( $config );
52
-
53
-		register_activation_hook( $config->file, array( $this, 'activate' ) );
54
-		register_deactivation_hook( $config->file, array( $this, 'deactivate' ) );
55
-
56
-		parent::__construct( $providers );
57
-	}
58
-
59
-	/**
60
-	 * {@inheritDoc}
61
-	 *
62
-	 * @throws UnexpectedValueException
63
-	 */
64
-	public function boot() {
65
-		$loader = $this->fetch( 'loader' );
66
-
67
-		if ( ! ( $loader instanceof LoaderContract ) ) {
68
-			throw new UnexpectedValueException;
69
-		}
70
-
71
-		foreach ( $this as $alias => $value ) {
72
-			if ( $value instanceof HasActions ) {
73
-				$loader->register_actions( $value );
74
-			}
75
-
76
-			if ( $value instanceof HasFilters ) {
77
-				$loader->register_filters( $value );
78
-			}
79
-
80
-			if ( $value instanceof HasShortcode ) {
81
-				$loader->register_shortcode( $value );
82
-			}
83
-		}
84
-
85
-		add_action( 'plugins_loaded', array( $loader, 'run' ) );
86
-	}
87
-
88
-	/**
89
-	 * {@inheritdoc}
90
-	 *
91
-	 * @codeCoverageIgnore
92
-	 */
93
-	public function activate() {
94
-		// no-op
95
-	}
96
-
97
-	/**
98
-	 * {@inheritdoc}
99
-	 *
100
-	 * @codeCoverageIgnore
101
-	 */
102
-	public function deactivate() {
103
-		// no-op
104
-	}
105
-
106
-	/**
107
-	 * {@inheritDoc}
108
-	 *
109
-	 * @return Application
110
-	 * @throws ApplicationNotBootedException
111
-	 */
112
-	public static function instance() {
113
-		if ( ! isset( static::$instances[ get_called_class() ] ) ) {
114
-			throw new ApplicationNotBootedException;
115
-		}
116
-
117
-		return static::$instances[ get_called_class() ];
118
-	}
119
-
120
-	/**
121
-	 * {@inheritDoc}
122
-	 */
123
-	public static function shutdown() {
124
-		if ( isset( static::$instances[ get_called_class() ] ) ) {
125
-			unset( static::$instances[ get_called_class() ] );
126
-		}
127
-	}
128
-
129
-	/**
130
-	 * Sets the plugin's url, path, and basename.
131
-	 *
132
-	 * @param Config $config
133
-	 */
134
-	private function register_constants( Config $config ) {
135
-		$this->share( 'file', function() use ( $config ) {
136
-			return $config->file;
137
-		} );
138
-		$this->share( 'url', function() use ( $config ) {
139
-			return $config->url;
140
-		} );
141
-		$this->share( 'path', function() use ( $config ) {
142
-			return $config->path;
143
-		} );
144
-		$this->share( 'basename', function() use ( $config ) {
145
-			return $config->basename;
146
-		} );
147
-		$this->share( 'slug', function() use ( $config ) {
148
-			return $config->slug;
149
-		} );
150
-		$this->share( 'version', static::VERSION );
151
-	}
152
-
153
-	/**
154
-	 * Registers the built-in services with the Application container.
155
-	 *
156
-	 * @param Config $config
157
-	 */
158
-	private function register_core_services( Config $config ) {
159
-		$this->share( array( 'config' => 'Intraxia\Jaxion\Core\Config' ), $config );
160
-		$this->share( array( 'loader' => 'Intraxia\Jaxion\Contract\Core\Loader' ), function () {
161
-			return new Loader;
162
-		} );
163
-		$this->share( array( 'i18n' => 'Intaxia\Jaxion\Contract\Core\I18n' ), function ( Container $app ) {
164
-			return new I18n( $app->fetch( 'basename' ), $app->fetch( 'path' ) );
165
-		} );
166
-	}
16
+    /**
17
+     * Define plugin version on Application.
18
+     */
19
+    const VERSION = '';
20
+
21
+    /**
22
+     * Singleton instance of the Application object
23
+     *
24
+     * @var Application[]
25
+     */
26
+    protected static $instances = array();
27
+
28
+    /**
29
+     * Instantiates a new Application container.
30
+     *
31
+     * The Application constructor enforces the presence of of a single instance
32
+     * of the Application. If an instance already exists, an Exception will be thrown.
33
+     *
34
+     * @param Config $config
35
+     * @param array  $providers
36
+     *
37
+     * @throws ApplicationAlreadyBootedException
38
+     */
39
+    public function __construct( $config, array $providers = array() ) {
40
+        if ( isset( static::$instances[ get_called_class() ] ) ) {
41
+            throw new ApplicationAlreadyBootedException;
42
+        }
43
+
44
+        static::$instances[ get_called_class() ] = $this;
45
+
46
+        if ( ! ( $config instanceof Config ) ) {
47
+            $config = new Config( ConfigType::PLUGIN, $config );
48
+        }
49
+
50
+        $this->register_constants( $config );
51
+        $this->register_core_services( $config );
52
+
53
+        register_activation_hook( $config->file, array( $this, 'activate' ) );
54
+        register_deactivation_hook( $config->file, array( $this, 'deactivate' ) );
55
+
56
+        parent::__construct( $providers );
57
+    }
58
+
59
+    /**
60
+     * {@inheritDoc}
61
+     *
62
+     * @throws UnexpectedValueException
63
+     */
64
+    public function boot() {
65
+        $loader = $this->fetch( 'loader' );
66
+
67
+        if ( ! ( $loader instanceof LoaderContract ) ) {
68
+            throw new UnexpectedValueException;
69
+        }
70
+
71
+        foreach ( $this as $alias => $value ) {
72
+            if ( $value instanceof HasActions ) {
73
+                $loader->register_actions( $value );
74
+            }
75
+
76
+            if ( $value instanceof HasFilters ) {
77
+                $loader->register_filters( $value );
78
+            }
79
+
80
+            if ( $value instanceof HasShortcode ) {
81
+                $loader->register_shortcode( $value );
82
+            }
83
+        }
84
+
85
+        add_action( 'plugins_loaded', array( $loader, 'run' ) );
86
+    }
87
+
88
+    /**
89
+     * {@inheritdoc}
90
+     *
91
+     * @codeCoverageIgnore
92
+     */
93
+    public function activate() {
94
+        // no-op
95
+    }
96
+
97
+    /**
98
+     * {@inheritdoc}
99
+     *
100
+     * @codeCoverageIgnore
101
+     */
102
+    public function deactivate() {
103
+        // no-op
104
+    }
105
+
106
+    /**
107
+     * {@inheritDoc}
108
+     *
109
+     * @return Application
110
+     * @throws ApplicationNotBootedException
111
+     */
112
+    public static function instance() {
113
+        if ( ! isset( static::$instances[ get_called_class() ] ) ) {
114
+            throw new ApplicationNotBootedException;
115
+        }
116
+
117
+        return static::$instances[ get_called_class() ];
118
+    }
119
+
120
+    /**
121
+     * {@inheritDoc}
122
+     */
123
+    public static function shutdown() {
124
+        if ( isset( static::$instances[ get_called_class() ] ) ) {
125
+            unset( static::$instances[ get_called_class() ] );
126
+        }
127
+    }
128
+
129
+    /**
130
+     * Sets the plugin's url, path, and basename.
131
+     *
132
+     * @param Config $config
133
+     */
134
+    private function register_constants( Config $config ) {
135
+        $this->share( 'file', function() use ( $config ) {
136
+            return $config->file;
137
+        } );
138
+        $this->share( 'url', function() use ( $config ) {
139
+            return $config->url;
140
+        } );
141
+        $this->share( 'path', function() use ( $config ) {
142
+            return $config->path;
143
+        } );
144
+        $this->share( 'basename', function() use ( $config ) {
145
+            return $config->basename;
146
+        } );
147
+        $this->share( 'slug', function() use ( $config ) {
148
+            return $config->slug;
149
+        } );
150
+        $this->share( 'version', static::VERSION );
151
+    }
152
+
153
+    /**
154
+     * Registers the built-in services with the Application container.
155
+     *
156
+     * @param Config $config
157
+     */
158
+    private function register_core_services( Config $config ) {
159
+        $this->share( array( 'config' => 'Intraxia\Jaxion\Core\Config' ), $config );
160
+        $this->share( array( 'loader' => 'Intraxia\Jaxion\Contract\Core\Loader' ), function () {
161
+            return new Loader;
162
+        } );
163
+        $this->share( array( 'i18n' => 'Intaxia\Jaxion\Contract\Core\I18n' ), function ( Container $app ) {
164
+            return new I18n( $app->fetch( 'basename' ), $app->fetch( 'path' ) );
165
+        } );
166
+    }
167 167
 }
Please login to merge, or discard this patch.
src/Core/ConfigType.php 1 patch
Indentation   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -12,7 +12,7 @@
 block discarded – undo
12 12
  * @subpackage Core
13 13
  */
14 14
 class ConfigType extends Enum {
15
-	const PLUGIN = 'plugin';
16
-	const THEME = 'theme';
17
-	const MU_PLUGIN = 'mu-plugin';
15
+    const PLUGIN = 'plugin';
16
+    const THEME = 'theme';
17
+    const MU_PLUGIN = 'mu-plugin';
18 18
 }
Please login to merge, or discard this patch.
src/Core/Config.php 1 patch
Indentation   +86 added lines, -86 removed lines patch added patch discarded remove patch
@@ -11,104 +11,104 @@
 block discarded – undo
11 11
  * @subpackage Core
12 12
  */
13 13
 class Config {
14
-	/**
15
-	 * Configuration type.
16
-	 *
17
-	 * @var ConfigType
18
-	 */
19
-	public $type;
14
+    /**
15
+     * Configuration type.
16
+     *
17
+     * @var ConfigType
18
+     */
19
+    public $type;
20 20
 
21
-	/**
22
-	 * App entry file.
23
-	 *
24
-	 * @var string
25
-	 */
26
-	public $file;
21
+    /**
22
+     * App entry file.
23
+     *
24
+     * @var string
25
+     */
26
+    public $file;
27 27
 
28
-	/**
29
-	 * App url.
30
-	 *
31
-	 * @var string
32
-	 */
33
-	public $url;
28
+    /**
29
+     * App url.
30
+     *
31
+     * @var string
32
+     */
33
+    public $url;
34 34
 
35
-	/**
36
-	 * App path.
37
-	 *
38
-	 * @var string
39
-	 */
40
-	public $path;
35
+    /**
36
+     * App path.
37
+     *
38
+     * @var string
39
+     */
40
+    public $path;
41 41
 
42
-	/**
43
-	 * App slug.
44
-	 *
45
-	 * @var string
46
-	 */
47
-	public $slug;
42
+    /**
43
+     * App slug.
44
+     *
45
+     * @var string
46
+     */
47
+    public $slug;
48 48
 
49
-	/**
50
-	 * App basename.
51
-	 *
52
-	 * @var string
53
-	 */
54
-	public $basename;
49
+    /**
50
+     * App basename.
51
+     *
52
+     * @var string
53
+     */
54
+    public $basename;
55 55
 
56
-	/**
57
-	 * Loaded configuration files.
58
-	 *
59
-	 * @var array
60
-	 */
61
-	private $loaded = array();
56
+    /**
57
+     * Loaded configuration files.
58
+     *
59
+     * @var array
60
+     */
61
+    private $loaded = array();
62 62
 
63
-	/**
64
-	 * Config constructor.
65
-	 *
66
-	 * @param string $type
67
-	 * @param string $file
68
-	 */
69
-	public function __construct( $type, $file ) {
70
-		$this->type = new ConfigType( $type );
71
-		$this->file = $file;
63
+    /**
64
+     * Config constructor.
65
+     *
66
+     * @param string $type
67
+     * @param string $file
68
+     */
69
+    public function __construct( $type, $file ) {
70
+        $this->type = new ConfigType( $type );
71
+        $this->file = $file;
72 72
 
73
-		switch ( $this->type->getValue() ) {
74
-			case ConfigType::PLUGIN:
75
-			case ConfigType::MU_PLUGIN:
76
-				$this->url = plugin_dir_url( $file );
77
-				$this->path = plugin_dir_path( $file );
78
-				$this->slug = dirname( $this->basename = plugin_basename( $file ) );
79
-				break;
80
-			case ConfigType::THEME:
81
-				$this->url = get_stylesheet_directory_uri() . '/';
82
-				$this->path = get_stylesheet_directory() . '/';
83
-				$this->slug = dirname( $this->basename = plugin_basename( $file ) );
84
-				break;
85
-		}
86
-	}
73
+        switch ( $this->type->getValue() ) {
74
+            case ConfigType::PLUGIN:
75
+            case ConfigType::MU_PLUGIN:
76
+                $this->url = plugin_dir_url( $file );
77
+                $this->path = plugin_dir_path( $file );
78
+                $this->slug = dirname( $this->basename = plugin_basename( $file ) );
79
+                break;
80
+            case ConfigType::THEME:
81
+                $this->url = get_stylesheet_directory_uri() . '/';
82
+                $this->path = get_stylesheet_directory() . '/';
83
+                $this->slug = dirname( $this->basename = plugin_basename( $file ) );
84
+                break;
85
+        }
86
+    }
87 87
 
88
-	/**
89
-	 * Load a configuration JSON file from the config folder.
90
-	 *
91
-	 * @param string $filename
92
-	 *
93
-	 * @return array|null
94
-	 */
95
-	public function get_config_json( $filename ) {
96
-		if ( isset( $this->loaded[ $filename ] ) ) {
97
-			return $this->loaded[ $filename ];
98
-		}
88
+    /**
89
+     * Load a configuration JSON file from the config folder.
90
+     *
91
+     * @param string $filename
92
+     *
93
+     * @return array|null
94
+     */
95
+    public function get_config_json( $filename ) {
96
+        if ( isset( $this->loaded[ $filename ] ) ) {
97
+            return $this->loaded[ $filename ];
98
+        }
99 99
 
100
-		$config = $this->path . 'config/' . $filename . '.json';
100
+        $config = $this->path . 'config/' . $filename . '.json';
101 101
 
102
-		if ( ! file_exists( $config ) ) {
103
-			return null;
104
-		}
102
+        if ( ! file_exists( $config ) ) {
103
+            return null;
104
+        }
105 105
 
106
-		$contents = file_get_contents( $config );
106
+        $contents = file_get_contents( $config );
107 107
 
108
-		if ( false === $contents ) {
109
-			return null;
110
-		}
108
+        if ( false === $contents ) {
109
+            return null;
110
+        }
111 111
 
112
-		return $this->loaded[ $filename ] = json_decode( $contents, true );
113
-	}
112
+        return $this->loaded[ $filename ] = json_decode( $contents, true );
113
+    }
114 114
 }
Please login to merge, or discard this patch.
src/Axolotl/Model.php 1 patch
Indentation   +734 added lines, -734 removed lines patch added patch discarded remove patch
@@ -22,738 +22,738 @@
 block discarded – undo
22 22
  * @since      0.1.0
23 23
  */
24 24
 abstract class Model implements Serializes {
25
-	/**
26
-	 * Table attribute key.
27
-	 */
28
-	const TABLE_KEY = '@@table';
29
-
30
-	/**
31
-	 * Object attribute key.
32
-	 */
33
-	const OBJECT_KEY = '@@object';
34
-
35
-	/**
36
-	 * Memoized values for class methods.
37
-	 *
38
-	 * @var array
39
-	 */
40
-	private static $memo = array();
41
-
42
-	/**
43
-	 * Model attributes.
44
-	 *
45
-	 * @var array
46
-	 */
47
-	private $attributes = array(
48
-		self::TABLE_KEY  => array(),
49
-		self::OBJECT_KEY => null,
50
-	);
51
-
52
-	/**
53
-	 * Model's original attributes.
54
-	 *
55
-	 * @var array
56
-	 */
57
-	private $original = array(
58
-		self::TABLE_KEY  => array(),
59
-		self::OBJECT_KEY => null,
60
-	);
61
-
62
-	/**
63
-	 * Default attribute values.
64
-	 *
65
-	 * @var array
66
-	 */
67
-	protected $defaults = array();
68
-
69
-	/**
70
-	 * Properties which are allowed to be set on the model.
71
-	 *
72
-	 * If this array is empty, any attributes can be set on the model.
73
-	 *
74
-	 * @var string[]
75
-	 */
76
-	protected $fillable = array();
77
-
78
-	/**
79
-	 * Properties which cannot be automatically filled on the model.
80
-	 *
81
-	 * If the model is unguarded, these properties can be filled.
82
-	 *
83
-	 * @var array
84
-	 */
85
-	protected $guarded = array();
86
-
87
-	/**
88
-	 * Properties which should not be serialized.
89
-	 *
90
-	 * @var array
91
-	 */
92
-	protected $hidden = array();
93
-
94
-	/**
95
-	 * Properties which should be serialized.
96
-	 *
97
-	 * @var array
98
-	 */
99
-	protected $visible = array();
100
-
101
-	/**
102
-	 * Whether the model's properties are guarded.
103
-	 *
104
-	 * When false, allows guarded properties to be filled.
105
-	 *
106
-	 * @var bool
107
-	 */
108
-	protected $is_guarded = true;
109
-
110
-	/**
111
-	 * Constructs a new model with provided attributes.
112
-	 *
113
-	 * If self::OBJECT_KEY is passed as one of the attributes, the underlying post
114
-	 * will be overwritten.
115
-	 *
116
-	 * @param array <string, mixed> $attributes
117
-	 */
118
-	public function __construct( array $attributes = array() ) {
119
-		$this->maybe_boot();
120
-		$this->sync_original();
121
-
122
-		if ( $this->uses_wp_object() ) {
123
-			$this->create_wp_object();
124
-		}
125
-
126
-		$this->unguard();
127
-		$this->refresh( $attributes );
128
-		$this->reguard();
129
-	}
130
-
131
-	/**
132
-	 * Refreshes the model's current attributes with the provided array.
133
-	 *
134
-	 * The model's attributes will match what was provided in the array,
135
-	 * and any attributes not passed
136
-	 *
137
-	 * @param array $attributes
138
-	 *
139
-	 * @return $this
140
-	 */
141
-	public function refresh( array $attributes ) {
142
-		$this->clear();
143
-
144
-		return $this->merge( $attributes );
145
-	}
146
-
147
-	/**
148
-	 * Merges the provided attributes with the provided array.
149
-	 *
150
-	 * @param array $attributes
151
-	 *
152
-	 * @return $this
153
-	 */
154
-	public function merge( array $attributes ) {
155
-		foreach ( $attributes as $name => $value ) {
156
-			$this->set_attribute( $name, $value );
157
-		}
158
-
159
-		return $this;
160
-	}
161
-
162
-	/**
163
-	 * Get the model's table attributes.
164
-	 *
165
-	 * Returns the array of for the model that will either need to be
166
-	 * saved in postmeta or a separate table.
167
-	 *
168
-	 * @return array
169
-	 */
170
-	public function get_table_attributes() {
171
-		return $this->attributes[ self::TABLE_KEY ];
172
-	}
173
-
174
-	/**
175
-	 * Get the model's original attributes.
176
-	 *
177
-	 * @return array
178
-	 */
179
-	public function get_original_table_attributes() {
180
-		return $this->original[ self::TABLE_KEY ];
181
-	}
182
-
183
-	/**
184
-	 * Retrieve an array of the attributes on the model
185
-	 * that have changed compared to the model's
186
-	 * original data.
187
-	 *
188
-	 * @return array
189
-	 */
190
-	public function get_changed_table_attributes() {
191
-		$changed = array();
192
-
193
-		foreach ( $this->get_table_attributes() as $key => $value ) {
194
-			if ( $value !==
195
-				 $this->get_original_attribute( $key )
196
-			) {
197
-				$changed[ $key ] = $value;
198
-			}
199
-		}
200
-
201
-		return $changed;
202
-	}
203
-
204
-	/**
205
-	 * Get the model's underlying post.
206
-	 *
207
-	 * Returns the underlying WP_Post object for the model, representing
208
-	 * the data that will be save in the wp_posts table.
209
-	 *
210
-	 * @return false|WP_Post|WP_Term
211
-	 */
212
-	public function get_underlying_wp_object() {
213
-		if ( isset( $this->attributes[ self::OBJECT_KEY ] ) ) {
214
-			return $this->attributes[ self::OBJECT_KEY ];
215
-		}
216
-
217
-		return false;
218
-	}
219
-
220
-	/**
221
-	 * Get the model's original underlying post.
222
-	 *
223
-	 * @return WP_Post
224
-	 */
225
-	public function get_original_underlying_wp_object() {
226
-		return $this->original[ self::OBJECT_KEY ];
227
-	}
228
-
229
-	/**
230
-	 * Get the model attributes on the WordPress object
231
-	 * that have changed compared to the model's
232
-	 * original attributes.
233
-	 *
234
-	 * @return array
235
-	 */
236
-	public function get_changed_wp_object_attributes() {
237
-		$changed = array();
238
-
239
-		foreach ( $this->get_wp_object_keys() as $key ) {
240
-			if ( $this->get_attribute( $key ) !==
241
-				 $this->get_original_attribute( $key )
242
-			) {
243
-				$changed[ $key ] = $this->get_attribute( $key );
244
-			}
245
-		}
246
-
247
-		return $changed;
248
-	}
249
-
250
-	/**
251
-	 * Magic __set method.
252
-	 *
253
-	 * Passes the name and value to set_attribute, which is where the magic happens.
254
-	 *
255
-	 * @param string $name
256
-	 * @param mixed  $value
257
-	 */
258
-	public function __set( $name, $value ) {
259
-		$this->set_attribute( $name, $value );
260
-	}
261
-
262
-	/**
263
-	 * Sets the model attributes.
264
-	 *
265
-	 * Checks whether the model attribute can be set, check if it
266
-	 * maps to the WP_Post property, otherwise, assigns it to the
267
-	 * table attribute array.
268
-	 *
269
-	 * @param string $name
270
-	 * @param mixed  $value
271
-	 *
272
-	 * @return $this
273
-	 *
274
-	 * @throws GuardedPropertyException
275
-	 */
276
-	public function set_attribute( $name, $value ) {
277
-		if ( self::OBJECT_KEY === $name ) {
278
-			return $this->override_wp_object( $value );
279
-		}
280
-
281
-		if ( self::TABLE_KEY === $name ) {
282
-			return $this->override_table( $value );
283
-		}
284
-
285
-		if ( ! $this->is_fillable( $name ) ) {
286
-			throw new GuardedPropertyException;
287
-		}
288
-
289
-		if ( $method = $this->has_map_method( $name ) ) {
290
-			$this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()} = $value;
291
-		} else {
292
-			$this->attributes[ self::TABLE_KEY ][ $name ] = $value;
293
-		}
294
-
295
-		return $this;
296
-	}
297
-
298
-	/**
299
-	 * Retrieves all the attribute keys for the model.
300
-	 *
301
-	 * @return array
302
-	 */
303
-	public function get_attribute_keys() {
304
-		if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
305
-			return self::$memo[ get_called_class() ][ __METHOD__ ];
306
-		}
307
-
308
-		return self::$memo[ get_called_class() ][ __METHOD__ ]
309
-			= array_merge(
310
-				$this->fillable,
311
-				$this->guarded,
312
-				$this->get_compute_methods()
313
-			);
314
-	}
315
-
316
-	/**
317
-	 * Retrieves the attribute keys that aren't mapped to a post.
318
-	 *
319
-	 * @return array
320
-	 */
321
-	public function get_table_keys() {
322
-		if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
323
-			return self::$memo[ get_called_class() ][ __METHOD__ ];
324
-		}
325
-
326
-		$keys = array();
327
-
328
-		foreach ( $this->get_attribute_keys() as $key ) {
329
-			if ( ! $this->has_map_method( $key ) &&
330
-				 ! $this->has_compute_method( $key )
331
-			) {
332
-				$keys[] = $key;
333
-			}
334
-		}
335
-
336
-		return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
337
-	}
338
-
339
-	/**
340
-	 * Retrieves the attribute keys that are mapped to a post.
341
-	 *
342
-	 * @return array
343
-	 */
344
-	public function get_wp_object_keys() {
345
-		if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
346
-			return self::$memo[ get_called_class() ][ __METHOD__ ];
347
-		}
348
-
349
-		$keys = array();
350
-
351
-		foreach ( $this->get_attribute_keys() as $key ) {
352
-			if ( $this->has_map_method( $key ) ) {
353
-				$keys[] = $key;
354
-			}
355
-		}
356
-
357
-		return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
358
-	}
359
-
360
-	/**
361
-	 * Returns the model's keys that are computed at call time.
362
-	 *
363
-	 * @return array
364
-	 */
365
-	public function get_computed_keys() {
366
-		if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
367
-			return self::$memo[ get_called_class() ][ __METHOD__ ];
368
-		}
369
-
370
-		$keys = array();
371
-
372
-		foreach ( $this->get_attribute_keys() as $key ) {
373
-			if ( $this->has_compute_method( $key ) ) {
374
-				$keys[] = $key;
375
-			}
376
-		}
377
-
378
-		return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
379
-	}
380
-
381
-	/**
382
-	 * Serializes the model's public data into an array.
383
-	 *
384
-	 * @return array
385
-	 */
386
-	public function serialize() {
387
-		$attributes = array();
388
-
389
-		if ( $this->visible ) {
390
-			// If visible attributes are set, we'll only reveal those.
391
-			foreach ( $this->visible as $key ) {
392
-				$attributes[ $key ] = $this->get_attribute( $key );
393
-			}
394
-		} elseif ( $this->hidden ) {
395
-			// If hidden attributes are set, we'll grab everything and hide those.
396
-			foreach ( $this->get_attribute_keys() as $key ) {
397
-				if ( ! in_array( $key, $this->hidden ) ) {
398
-					$attributes[ $key ] = $this->get_attribute( $key );
399
-				}
400
-			}
401
-		} else {
402
-			// If nothing is hidden/visible, we'll grab and reveal everything.
403
-			foreach ( $this->get_attribute_keys() as $key ) {
404
-				$attributes[ $key ] = $this->get_attribute( $key );
405
-			}
406
-		}
407
-
408
-		return array_map( function ( $attribute ) {
409
-			if ( $attribute instanceof Serializes ) {
410
-				return $attribute->serialize();
411
-			}
412
-
413
-			return $attribute;
414
-		}, $attributes );
415
-	}
416
-
417
-	/**
418
-	 * Syncs the current attributes to the model's original.
419
-	 *
420
-	 * @return $this
421
-	 */
422
-	public function sync_original() {
423
-		$this->original = $this->attributes;
424
-
425
-		if ( $this->attributes[ self::OBJECT_KEY ] ) {
426
-			$this->original[ self::OBJECT_KEY ] = clone $this->attributes[ self::OBJECT_KEY ];
427
-		}
428
-
429
-		foreach ( $this->original[ self::TABLE_KEY ] as $key => $item ) {
430
-			if ( is_object( $item ) ) {
431
-				$this->original[ $key ] = clone $item;
432
-			}
433
-		}
434
-
435
-		return $this;
436
-	}
437
-
438
-	/**
439
-	 * Checks if a given attribute is mass-fillable.
440
-	 *
441
-	 * Returns true if the attribute can be filled, false if it can't.
442
-	 *
443
-	 * @param string $name
444
-	 *
445
-	 * @return bool
446
-	 */
447
-	private function is_fillable( $name ) {
448
-		// If this model isn't guarded, everything is fillable.
449
-		if ( ! $this->is_guarded ) {
450
-			return true;
451
-		}
452
-
453
-		// If it's in the fillable array, then it's fillable.
454
-		if ( in_array( $name, $this->fillable ) ) {
455
-			return true;
456
-		}
457
-
458
-		// If it's explicitly guarded, then it's not fillable.
459
-		if ( in_array( $name, $this->guarded ) ) {
460
-			return false;
461
-		}
462
-
463
-		// If fillable hasn't been defined, then everything else fillable.
464
-		return ! $this->fillable;
465
-	}
466
-
467
-	/**
468
-	 * Overrides the current WordPress object with a provided one.
469
-	 *
470
-	 * Resets the post's default values and stores it in the attributes.
471
-	 *
472
-	 * @param WP_Post|WP_Term|null $value
473
-	 *
474
-	 * @return $this
475
-	 */
476
-	private function override_wp_object( $value ) {
477
-		if ( is_object( $value ) ) {
478
-			$this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $value );
479
-		} else {
480
-			$this->attributes[ self::OBJECT_KEY ] = null;
481
-
482
-			if ( $this->uses_wp_object() ) {
483
-				$this->create_wp_object();
484
-			}
485
-		}
486
-
487
-		return $this;
488
-	}
489
-
490
-	/**
491
-	 * Overrides the current table attributes array with a provided one.
492
-	 *
493
-	 * @param array $value
494
-	 *
495
-	 * @return $this
496
-	 */
497
-	private function override_table( array $value ) {
498
-		$this->attributes[ self::TABLE_KEY ] = $value;
499
-
500
-		return $this;
501
-	}
502
-
503
-	/**
504
-	 * Create and set with a new blank post.
505
-	 *
506
-	 * Creates a new WP_Post object, assigns it the default attributes,
507
-	 * and stores it in the attributes.
508
-	 *
509
-	 * @throws LogicException
510
-	 */
511
-	private function create_wp_object() {
512
-		switch ( true ) {
513
-			case $this instanceof UsesWordPressPost:
514
-				$object = new WP_Post( (object) array() );
515
-				break;
516
-			case $this instanceof UsesWordPressTerm:
517
-				$object = new WP_Term( (object) array() );
518
-				break;
519
-			default:
520
-				throw new LogicException;
521
-				break;
522
-		}
523
-
524
-		$this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $object );
525
-	}
526
-
527
-	/**
528
-	 * Enforces values on the post that can't change.
529
-	 *
530
-	 * Primarily, this is used to make sure the post_type always maps
531
-	 * to the model's "$type" property, but this can all be overridden
532
-	 * by the developer to enforce other values in the model.
533
-	 *
534
-	 * @param object $object
535
-	 *
536
-	 * @return object
537
-	 */
538
-	protected function set_wp_object_constants( $object ) {
539
-		if ( $this instanceof UsesWordPressPost ) {
540
-			$object->post_type = static::get_post_type();
541
-		}
542
-
543
-		if ( $this instanceof UsesWordPressTerm ) {
544
-			$object->taxonomy = static::get_taxonomy();
545
-		}
546
-
547
-		return $object;
548
-	}
549
-
550
-	/**
551
-	 * Magic __get method.
552
-	 *
553
-	 * Passes the name and value to get_attribute, which is where the magic happens.
554
-	 *
555
-	 * @param string $name
556
-	 *
557
-	 * @return mixed
558
-	 */
559
-	public function __get( $name ) {
560
-		return $this->get_attribute( $name );
561
-	}
562
-
563
-	/**
564
-	 * Retrieves the model attribute.
565
-	 *
566
-	 * @param string $name
567
-	 *
568
-	 * @return mixed
569
-	 *
570
-	 * @throws PropertyDoesNotExistException If property isn't found.
571
-	 */
572
-	public function get_attribute( $name ) {
573
-		if ( $method = $this->has_map_method( $name ) ) {
574
-			return $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()};
575
-		}
576
-
577
-		if ( $method = $this->has_compute_method( $name ) ) {
578
-			return $this->{$method}();
579
-		}
580
-
581
-		if ( isset( $this->attributes[ self::TABLE_KEY ][ $name ] ) ) {
582
-			return $this->attributes[ self::TABLE_KEY ][ $name ];
583
-		}
584
-
585
-		if ( isset( $this->defaults[ $name ] ) ) {
586
-			return $this->defaults[ $name ];
587
-		}
588
-
589
-		return null;
590
-	}
591
-
592
-	/**
593
-	 * Retrieve the model's original attribute value.
594
-	 *
595
-	 * @param string $name
596
-	 *
597
-	 * @return mixed
598
-	 *
599
-	 * @throws PropertyDoesNotExistException If property isn't found.
600
-	 */
601
-	public function get_original_attribute( $name ) {
602
-		$original_attributes = $this->original;
603
-
604
-		if ( ! is_object( $original_attributes[ static::OBJECT_KEY ] ) ) {
605
-			unset( $original_attributes[ static::OBJECT_KEY ] );
606
-		}
607
-
608
-		$original = new static( $original_attributes );
609
-
610
-		return $original->get_attribute( $name );
611
-	}
612
-
613
-	/**
614
-	 * Fetches the Model's primary ID, depending on the model
615
-	 * implementation.
616
-	 *
617
-	 * @return int
618
-	 *
619
-	 * @throws LogicException
620
-	 */
621
-	public function get_primary_id() {
622
-		if ( $this instanceof UsesWordPressPost ) {
623
-			return $this->get_underlying_wp_object()->ID;
624
-		}
625
-
626
-		if ( $this instanceof UsesWordPressTerm ) {
627
-			return $this->get_underlying_wp_object()->term_id;
628
-		}
629
-
630
-		if ( $this instanceof UsesCustomTable ) {
631
-			return $this->get_attribute( $this->get_primary_key() );
632
-		}
633
-
634
-		// Model w/o wp_object not yet supported.
635
-		throw new LogicException;
636
-	}
637
-
638
-	/**
639
-	 * Checks whether the attribute has a map method.
640
-	 *
641
-	 * This is used to determine whether the attribute maps to a
642
-	 * property on the underlying WP_Post object. Returns the
643
-	 * method if one exists, returns false if it doesn't.
644
-	 *
645
-	 * @param string $name
646
-	 *
647
-	 * @return false|string
648
-	 */
649
-	protected function has_map_method( $name ) {
650
-		if ( method_exists( $this, $method = "map_{$name}" ) ) {
651
-			return $method;
652
-		}
653
-
654
-		return false;
655
-	}
656
-
657
-	/**
658
-	 * Checks whether the attribute has a compute method.
659
-	 *
660
-	 * This is used to determine if the attribute should be computed
661
-	 * from other attributes.
662
-	 *
663
-	 * @param string $name
664
-	 *
665
-	 * @return false|string
666
-	 */
667
-	protected function has_compute_method( $name ) {
668
-		if ( method_exists( $this, $method = "compute_{$name}" ) ) {
669
-			return $method;
670
-		}
671
-
672
-		return false;
673
-	}
674
-
675
-	/**
676
-	 * Clears all the current attributes from the model.
677
-	 *
678
-	 * This does not touch the model's original attributes, and will
679
-	 * only clear fillable attributes, unless the model is unguarded.
680
-	 *
681
-	 * @throws Exception
682
-	 * @return $this
683
-	 */
684
-	public function clear() {
685
-		$keys = array_merge(
686
-			$this->get_table_keys(),
687
-			$this->get_wp_object_keys()
688
-		);
689
-
690
-		foreach ( $keys as $key ) {
691
-			try {
692
-				$this->set_attribute( $key, null );
693
-			} catch ( Exception $e ) {
694
-				// We won't clear out guarded attributes.
695
-				if ( ! ( $e instanceof GuardedPropertyException ) ) {
696
-					throw $e;
697
-				}
698
-			}
699
-		}
700
-
701
-		return $this;
702
-	}
703
-
704
-	/**
705
-	 * Unguards the model.
706
-	 *
707
-	 * Sets the model to be unguarded, allowing the filling of
708
-	 * guarded attributes.
709
-	 */
710
-	public function unguard() {
711
-		$this->is_guarded = false;
712
-	}
713
-
714
-	/**
715
-	 * Reguards the model.
716
-	 *
717
-	 * Sets the model to be guarded, preventing filling of
718
-	 * guarded attributes.
719
-	 */
720
-	public function reguard() {
721
-		$this->is_guarded = true;
722
-	}
723
-
724
-	/**
725
-	 * Retrieves all the compute methods on the model.
726
-	 *
727
-	 * @return array
728
-	 */
729
-	protected function get_compute_methods() {
730
-		$methods = get_class_methods( get_called_class() );
731
-		$methods = array_filter( $methods, function ( $method ) {
732
-			return strrpos( $method, 'compute_', - strlen( $method ) ) !== false;
733
-		} );
734
-		$methods = array_map( function ( $method ) {
735
-			return substr( $method, strlen( 'compute_' ) );
736
-		}, $methods );
737
-
738
-		return $methods;
739
-	}
740
-
741
-	/**
742
-	 * Sets up the memo array for the creating model.
743
-	 */
744
-	private function maybe_boot() {
745
-		if ( ! isset( self::$memo[ get_called_class() ] ) ) {
746
-			self::$memo[ get_called_class() ] = array();
747
-		}
748
-	}
749
-
750
-	/**
751
-	 * Whether this Model uses an underlying WordPress object.
752
-	 *
753
-	 * @return bool
754
-	 */
755
-	protected function uses_wp_object() {
756
-		return $this instanceof UsesWordPressPost ||
757
-			$this instanceof UsesWordPressTerm;
758
-	}
25
+    /**
26
+     * Table attribute key.
27
+     */
28
+    const TABLE_KEY = '@@table';
29
+
30
+    /**
31
+     * Object attribute key.
32
+     */
33
+    const OBJECT_KEY = '@@object';
34
+
35
+    /**
36
+     * Memoized values for class methods.
37
+     *
38
+     * @var array
39
+     */
40
+    private static $memo = array();
41
+
42
+    /**
43
+     * Model attributes.
44
+     *
45
+     * @var array
46
+     */
47
+    private $attributes = array(
48
+        self::TABLE_KEY  => array(),
49
+        self::OBJECT_KEY => null,
50
+    );
51
+
52
+    /**
53
+     * Model's original attributes.
54
+     *
55
+     * @var array
56
+     */
57
+    private $original = array(
58
+        self::TABLE_KEY  => array(),
59
+        self::OBJECT_KEY => null,
60
+    );
61
+
62
+    /**
63
+     * Default attribute values.
64
+     *
65
+     * @var array
66
+     */
67
+    protected $defaults = array();
68
+
69
+    /**
70
+     * Properties which are allowed to be set on the model.
71
+     *
72
+     * If this array is empty, any attributes can be set on the model.
73
+     *
74
+     * @var string[]
75
+     */
76
+    protected $fillable = array();
77
+
78
+    /**
79
+     * Properties which cannot be automatically filled on the model.
80
+     *
81
+     * If the model is unguarded, these properties can be filled.
82
+     *
83
+     * @var array
84
+     */
85
+    protected $guarded = array();
86
+
87
+    /**
88
+     * Properties which should not be serialized.
89
+     *
90
+     * @var array
91
+     */
92
+    protected $hidden = array();
93
+
94
+    /**
95
+     * Properties which should be serialized.
96
+     *
97
+     * @var array
98
+     */
99
+    protected $visible = array();
100
+
101
+    /**
102
+     * Whether the model's properties are guarded.
103
+     *
104
+     * When false, allows guarded properties to be filled.
105
+     *
106
+     * @var bool
107
+     */
108
+    protected $is_guarded = true;
109
+
110
+    /**
111
+     * Constructs a new model with provided attributes.
112
+     *
113
+     * If self::OBJECT_KEY is passed as one of the attributes, the underlying post
114
+     * will be overwritten.
115
+     *
116
+     * @param array <string, mixed> $attributes
117
+     */
118
+    public function __construct( array $attributes = array() ) {
119
+        $this->maybe_boot();
120
+        $this->sync_original();
121
+
122
+        if ( $this->uses_wp_object() ) {
123
+            $this->create_wp_object();
124
+        }
125
+
126
+        $this->unguard();
127
+        $this->refresh( $attributes );
128
+        $this->reguard();
129
+    }
130
+
131
+    /**
132
+     * Refreshes the model's current attributes with the provided array.
133
+     *
134
+     * The model's attributes will match what was provided in the array,
135
+     * and any attributes not passed
136
+     *
137
+     * @param array $attributes
138
+     *
139
+     * @return $this
140
+     */
141
+    public function refresh( array $attributes ) {
142
+        $this->clear();
143
+
144
+        return $this->merge( $attributes );
145
+    }
146
+
147
+    /**
148
+     * Merges the provided attributes with the provided array.
149
+     *
150
+     * @param array $attributes
151
+     *
152
+     * @return $this
153
+     */
154
+    public function merge( array $attributes ) {
155
+        foreach ( $attributes as $name => $value ) {
156
+            $this->set_attribute( $name, $value );
157
+        }
158
+
159
+        return $this;
160
+    }
161
+
162
+    /**
163
+     * Get the model's table attributes.
164
+     *
165
+     * Returns the array of for the model that will either need to be
166
+     * saved in postmeta or a separate table.
167
+     *
168
+     * @return array
169
+     */
170
+    public function get_table_attributes() {
171
+        return $this->attributes[ self::TABLE_KEY ];
172
+    }
173
+
174
+    /**
175
+     * Get the model's original attributes.
176
+     *
177
+     * @return array
178
+     */
179
+    public function get_original_table_attributes() {
180
+        return $this->original[ self::TABLE_KEY ];
181
+    }
182
+
183
+    /**
184
+     * Retrieve an array of the attributes on the model
185
+     * that have changed compared to the model's
186
+     * original data.
187
+     *
188
+     * @return array
189
+     */
190
+    public function get_changed_table_attributes() {
191
+        $changed = array();
192
+
193
+        foreach ( $this->get_table_attributes() as $key => $value ) {
194
+            if ( $value !==
195
+                    $this->get_original_attribute( $key )
196
+            ) {
197
+                $changed[ $key ] = $value;
198
+            }
199
+        }
200
+
201
+        return $changed;
202
+    }
203
+
204
+    /**
205
+     * Get the model's underlying post.
206
+     *
207
+     * Returns the underlying WP_Post object for the model, representing
208
+     * the data that will be save in the wp_posts table.
209
+     *
210
+     * @return false|WP_Post|WP_Term
211
+     */
212
+    public function get_underlying_wp_object() {
213
+        if ( isset( $this->attributes[ self::OBJECT_KEY ] ) ) {
214
+            return $this->attributes[ self::OBJECT_KEY ];
215
+        }
216
+
217
+        return false;
218
+    }
219
+
220
+    /**
221
+     * Get the model's original underlying post.
222
+     *
223
+     * @return WP_Post
224
+     */
225
+    public function get_original_underlying_wp_object() {
226
+        return $this->original[ self::OBJECT_KEY ];
227
+    }
228
+
229
+    /**
230
+     * Get the model attributes on the WordPress object
231
+     * that have changed compared to the model's
232
+     * original attributes.
233
+     *
234
+     * @return array
235
+     */
236
+    public function get_changed_wp_object_attributes() {
237
+        $changed = array();
238
+
239
+        foreach ( $this->get_wp_object_keys() as $key ) {
240
+            if ( $this->get_attribute( $key ) !==
241
+                    $this->get_original_attribute( $key )
242
+            ) {
243
+                $changed[ $key ] = $this->get_attribute( $key );
244
+            }
245
+        }
246
+
247
+        return $changed;
248
+    }
249
+
250
+    /**
251
+     * Magic __set method.
252
+     *
253
+     * Passes the name and value to set_attribute, which is where the magic happens.
254
+     *
255
+     * @param string $name
256
+     * @param mixed  $value
257
+     */
258
+    public function __set( $name, $value ) {
259
+        $this->set_attribute( $name, $value );
260
+    }
261
+
262
+    /**
263
+     * Sets the model attributes.
264
+     *
265
+     * Checks whether the model attribute can be set, check if it
266
+     * maps to the WP_Post property, otherwise, assigns it to the
267
+     * table attribute array.
268
+     *
269
+     * @param string $name
270
+     * @param mixed  $value
271
+     *
272
+     * @return $this
273
+     *
274
+     * @throws GuardedPropertyException
275
+     */
276
+    public function set_attribute( $name, $value ) {
277
+        if ( self::OBJECT_KEY === $name ) {
278
+            return $this->override_wp_object( $value );
279
+        }
280
+
281
+        if ( self::TABLE_KEY === $name ) {
282
+            return $this->override_table( $value );
283
+        }
284
+
285
+        if ( ! $this->is_fillable( $name ) ) {
286
+            throw new GuardedPropertyException;
287
+        }
288
+
289
+        if ( $method = $this->has_map_method( $name ) ) {
290
+            $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()} = $value;
291
+        } else {
292
+            $this->attributes[ self::TABLE_KEY ][ $name ] = $value;
293
+        }
294
+
295
+        return $this;
296
+    }
297
+
298
+    /**
299
+     * Retrieves all the attribute keys for the model.
300
+     *
301
+     * @return array
302
+     */
303
+    public function get_attribute_keys() {
304
+        if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
305
+            return self::$memo[ get_called_class() ][ __METHOD__ ];
306
+        }
307
+
308
+        return self::$memo[ get_called_class() ][ __METHOD__ ]
309
+            = array_merge(
310
+                $this->fillable,
311
+                $this->guarded,
312
+                $this->get_compute_methods()
313
+            );
314
+    }
315
+
316
+    /**
317
+     * Retrieves the attribute keys that aren't mapped to a post.
318
+     *
319
+     * @return array
320
+     */
321
+    public function get_table_keys() {
322
+        if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
323
+            return self::$memo[ get_called_class() ][ __METHOD__ ];
324
+        }
325
+
326
+        $keys = array();
327
+
328
+        foreach ( $this->get_attribute_keys() as $key ) {
329
+            if ( ! $this->has_map_method( $key ) &&
330
+                 ! $this->has_compute_method( $key )
331
+            ) {
332
+                $keys[] = $key;
333
+            }
334
+        }
335
+
336
+        return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
337
+    }
338
+
339
+    /**
340
+     * Retrieves the attribute keys that are mapped to a post.
341
+     *
342
+     * @return array
343
+     */
344
+    public function get_wp_object_keys() {
345
+        if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
346
+            return self::$memo[ get_called_class() ][ __METHOD__ ];
347
+        }
348
+
349
+        $keys = array();
350
+
351
+        foreach ( $this->get_attribute_keys() as $key ) {
352
+            if ( $this->has_map_method( $key ) ) {
353
+                $keys[] = $key;
354
+            }
355
+        }
356
+
357
+        return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
358
+    }
359
+
360
+    /**
361
+     * Returns the model's keys that are computed at call time.
362
+     *
363
+     * @return array
364
+     */
365
+    public function get_computed_keys() {
366
+        if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
367
+            return self::$memo[ get_called_class() ][ __METHOD__ ];
368
+        }
369
+
370
+        $keys = array();
371
+
372
+        foreach ( $this->get_attribute_keys() as $key ) {
373
+            if ( $this->has_compute_method( $key ) ) {
374
+                $keys[] = $key;
375
+            }
376
+        }
377
+
378
+        return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
379
+    }
380
+
381
+    /**
382
+     * Serializes the model's public data into an array.
383
+     *
384
+     * @return array
385
+     */
386
+    public function serialize() {
387
+        $attributes = array();
388
+
389
+        if ( $this->visible ) {
390
+            // If visible attributes are set, we'll only reveal those.
391
+            foreach ( $this->visible as $key ) {
392
+                $attributes[ $key ] = $this->get_attribute( $key );
393
+            }
394
+        } elseif ( $this->hidden ) {
395
+            // If hidden attributes are set, we'll grab everything and hide those.
396
+            foreach ( $this->get_attribute_keys() as $key ) {
397
+                if ( ! in_array( $key, $this->hidden ) ) {
398
+                    $attributes[ $key ] = $this->get_attribute( $key );
399
+                }
400
+            }
401
+        } else {
402
+            // If nothing is hidden/visible, we'll grab and reveal everything.
403
+            foreach ( $this->get_attribute_keys() as $key ) {
404
+                $attributes[ $key ] = $this->get_attribute( $key );
405
+            }
406
+        }
407
+
408
+        return array_map( function ( $attribute ) {
409
+            if ( $attribute instanceof Serializes ) {
410
+                return $attribute->serialize();
411
+            }
412
+
413
+            return $attribute;
414
+        }, $attributes );
415
+    }
416
+
417
+    /**
418
+     * Syncs the current attributes to the model's original.
419
+     *
420
+     * @return $this
421
+     */
422
+    public function sync_original() {
423
+        $this->original = $this->attributes;
424
+
425
+        if ( $this->attributes[ self::OBJECT_KEY ] ) {
426
+            $this->original[ self::OBJECT_KEY ] = clone $this->attributes[ self::OBJECT_KEY ];
427
+        }
428
+
429
+        foreach ( $this->original[ self::TABLE_KEY ] as $key => $item ) {
430
+            if ( is_object( $item ) ) {
431
+                $this->original[ $key ] = clone $item;
432
+            }
433
+        }
434
+
435
+        return $this;
436
+    }
437
+
438
+    /**
439
+     * Checks if a given attribute is mass-fillable.
440
+     *
441
+     * Returns true if the attribute can be filled, false if it can't.
442
+     *
443
+     * @param string $name
444
+     *
445
+     * @return bool
446
+     */
447
+    private function is_fillable( $name ) {
448
+        // If this model isn't guarded, everything is fillable.
449
+        if ( ! $this->is_guarded ) {
450
+            return true;
451
+        }
452
+
453
+        // If it's in the fillable array, then it's fillable.
454
+        if ( in_array( $name, $this->fillable ) ) {
455
+            return true;
456
+        }
457
+
458
+        // If it's explicitly guarded, then it's not fillable.
459
+        if ( in_array( $name, $this->guarded ) ) {
460
+            return false;
461
+        }
462
+
463
+        // If fillable hasn't been defined, then everything else fillable.
464
+        return ! $this->fillable;
465
+    }
466
+
467
+    /**
468
+     * Overrides the current WordPress object with a provided one.
469
+     *
470
+     * Resets the post's default values and stores it in the attributes.
471
+     *
472
+     * @param WP_Post|WP_Term|null $value
473
+     *
474
+     * @return $this
475
+     */
476
+    private function override_wp_object( $value ) {
477
+        if ( is_object( $value ) ) {
478
+            $this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $value );
479
+        } else {
480
+            $this->attributes[ self::OBJECT_KEY ] = null;
481
+
482
+            if ( $this->uses_wp_object() ) {
483
+                $this->create_wp_object();
484
+            }
485
+        }
486
+
487
+        return $this;
488
+    }
489
+
490
+    /**
491
+     * Overrides the current table attributes array with a provided one.
492
+     *
493
+     * @param array $value
494
+     *
495
+     * @return $this
496
+     */
497
+    private function override_table( array $value ) {
498
+        $this->attributes[ self::TABLE_KEY ] = $value;
499
+
500
+        return $this;
501
+    }
502
+
503
+    /**
504
+     * Create and set with a new blank post.
505
+     *
506
+     * Creates a new WP_Post object, assigns it the default attributes,
507
+     * and stores it in the attributes.
508
+     *
509
+     * @throws LogicException
510
+     */
511
+    private function create_wp_object() {
512
+        switch ( true ) {
513
+            case $this instanceof UsesWordPressPost:
514
+                $object = new WP_Post( (object) array() );
515
+                break;
516
+            case $this instanceof UsesWordPressTerm:
517
+                $object = new WP_Term( (object) array() );
518
+                break;
519
+            default:
520
+                throw new LogicException;
521
+                break;
522
+        }
523
+
524
+        $this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $object );
525
+    }
526
+
527
+    /**
528
+     * Enforces values on the post that can't change.
529
+     *
530
+     * Primarily, this is used to make sure the post_type always maps
531
+     * to the model's "$type" property, but this can all be overridden
532
+     * by the developer to enforce other values in the model.
533
+     *
534
+     * @param object $object
535
+     *
536
+     * @return object
537
+     */
538
+    protected function set_wp_object_constants( $object ) {
539
+        if ( $this instanceof UsesWordPressPost ) {
540
+            $object->post_type = static::get_post_type();
541
+        }
542
+
543
+        if ( $this instanceof UsesWordPressTerm ) {
544
+            $object->taxonomy = static::get_taxonomy();
545
+        }
546
+
547
+        return $object;
548
+    }
549
+
550
+    /**
551
+     * Magic __get method.
552
+     *
553
+     * Passes the name and value to get_attribute, which is where the magic happens.
554
+     *
555
+     * @param string $name
556
+     *
557
+     * @return mixed
558
+     */
559
+    public function __get( $name ) {
560
+        return $this->get_attribute( $name );
561
+    }
562
+
563
+    /**
564
+     * Retrieves the model attribute.
565
+     *
566
+     * @param string $name
567
+     *
568
+     * @return mixed
569
+     *
570
+     * @throws PropertyDoesNotExistException If property isn't found.
571
+     */
572
+    public function get_attribute( $name ) {
573
+        if ( $method = $this->has_map_method( $name ) ) {
574
+            return $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()};
575
+        }
576
+
577
+        if ( $method = $this->has_compute_method( $name ) ) {
578
+            return $this->{$method}();
579
+        }
580
+
581
+        if ( isset( $this->attributes[ self::TABLE_KEY ][ $name ] ) ) {
582
+            return $this->attributes[ self::TABLE_KEY ][ $name ];
583
+        }
584
+
585
+        if ( isset( $this->defaults[ $name ] ) ) {
586
+            return $this->defaults[ $name ];
587
+        }
588
+
589
+        return null;
590
+    }
591
+
592
+    /**
593
+     * Retrieve the model's original attribute value.
594
+     *
595
+     * @param string $name
596
+     *
597
+     * @return mixed
598
+     *
599
+     * @throws PropertyDoesNotExistException If property isn't found.
600
+     */
601
+    public function get_original_attribute( $name ) {
602
+        $original_attributes = $this->original;
603
+
604
+        if ( ! is_object( $original_attributes[ static::OBJECT_KEY ] ) ) {
605
+            unset( $original_attributes[ static::OBJECT_KEY ] );
606
+        }
607
+
608
+        $original = new static( $original_attributes );
609
+
610
+        return $original->get_attribute( $name );
611
+    }
612
+
613
+    /**
614
+     * Fetches the Model's primary ID, depending on the model
615
+     * implementation.
616
+     *
617
+     * @return int
618
+     *
619
+     * @throws LogicException
620
+     */
621
+    public function get_primary_id() {
622
+        if ( $this instanceof UsesWordPressPost ) {
623
+            return $this->get_underlying_wp_object()->ID;
624
+        }
625
+
626
+        if ( $this instanceof UsesWordPressTerm ) {
627
+            return $this->get_underlying_wp_object()->term_id;
628
+        }
629
+
630
+        if ( $this instanceof UsesCustomTable ) {
631
+            return $this->get_attribute( $this->get_primary_key() );
632
+        }
633
+
634
+        // Model w/o wp_object not yet supported.
635
+        throw new LogicException;
636
+    }
637
+
638
+    /**
639
+     * Checks whether the attribute has a map method.
640
+     *
641
+     * This is used to determine whether the attribute maps to a
642
+     * property on the underlying WP_Post object. Returns the
643
+     * method if one exists, returns false if it doesn't.
644
+     *
645
+     * @param string $name
646
+     *
647
+     * @return false|string
648
+     */
649
+    protected function has_map_method( $name ) {
650
+        if ( method_exists( $this, $method = "map_{$name}" ) ) {
651
+            return $method;
652
+        }
653
+
654
+        return false;
655
+    }
656
+
657
+    /**
658
+     * Checks whether the attribute has a compute method.
659
+     *
660
+     * This is used to determine if the attribute should be computed
661
+     * from other attributes.
662
+     *
663
+     * @param string $name
664
+     *
665
+     * @return false|string
666
+     */
667
+    protected function has_compute_method( $name ) {
668
+        if ( method_exists( $this, $method = "compute_{$name}" ) ) {
669
+            return $method;
670
+        }
671
+
672
+        return false;
673
+    }
674
+
675
+    /**
676
+     * Clears all the current attributes from the model.
677
+     *
678
+     * This does not touch the model's original attributes, and will
679
+     * only clear fillable attributes, unless the model is unguarded.
680
+     *
681
+     * @throws Exception
682
+     * @return $this
683
+     */
684
+    public function clear() {
685
+        $keys = array_merge(
686
+            $this->get_table_keys(),
687
+            $this->get_wp_object_keys()
688
+        );
689
+
690
+        foreach ( $keys as $key ) {
691
+            try {
692
+                $this->set_attribute( $key, null );
693
+            } catch ( Exception $e ) {
694
+                // We won't clear out guarded attributes.
695
+                if ( ! ( $e instanceof GuardedPropertyException ) ) {
696
+                    throw $e;
697
+                }
698
+            }
699
+        }
700
+
701
+        return $this;
702
+    }
703
+
704
+    /**
705
+     * Unguards the model.
706
+     *
707
+     * Sets the model to be unguarded, allowing the filling of
708
+     * guarded attributes.
709
+     */
710
+    public function unguard() {
711
+        $this->is_guarded = false;
712
+    }
713
+
714
+    /**
715
+     * Reguards the model.
716
+     *
717
+     * Sets the model to be guarded, preventing filling of
718
+     * guarded attributes.
719
+     */
720
+    public function reguard() {
721
+        $this->is_guarded = true;
722
+    }
723
+
724
+    /**
725
+     * Retrieves all the compute methods on the model.
726
+     *
727
+     * @return array
728
+     */
729
+    protected function get_compute_methods() {
730
+        $methods = get_class_methods( get_called_class() );
731
+        $methods = array_filter( $methods, function ( $method ) {
732
+            return strrpos( $method, 'compute_', - strlen( $method ) ) !== false;
733
+        } );
734
+        $methods = array_map( function ( $method ) {
735
+            return substr( $method, strlen( 'compute_' ) );
736
+        }, $methods );
737
+
738
+        return $methods;
739
+    }
740
+
741
+    /**
742
+     * Sets up the memo array for the creating model.
743
+     */
744
+    private function maybe_boot() {
745
+        if ( ! isset( self::$memo[ get_called_class() ] ) ) {
746
+            self::$memo[ get_called_class() ] = array();
747
+        }
748
+    }
749
+
750
+    /**
751
+     * Whether this Model uses an underlying WordPress object.
752
+     *
753
+     * @return bool
754
+     */
755
+    protected function uses_wp_object() {
756
+        return $this instanceof UsesWordPressPost ||
757
+            $this instanceof UsesWordPressTerm;
758
+    }
759 759
 }
Please login to merge, or discard this patch.