Completed
Pull Request — master (#15)
by James
08:06
created
src/Contract/Axolotl/Collection.php 2 patches
Indentation   +312 added lines, -312 removed lines patch added patch discarded remove patch
@@ -9,316 +9,316 @@
 block discarded – undo
9 9
 
10 10
 interface Collection extends Iterator, Countable, Serializes {
11 11
 
12
-	/**
13
-	 * Returns the type of the collection.
14
-	 *
15
-	 * @return string
16
-	 */
17
-	public function get_type();
18
-
19
-	/**
20
-	 * Returns a collection with $element added.
21
-	 *
22
-	 * @param  mixed $element
23
-	 * @return Collection
24
-	 * @throws InvalidArgumentException
25
-	 */
26
-	public function add( $element );
27
-
28
-	/**
29
-	 * Removes every element from the collection.
30
-	 *
31
-	 * @return Collection
32
-	 */
33
-	public function clear();
34
-
35
-	/**
36
-	 * Returns true if the collection contains any elements that satisfy
37
-	 * $condition, returns false if it contains none.
38
-	 *
39
-	 * @param callable $condition
40
-	 * @return bool
41
-	 */
42
-	public function contains( callable $condition );
43
-
44
-	/**
45
-	 * Returns the first element in the collection that satisfies
46
-	 * $condition, returns false if no such element exists.
47
-	 *
48
-	 * @param callable $condition
49
-	 * @return mixed
50
-	 */
51
-	public function find( callable $condition );
52
-
53
-	/**
54
-	 * Returns the index of the first element in the collection that satisfies
55
-	 * $condition, returns -1 if no such element exists.
56
-	 *
57
-	 * @param callable $condition
58
-	 * @return int
59
-	 */
60
-	public function find_index( callable $condition );
61
-
62
-	/**
63
-	 * Returns the element in the collection at $index.
64
-	 *
65
-	 * @param  int $index Index to get element from.
66
-	 * @return mixed
67
-	 * @throws OutOfRangeException
68
-	 */
69
-	public function at( $index );
70
-
71
-	/**
72
-	 * Returns true if $index is within the collection's range and returns false
73
-	 * if it is not.
74
-	 *
75
-	 * @param  int $index Index to check for existence.
76
-	 * @return bool
77
-	 * @throws InvalidArgumentException
78
-	 */
79
-	public function index_exists( $index );
80
-
81
-	/**
82
-	 * Returns the number of elements in the collection.
83
-	 *
84
-	 * @return int
85
-	 */
86
-	public function count();
87
-
88
-	/**
89
-	 * Returns a collection that only contains the elements which satisfy
90
-	 * $condition.
91
-	 *
92
-	 * @param callable $condition
93
-	 * @return Collection
94
-	 */
95
-	public function filter( callable $condition );
96
-
97
-	/**
98
-	 * Returns the last element in the collection that satisfies $condition,
99
-	 * returns false if no such element exists.
100
-	 *
101
-	 * @param callable $condition
102
-	 * @return mixed
103
-	 */
104
-	public function find_last( callable $condition );
105
-
106
-	/**
107
-	 * Returns the index of the last element in the collection that satisfies
108
-	 * $condition, returns -1 if no such element exists.
109
-	 *
110
-	 * @param callable $condition
111
-	 * @return int
112
-	 */
113
-	public function find_last_index( callable $condition );
114
-
115
-	/**
116
-	 * Returns a collection that contains the subset of elements ranging from the
117
-	 * index $start to $end.
118
-	 *
119
-	 * @param  int $start Begining index to slice from.
120
-	 * @param  int $end   End index to slice to.
121
-	 * @return Collection
122
-	 * @throws InvalidArgumentException
123
-	 */
124
-	public function slice( $start, $end );
125
-
126
-	/**
127
-	 * Inserts $element at $index.
128
-	 *
129
-	 * @param int   $index     Index to start at.
130
-	 * @param mixed $element Element to insert.
131
-	 * @throws InvalidArgumentException
132
-	 * @throws OutOfRangeException
133
-	 */
134
-	public function insert( $index, $element );
135
-
136
-	/**
137
-	 * Inserts the range $elements at $index.
138
-	 *
139
-	 * @param int   $index
140
-	 * @param array $elements
141
-	 * @throws OutOfRangeException
142
-	 */
143
-	public function insert_range( $index, array $elements );
144
-
145
-	/**
146
-	 * Removes all of the elements that satisfy $condition.
147
-	 *
148
-	 * @param  callable $condition
149
-	 * @return Collection
150
-	 */
151
-	public function without( callable $condition );
152
-
153
-	/**
154
-	 * Removes the element at $index.
155
-	 *
156
-	 * @param  int $index Index to remove.
157
-	 * @return Collection
158
-	 * @throws OutOfRangeException
159
-	 */
160
-	public function remove_at( $index );
161
-
162
-	/**
163
-	 * Reverses the order of the elements in the collection.
164
-	 *
165
-	 * @return Collection
166
-	 */
167
-	public function reverse();
168
-
169
-	/**
170
-	 * Sorts the elements in the collection using the user supplied comparison
171
-	 * function $callback.
172
-	 *
173
-	 * @param callable $callback
174
-	 * @return Collection
175
-	 */
176
-	public function sort( callable $callback );
177
-
178
-	/**
179
-	 * Returns an array containing the elements in the collection.
180
-	 *
181
-	 * @return array
182
-	 */
183
-	public function to_array();
184
-
185
-	/**
186
-	 * Iteratively reduces the collection to a single value using the callback
187
-	 * function $callable.
188
-	 *
189
-	 * @param callable $callable
190
-	 * @param null     $initial
191
-	 * @return mixed
192
-	 */
193
-	public function reduce( callable $callable, $initial = null );
194
-
195
-	/**
196
-	 * Returns true if every element in the collection satisfies $condition,
197
-	 * returns false if not.
198
-	 *
199
-	 * @param callable $condition
200
-	 * @return bool
201
-	 */
202
-	public function every( callable $condition );
203
-
204
-	/**
205
-	 * Removes all of the elements in the collection starting at index $num.
206
-	 *
207
-	 * @param  int $num Number of elements to drop.
208
-	 * @return Collection
209
-	 * @throws InvalidArgumentException
210
-	 */
211
-	public function drop( $num );
212
-
213
-	/**
214
-	 * Removes all of the elements in the collectioin between index 0 and $num.
215
-	 *
216
-	 * @param int $num Number of elements to drop.
217
-	 * @return Collection
218
-	 * @throws InvalidArgumentException
219
-	 */
220
-	public function drop_right( $num );
221
-
222
-	/**
223
-	 * Iteratively drops elements in the collection that satisfy $condition until
224
-	 * an element is encountered that does not satisfy $condition.
225
-	 *
226
-	 * @param callable $condition
227
-	 * @return Collection
228
-	 */
229
-	public function drop_while( callable $condition );
230
-
231
-	/**
232
-	 * Removes the first element in the collection.
233
-	 *
234
-	 * @return Collection
235
-	 * @throws InvalidArgumentException
236
-	 */
237
-	public function tail();
238
-
239
-	/**
240
-	 * Removes all of the elements in the collection starting at index $num.
241
-	 *
242
-	 * @param  int $num Number of elements to take.
243
-	 * @return Collection
244
-	 * @throws InvalidArgumentException
245
-	 */
246
-	public function take( $num );
247
-
248
-	/**
249
-	 * Removes all of the elements in the collection before index $num.
250
-	 *
251
-	 * @param int $num Number of elements to take.
252
-	 * @return Collection
253
-	 * @throws InvalidArgumentException
254
-	 */
255
-	public function take_right( $num );
256
-
257
-	/**
258
-	 * Iterates through the collection until an element is encountered that does
259
-	 * not satisfy $condition, then drops all of the elements starting at that
260
-	 * index.
261
-	 *
262
-	 * @param callable $condition
263
-	 * @return Collection
264
-	 */
265
-	public function take_while( callable $condition );
266
-
267
-	/**
268
-	 * Applies the callback function $callable to each element in the collection.
269
-	 *
270
-	 * @param callable $callable
271
-	 */
272
-	public function each( callable $callable );
273
-
274
-	/**
275
-	 * Returns a new instance of the collection with the callback function
276
-	 * $callable applied to each element.
277
-	 *
278
-	 * @param callable $callable
279
-	 * @return Collection
280
-	 */
281
-	public function map( callable $callable );
282
-
283
-	/**
284
-	 * Iteratively reduces the collection to a single value using the callback
285
-	 * function $callable starting at the rightmost index.
286
-	 *
287
-	 * @param callable $callable
288
-	 * @param null     $initial
289
-	 * @return mixed
290
-	 */
291
-	public function reduce_right( callable $callable, $initial = null );
292
-
293
-	/**
294
-	 * Randomly reorders the elements in the collection.
295
-	 *
296
-	 * @return Collection
297
-	 */
298
-	public function shuffle();
299
-
300
-	/**
301
-	 * Adds every member of $elements to the collection.
302
-	 *
303
-	 * @param array $elements Array of elements to merge.
304
-	 * @return Collection
305
-	 * @throws InvalidArgumentException
306
-	 */
307
-	public function merge( array $elements );
308
-
309
-	/**
310
-	 * Get first element of the collection
311
-	 *
312
-	 * @return mixed
313
-	 * @throws OutOfBoundsException
314
-	 */
315
-	public function first();
316
-
317
-	/**
318
-	 * Get last element of the collection
319
-	 *
320
-	 * @return mixed
321
-	 * @throws OutOfBoundsException
322
-	 */
323
-	public function last();
12
+    /**
13
+     * Returns the type of the collection.
14
+     *
15
+     * @return string
16
+     */
17
+    public function get_type();
18
+
19
+    /**
20
+     * Returns a collection with $element added.
21
+     *
22
+     * @param  mixed $element
23
+     * @return Collection
24
+     * @throws InvalidArgumentException
25
+     */
26
+    public function add( $element );
27
+
28
+    /**
29
+     * Removes every element from the collection.
30
+     *
31
+     * @return Collection
32
+     */
33
+    public function clear();
34
+
35
+    /**
36
+     * Returns true if the collection contains any elements that satisfy
37
+     * $condition, returns false if it contains none.
38
+     *
39
+     * @param callable $condition
40
+     * @return bool
41
+     */
42
+    public function contains( callable $condition );
43
+
44
+    /**
45
+     * Returns the first element in the collection that satisfies
46
+     * $condition, returns false if no such element exists.
47
+     *
48
+     * @param callable $condition
49
+     * @return mixed
50
+     */
51
+    public function find( callable $condition );
52
+
53
+    /**
54
+     * Returns the index of the first element in the collection that satisfies
55
+     * $condition, returns -1 if no such element exists.
56
+     *
57
+     * @param callable $condition
58
+     * @return int
59
+     */
60
+    public function find_index( callable $condition );
61
+
62
+    /**
63
+     * Returns the element in the collection at $index.
64
+     *
65
+     * @param  int $index Index to get element from.
66
+     * @return mixed
67
+     * @throws OutOfRangeException
68
+     */
69
+    public function at( $index );
70
+
71
+    /**
72
+     * Returns true if $index is within the collection's range and returns false
73
+     * if it is not.
74
+     *
75
+     * @param  int $index Index to check for existence.
76
+     * @return bool
77
+     * @throws InvalidArgumentException
78
+     */
79
+    public function index_exists( $index );
80
+
81
+    /**
82
+     * Returns the number of elements in the collection.
83
+     *
84
+     * @return int
85
+     */
86
+    public function count();
87
+
88
+    /**
89
+     * Returns a collection that only contains the elements which satisfy
90
+     * $condition.
91
+     *
92
+     * @param callable $condition
93
+     * @return Collection
94
+     */
95
+    public function filter( callable $condition );
96
+
97
+    /**
98
+     * Returns the last element in the collection that satisfies $condition,
99
+     * returns false if no such element exists.
100
+     *
101
+     * @param callable $condition
102
+     * @return mixed
103
+     */
104
+    public function find_last( callable $condition );
105
+
106
+    /**
107
+     * Returns the index of the last element in the collection that satisfies
108
+     * $condition, returns -1 if no such element exists.
109
+     *
110
+     * @param callable $condition
111
+     * @return int
112
+     */
113
+    public function find_last_index( callable $condition );
114
+
115
+    /**
116
+     * Returns a collection that contains the subset of elements ranging from the
117
+     * index $start to $end.
118
+     *
119
+     * @param  int $start Begining index to slice from.
120
+     * @param  int $end   End index to slice to.
121
+     * @return Collection
122
+     * @throws InvalidArgumentException
123
+     */
124
+    public function slice( $start, $end );
125
+
126
+    /**
127
+     * Inserts $element at $index.
128
+     *
129
+     * @param int   $index     Index to start at.
130
+     * @param mixed $element Element to insert.
131
+     * @throws InvalidArgumentException
132
+     * @throws OutOfRangeException
133
+     */
134
+    public function insert( $index, $element );
135
+
136
+    /**
137
+     * Inserts the range $elements at $index.
138
+     *
139
+     * @param int   $index
140
+     * @param array $elements
141
+     * @throws OutOfRangeException
142
+     */
143
+    public function insert_range( $index, array $elements );
144
+
145
+    /**
146
+     * Removes all of the elements that satisfy $condition.
147
+     *
148
+     * @param  callable $condition
149
+     * @return Collection
150
+     */
151
+    public function without( callable $condition );
152
+
153
+    /**
154
+     * Removes the element at $index.
155
+     *
156
+     * @param  int $index Index to remove.
157
+     * @return Collection
158
+     * @throws OutOfRangeException
159
+     */
160
+    public function remove_at( $index );
161
+
162
+    /**
163
+     * Reverses the order of the elements in the collection.
164
+     *
165
+     * @return Collection
166
+     */
167
+    public function reverse();
168
+
169
+    /**
170
+     * Sorts the elements in the collection using the user supplied comparison
171
+     * function $callback.
172
+     *
173
+     * @param callable $callback
174
+     * @return Collection
175
+     */
176
+    public function sort( callable $callback );
177
+
178
+    /**
179
+     * Returns an array containing the elements in the collection.
180
+     *
181
+     * @return array
182
+     */
183
+    public function to_array();
184
+
185
+    /**
186
+     * Iteratively reduces the collection to a single value using the callback
187
+     * function $callable.
188
+     *
189
+     * @param callable $callable
190
+     * @param null     $initial
191
+     * @return mixed
192
+     */
193
+    public function reduce( callable $callable, $initial = null );
194
+
195
+    /**
196
+     * Returns true if every element in the collection satisfies $condition,
197
+     * returns false if not.
198
+     *
199
+     * @param callable $condition
200
+     * @return bool
201
+     */
202
+    public function every( callable $condition );
203
+
204
+    /**
205
+     * Removes all of the elements in the collection starting at index $num.
206
+     *
207
+     * @param  int $num Number of elements to drop.
208
+     * @return Collection
209
+     * @throws InvalidArgumentException
210
+     */
211
+    public function drop( $num );
212
+
213
+    /**
214
+     * Removes all of the elements in the collectioin between index 0 and $num.
215
+     *
216
+     * @param int $num Number of elements to drop.
217
+     * @return Collection
218
+     * @throws InvalidArgumentException
219
+     */
220
+    public function drop_right( $num );
221
+
222
+    /**
223
+     * Iteratively drops elements in the collection that satisfy $condition until
224
+     * an element is encountered that does not satisfy $condition.
225
+     *
226
+     * @param callable $condition
227
+     * @return Collection
228
+     */
229
+    public function drop_while( callable $condition );
230
+
231
+    /**
232
+     * Removes the first element in the collection.
233
+     *
234
+     * @return Collection
235
+     * @throws InvalidArgumentException
236
+     */
237
+    public function tail();
238
+
239
+    /**
240
+     * Removes all of the elements in the collection starting at index $num.
241
+     *
242
+     * @param  int $num Number of elements to take.
243
+     * @return Collection
244
+     * @throws InvalidArgumentException
245
+     */
246
+    public function take( $num );
247
+
248
+    /**
249
+     * Removes all of the elements in the collection before index $num.
250
+     *
251
+     * @param int $num Number of elements to take.
252
+     * @return Collection
253
+     * @throws InvalidArgumentException
254
+     */
255
+    public function take_right( $num );
256
+
257
+    /**
258
+     * Iterates through the collection until an element is encountered that does
259
+     * not satisfy $condition, then drops all of the elements starting at that
260
+     * index.
261
+     *
262
+     * @param callable $condition
263
+     * @return Collection
264
+     */
265
+    public function take_while( callable $condition );
266
+
267
+    /**
268
+     * Applies the callback function $callable to each element in the collection.
269
+     *
270
+     * @param callable $callable
271
+     */
272
+    public function each( callable $callable );
273
+
274
+    /**
275
+     * Returns a new instance of the collection with the callback function
276
+     * $callable applied to each element.
277
+     *
278
+     * @param callable $callable
279
+     * @return Collection
280
+     */
281
+    public function map( callable $callable );
282
+
283
+    /**
284
+     * Iteratively reduces the collection to a single value using the callback
285
+     * function $callable starting at the rightmost index.
286
+     *
287
+     * @param callable $callable
288
+     * @param null     $initial
289
+     * @return mixed
290
+     */
291
+    public function reduce_right( callable $callable, $initial = null );
292
+
293
+    /**
294
+     * Randomly reorders the elements in the collection.
295
+     *
296
+     * @return Collection
297
+     */
298
+    public function shuffle();
299
+
300
+    /**
301
+     * Adds every member of $elements to the collection.
302
+     *
303
+     * @param array $elements Array of elements to merge.
304
+     * @return Collection
305
+     * @throws InvalidArgumentException
306
+     */
307
+    public function merge( array $elements );
308
+
309
+    /**
310
+     * Get first element of the collection
311
+     *
312
+     * @return mixed
313
+     * @throws OutOfBoundsException
314
+     */
315
+    public function first();
316
+
317
+    /**
318
+     * Get last element of the collection
319
+     *
320
+     * @return mixed
321
+     * @throws OutOfBoundsException
322
+     */
323
+    public function last();
324 324
 }
Please login to merge, or discard this patch.
Spacing   +27 added lines, -27 removed lines patch added patch discarded remove patch
@@ -23,7 +23,7 @@  discard block
 block discarded – undo
23 23
 	 * @return Collection
24 24
 	 * @throws InvalidArgumentException
25 25
 	 */
26
-	public function add( $element );
26
+	public function add($element);
27 27
 
28 28
 	/**
29 29
 	 * Removes every element from the collection.
@@ -39,7 +39,7 @@  discard block
 block discarded – undo
39 39
 	 * @param callable $condition
40 40
 	 * @return bool
41 41
 	 */
42
-	public function contains( callable $condition );
42
+	public function contains(callable $condition);
43 43
 
44 44
 	/**
45 45
 	 * Returns the first element in the collection that satisfies
@@ -48,7 +48,7 @@  discard block
 block discarded – undo
48 48
 	 * @param callable $condition
49 49
 	 * @return mixed
50 50
 	 */
51
-	public function find( callable $condition );
51
+	public function find(callable $condition);
52 52
 
53 53
 	/**
54 54
 	 * Returns the index of the first element in the collection that satisfies
@@ -57,7 +57,7 @@  discard block
 block discarded – undo
57 57
 	 * @param callable $condition
58 58
 	 * @return int
59 59
 	 */
60
-	public function find_index( callable $condition );
60
+	public function find_index(callable $condition);
61 61
 
62 62
 	/**
63 63
 	 * Returns the element in the collection at $index.
@@ -66,7 +66,7 @@  discard block
 block discarded – undo
66 66
 	 * @return mixed
67 67
 	 * @throws OutOfRangeException
68 68
 	 */
69
-	public function at( $index );
69
+	public function at($index);
70 70
 
71 71
 	/**
72 72
 	 * Returns true if $index is within the collection's range and returns false
@@ -76,7 +76,7 @@  discard block
 block discarded – undo
76 76
 	 * @return bool
77 77
 	 * @throws InvalidArgumentException
78 78
 	 */
79
-	public function index_exists( $index );
79
+	public function index_exists($index);
80 80
 
81 81
 	/**
82 82
 	 * Returns the number of elements in the collection.
@@ -92,7 +92,7 @@  discard block
 block discarded – undo
92 92
 	 * @param callable $condition
93 93
 	 * @return Collection
94 94
 	 */
95
-	public function filter( callable $condition );
95
+	public function filter(callable $condition);
96 96
 
97 97
 	/**
98 98
 	 * Returns the last element in the collection that satisfies $condition,
@@ -101,7 +101,7 @@  discard block
 block discarded – undo
101 101
 	 * @param callable $condition
102 102
 	 * @return mixed
103 103
 	 */
104
-	public function find_last( callable $condition );
104
+	public function find_last(callable $condition);
105 105
 
106 106
 	/**
107 107
 	 * Returns the index of the last element in the collection that satisfies
@@ -110,7 +110,7 @@  discard block
 block discarded – undo
110 110
 	 * @param callable $condition
111 111
 	 * @return int
112 112
 	 */
113
-	public function find_last_index( callable $condition );
113
+	public function find_last_index(callable $condition);
114 114
 
115 115
 	/**
116 116
 	 * Returns a collection that contains the subset of elements ranging from the
@@ -121,7 +121,7 @@  discard block
 block discarded – undo
121 121
 	 * @return Collection
122 122
 	 * @throws InvalidArgumentException
123 123
 	 */
124
-	public function slice( $start, $end );
124
+	public function slice($start, $end);
125 125
 
126 126
 	/**
127 127
 	 * Inserts $element at $index.
@@ -131,7 +131,7 @@  discard block
 block discarded – undo
131 131
 	 * @throws InvalidArgumentException
132 132
 	 * @throws OutOfRangeException
133 133
 	 */
134
-	public function insert( $index, $element );
134
+	public function insert($index, $element);
135 135
 
136 136
 	/**
137 137
 	 * Inserts the range $elements at $index.
@@ -140,7 +140,7 @@  discard block
 block discarded – undo
140 140
 	 * @param array $elements
141 141
 	 * @throws OutOfRangeException
142 142
 	 */
143
-	public function insert_range( $index, array $elements );
143
+	public function insert_range($index, array $elements);
144 144
 
145 145
 	/**
146 146
 	 * Removes all of the elements that satisfy $condition.
@@ -148,7 +148,7 @@  discard block
 block discarded – undo
148 148
 	 * @param  callable $condition
149 149
 	 * @return Collection
150 150
 	 */
151
-	public function without( callable $condition );
151
+	public function without(callable $condition);
152 152
 
153 153
 	/**
154 154
 	 * Removes the element at $index.
@@ -157,7 +157,7 @@  discard block
 block discarded – undo
157 157
 	 * @return Collection
158 158
 	 * @throws OutOfRangeException
159 159
 	 */
160
-	public function remove_at( $index );
160
+	public function remove_at($index);
161 161
 
162 162
 	/**
163 163
 	 * Reverses the order of the elements in the collection.
@@ -173,7 +173,7 @@  discard block
 block discarded – undo
173 173
 	 * @param callable $callback
174 174
 	 * @return Collection
175 175
 	 */
176
-	public function sort( callable $callback );
176
+	public function sort(callable $callback);
177 177
 
178 178
 	/**
179 179
 	 * Returns an array containing the elements in the collection.
@@ -190,7 +190,7 @@  discard block
 block discarded – undo
190 190
 	 * @param null     $initial
191 191
 	 * @return mixed
192 192
 	 */
193
-	public function reduce( callable $callable, $initial = null );
193
+	public function reduce(callable $callable, $initial = null);
194 194
 
195 195
 	/**
196 196
 	 * Returns true if every element in the collection satisfies $condition,
@@ -199,7 +199,7 @@  discard block
 block discarded – undo
199 199
 	 * @param callable $condition
200 200
 	 * @return bool
201 201
 	 */
202
-	public function every( callable $condition );
202
+	public function every(callable $condition);
203 203
 
204 204
 	/**
205 205
 	 * Removes all of the elements in the collection starting at index $num.
@@ -208,7 +208,7 @@  discard block
 block discarded – undo
208 208
 	 * @return Collection
209 209
 	 * @throws InvalidArgumentException
210 210
 	 */
211
-	public function drop( $num );
211
+	public function drop($num);
212 212
 
213 213
 	/**
214 214
 	 * Removes all of the elements in the collectioin between index 0 and $num.
@@ -217,7 +217,7 @@  discard block
 block discarded – undo
217 217
 	 * @return Collection
218 218
 	 * @throws InvalidArgumentException
219 219
 	 */
220
-	public function drop_right( $num );
220
+	public function drop_right($num);
221 221
 
222 222
 	/**
223 223
 	 * Iteratively drops elements in the collection that satisfy $condition until
@@ -226,7 +226,7 @@  discard block
 block discarded – undo
226 226
 	 * @param callable $condition
227 227
 	 * @return Collection
228 228
 	 */
229
-	public function drop_while( callable $condition );
229
+	public function drop_while(callable $condition);
230 230
 
231 231
 	/**
232 232
 	 * Removes the first element in the collection.
@@ -243,7 +243,7 @@  discard block
 block discarded – undo
243 243
 	 * @return Collection
244 244
 	 * @throws InvalidArgumentException
245 245
 	 */
246
-	public function take( $num );
246
+	public function take($num);
247 247
 
248 248
 	/**
249 249
 	 * Removes all of the elements in the collection before index $num.
@@ -252,7 +252,7 @@  discard block
 block discarded – undo
252 252
 	 * @return Collection
253 253
 	 * @throws InvalidArgumentException
254 254
 	 */
255
-	public function take_right( $num );
255
+	public function take_right($num);
256 256
 
257 257
 	/**
258 258
 	 * Iterates through the collection until an element is encountered that does
@@ -262,14 +262,14 @@  discard block
 block discarded – undo
262 262
 	 * @param callable $condition
263 263
 	 * @return Collection
264 264
 	 */
265
-	public function take_while( callable $condition );
265
+	public function take_while(callable $condition);
266 266
 
267 267
 	/**
268 268
 	 * Applies the callback function $callable to each element in the collection.
269 269
 	 *
270 270
 	 * @param callable $callable
271 271
 	 */
272
-	public function each( callable $callable );
272
+	public function each(callable $callable);
273 273
 
274 274
 	/**
275 275
 	 * Returns a new instance of the collection with the callback function
@@ -278,7 +278,7 @@  discard block
 block discarded – undo
278 278
 	 * @param callable $callable
279 279
 	 * @return Collection
280 280
 	 */
281
-	public function map( callable $callable );
281
+	public function map(callable $callable);
282 282
 
283 283
 	/**
284 284
 	 * Iteratively reduces the collection to a single value using the callback
@@ -288,7 +288,7 @@  discard block
 block discarded – undo
288 288
 	 * @param null     $initial
289 289
 	 * @return mixed
290 290
 	 */
291
-	public function reduce_right( callable $callable, $initial = null );
291
+	public function reduce_right(callable $callable, $initial = null);
292 292
 
293 293
 	/**
294 294
 	 * Randomly reorders the elements in the collection.
@@ -304,7 +304,7 @@  discard block
 block discarded – undo
304 304
 	 * @return Collection
305 305
 	 * @throws InvalidArgumentException
306 306
 	 */
307
-	public function merge( array $elements );
307
+	public function merge(array $elements);
308 308
 
309 309
 	/**
310 310
 	 * Get first element of the collection
Please login to merge, or discard this patch.
src/Axolotl/Model.php 2 patches
Indentation   +730 added lines, -730 removed lines patch added patch discarded remove patch
@@ -21,734 +21,734 @@
 block discarded – undo
21 21
  * @since      0.1.0
22 22
  */
23 23
 abstract class Model implements Serializes {
24
-	/**
25
-	 * Table attribute key.
26
-	 */
27
-	const TABLE_KEY = '@@table';
28
-
29
-	/**
30
-	 * Object attribute key.
31
-	 */
32
-	const OBJECT_KEY = '@@object';
33
-
34
-	/**
35
-	 * Memoized values for class methods.
36
-	 *
37
-	 * @var array
38
-	 */
39
-	private static $memo = array();
40
-
41
-	/**
42
-	 * Model attributes.
43
-	 *
44
-	 * @var array
45
-	 */
46
-	private $attributes = array(
47
-		self::TABLE_KEY  => array(),
48
-		self::OBJECT_KEY => null,
49
-	);
50
-
51
-	/**
52
-	 * Model's original attributes.
53
-	 *
54
-	 * @var array
55
-	 */
56
-	private $original = array(
57
-		self::TABLE_KEY  => array(),
58
-		self::OBJECT_KEY => null,
59
-	);
60
-
61
-	/**
62
-	 * Default attribute values.
63
-	 *
64
-	 * @var array
65
-	 */
66
-	protected $defaults = array();
67
-
68
-	/**
69
-	 * Properties which are allowed to be set on the model.
70
-	 *
71
-	 * If this array is empty, any attributes can be set on the model.
72
-	 *
73
-	 * @var string[]
74
-	 */
75
-	protected $fillable = array();
76
-
77
-	/**
78
-	 * Properties which cannot be automatically filled on the model.
79
-	 *
80
-	 * If the model is unguarded, these properties can be filled.
81
-	 *
82
-	 * @var array
83
-	 */
84
-	protected $guarded = array();
85
-
86
-	/**
87
-	 * Properties which should not be serialized.
88
-	 *
89
-	 * @var array
90
-	 */
91
-	protected $hidden = array();
92
-
93
-	/**
94
-	 * Properties which should be serialized.
95
-	 *
96
-	 * @var array
97
-	 */
98
-	protected $visible = array();
99
-
100
-	/**
101
-	 * Whether the model's properties are guarded.
102
-	 *
103
-	 * When false, allows guarded properties to be filled.
104
-	 *
105
-	 * @var bool
106
-	 */
107
-	protected $is_guarded = true;
108
-
109
-	/**
110
-	 * Constructs a new model with provided attributes.
111
-	 *
112
-	 * If self::OBJECT_KEY is passed as one of the attributes, the underlying post
113
-	 * will be overwritten.
114
-	 *
115
-	 * @param array <string, mixed> $attributes
116
-	 */
117
-	public function __construct( array $attributes = array() ) {
118
-		$this->maybe_boot();
119
-		$this->sync_original();
120
-
121
-		if ( $this->uses_wp_object() ) {
122
-			$this->create_wp_object();
123
-		}
124
-
125
-		$this->unguard();
126
-		$this->refresh( $attributes );
127
-		$this->reguard();
128
-	}
129
-
130
-	/**
131
-	 * Refreshes the model's current attributes with the provided array.
132
-	 *
133
-	 * The model's attributes will match what was provided in the array,
134
-	 * and any attributes not passed
135
-	 *
136
-	 * @param array $attributes
137
-	 *
138
-	 * @return $this
139
-	 */
140
-	public function refresh( array $attributes ) {
141
-		$this->clear();
142
-
143
-		return $this->merge( $attributes );
144
-	}
145
-
146
-	/**
147
-	 * Merges the provided attributes with the provided array.
148
-	 *
149
-	 * @param array $attributes
150
-	 *
151
-	 * @return $this
152
-	 */
153
-	public function merge( array $attributes ) {
154
-		foreach ( $attributes as $name => $value ) {
155
-			$this->set_attribute( $name, $value );
156
-		}
157
-
158
-		return $this;
159
-	}
160
-
161
-	/**
162
-	 * Get the model's table attributes.
163
-	 *
164
-	 * Returns the array of for the model that will either need to be
165
-	 * saved in postmeta or a separate table.
166
-	 *
167
-	 * @return array
168
-	 */
169
-	public function get_table_attributes() {
170
-		return $this->attributes[ self::TABLE_KEY ];
171
-	}
172
-
173
-	/**
174
-	 * Get the model's original attributes.
175
-	 *
176
-	 * @return array
177
-	 */
178
-	public function get_original_table_attributes() {
179
-		return $this->original[ self::TABLE_KEY ];
180
-	}
181
-
182
-	/**
183
-	 * Retrieve an array of the attributes on the model
184
-	 * that have changed compared to the model's
185
-	 * original data.
186
-	 *
187
-	 * @return array
188
-	 */
189
-	public function get_changed_table_attributes() {
190
-		$changed = array();
191
-
192
-		foreach ( $this->get_table_attributes() as $key => $value ) {
193
-			if ( $value !==
194
-				 $this->get_original_attribute( $key )
195
-			) {
196
-				$changed[ $key ] = $value;
197
-			}
198
-		}
199
-
200
-		return $changed;
201
-	}
202
-
203
-	/**
204
-	 * Get the model's underlying post.
205
-	 *
206
-	 * Returns the underlying WP_Post object for the model, representing
207
-	 * the data that will be save in the wp_posts table.
208
-	 *
209
-	 * @return false|WP_Post|WP_Term
210
-	 */
211
-	public function get_underlying_wp_object() {
212
-		if ( isset( $this->attributes[ self::OBJECT_KEY ] ) ) {
213
-			return $this->attributes[ self::OBJECT_KEY ];
214
-		}
215
-
216
-		return false;
217
-	}
218
-
219
-	/**
220
-	 * Get the model's original underlying post.
221
-	 *
222
-	 * @return WP_Post
223
-	 */
224
-	public function get_original_underlying_wp_object() {
225
-		return $this->original[ self::OBJECT_KEY ];
226
-	}
227
-
228
-	/**
229
-	 * Get the model attributes on the WordPress object
230
-	 * that have changed compared to the model's
231
-	 * original attributes.
232
-	 *
233
-	 * @return array
234
-	 */
235
-	public function get_changed_wp_object_attributes() {
236
-		$changed = array();
237
-
238
-		foreach ( $this->get_wp_object_keys() as $key ) {
239
-			if ( $this->get_attribute( $key ) !==
240
-				 $this->get_original_attribute( $key )
241
-			) {
242
-				$changed[ $key ] = $this->get_attribute( $key );
243
-			}
244
-		}
245
-
246
-		return $changed;
247
-	}
248
-
249
-	/**
250
-	 * Magic __set method.
251
-	 *
252
-	 * Passes the name and value to set_attribute, which is where the magic happens.
253
-	 *
254
-	 * @param string $name
255
-	 * @param mixed  $value
256
-	 */
257
-	public function __set( $name, $value ) {
258
-		$this->set_attribute( $name, $value );
259
-	}
260
-
261
-	/**
262
-	 * Sets the model attributes.
263
-	 *
264
-	 * Checks whether the model attribute can be set, check if it
265
-	 * maps to the WP_Post property, otherwise, assigns it to the
266
-	 * table attribute array.
267
-	 *
268
-	 * @param string $name
269
-	 * @param mixed  $value
270
-	 *
271
-	 * @return $this
272
-	 *
273
-	 * @throws GuardedPropertyException
274
-	 */
275
-	public function set_attribute( $name, $value ) {
276
-		if ( self::OBJECT_KEY === $name ) {
277
-			return $this->override_wp_object( $value );
278
-		}
279
-
280
-		if ( self::TABLE_KEY === $name ) {
281
-			return $this->override_table( $value );
282
-		}
283
-
284
-		if ( ! $this->is_fillable( $name ) ) {
285
-			throw new GuardedPropertyException;
286
-		}
287
-
288
-		if ( $method = $this->has_map_method( $name ) ) {
289
-			$this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()} = $value;
290
-		} else {
291
-			$this->attributes[ self::TABLE_KEY ][ $name ] = $value;
292
-		}
293
-
294
-		return $this;
295
-	}
296
-
297
-	/**
298
-	 * Retrieves all the attribute keys for the model.
299
-	 *
300
-	 * @return array
301
-	 */
302
-	public function get_attribute_keys() {
303
-		if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
304
-			return self::$memo[ get_called_class() ][ __METHOD__ ];
305
-		}
306
-
307
-		return self::$memo[ get_called_class() ][ __METHOD__ ]
308
-			= array_merge(
309
-				$this->fillable,
310
-				$this->guarded,
311
-				$this->get_compute_methods()
312
-			);
313
-	}
314
-
315
-	/**
316
-	 * Retrieves the attribute keys that aren't mapped to a post.
317
-	 *
318
-	 * @return array
319
-	 */
320
-	public function get_table_keys() {
321
-		if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
322
-			return self::$memo[ get_called_class() ][ __METHOD__ ];
323
-		}
324
-
325
-		$keys = array();
326
-
327
-		foreach ( $this->get_attribute_keys() as $key ) {
328
-			if ( ! $this->has_map_method( $key ) &&
329
-				 ! $this->has_compute_method( $key )
330
-			) {
331
-				$keys[] = $key;
332
-			}
333
-		}
334
-
335
-		return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
336
-	}
337
-
338
-	/**
339
-	 * Retrieves the attribute keys that are mapped to a post.
340
-	 *
341
-	 * @return array
342
-	 */
343
-	public function get_wp_object_keys() {
344
-		if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
345
-			return self::$memo[ get_called_class() ][ __METHOD__ ];
346
-		}
347
-
348
-		$keys = array();
349
-
350
-		foreach ( $this->get_attribute_keys() as $key ) {
351
-			if ( $this->has_map_method( $key ) ) {
352
-				$keys[] = $key;
353
-			}
354
-		}
355
-
356
-		return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
357
-	}
358
-
359
-	/**
360
-	 * Returns the model's keys that are computed at call time.
361
-	 *
362
-	 * @return array
363
-	 */
364
-	public function get_computed_keys() {
365
-		if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
366
-			return self::$memo[ get_called_class() ][ __METHOD__ ];
367
-		}
368
-
369
-		$keys = array();
370
-
371
-		foreach ( $this->get_attribute_keys() as $key ) {
372
-			if ( $this->has_compute_method( $key ) ) {
373
-				$keys[] = $key;
374
-			}
375
-		}
376
-
377
-		return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
378
-	}
379
-
380
-	/**
381
-	 * Serializes the model's public data into an array.
382
-	 *
383
-	 * @return array
384
-	 */
385
-	public function serialize() {
386
-		$attributes = array();
387
-
388
-		if ( $this->visible ) {
389
-			// If visible attributes are set, we'll only reveal those.
390
-			foreach ( $this->visible as $key ) {
391
-				$attributes[ $key ] = $this->get_attribute( $key );
392
-			}
393
-		} elseif ( $this->hidden ) {
394
-			// If hidden attributes are set, we'll grab everything and hide those.
395
-			foreach ( $this->get_attribute_keys() as $key ) {
396
-				if ( ! in_array( $key, $this->hidden ) ) {
397
-					$attributes[ $key ] = $this->get_attribute( $key );
398
-				}
399
-			}
400
-		} else {
401
-			// If nothing is hidden/visible, we'll grab and reveal everything.
402
-			foreach ( $this->get_attribute_keys() as $key ) {
403
-				$attributes[ $key ] = $this->get_attribute( $key );
404
-			}
405
-		}
406
-
407
-		return array_map( function ( $attribute ) {
408
-			if ( $attribute instanceof Serializes ) {
409
-				return $attribute->serialize();
410
-			}
411
-
412
-			return $attribute;
413
-		}, $attributes );
414
-	}
415
-
416
-	/**
417
-	 * Syncs the current attributes to the model's original.
418
-	 *
419
-	 * @return $this
420
-	 */
421
-	public function sync_original() {
422
-		$this->original = $this->attributes;
423
-
424
-		if ( $this->attributes[ self::OBJECT_KEY ] ) {
425
-			$this->original[ self::OBJECT_KEY ] = clone $this->attributes[ self::OBJECT_KEY ];
426
-		}
427
-
428
-		foreach ( $this->original[ self::TABLE_KEY ] as $key => $item ) {
429
-			if ( is_object( $item ) ) {
430
-				$this->original[ $key ] = clone $item;
431
-			}
432
-		}
433
-
434
-		return $this;
435
-	}
436
-
437
-	/**
438
-	 * Checks if a given attribute is mass-fillable.
439
-	 *
440
-	 * Returns true if the attribute can be filled, false if it can't.
441
-	 *
442
-	 * @param string $name
443
-	 *
444
-	 * @return bool
445
-	 */
446
-	private function is_fillable( $name ) {
447
-		// If this model isn't guarded, everything is fillable.
448
-		if ( ! $this->is_guarded ) {
449
-			return true;
450
-		}
451
-
452
-		// If it's in the fillable array, then it's fillable.
453
-		if ( in_array( $name, $this->fillable ) ) {
454
-			return true;
455
-		}
456
-
457
-		// If it's explicitly guarded, then it's not fillable.
458
-		if ( in_array( $name, $this->guarded ) ) {
459
-			return false;
460
-		}
461
-
462
-		// If fillable hasn't been defined, then everything else fillable.
463
-		return ! $this->fillable;
464
-	}
465
-
466
-	/**
467
-	 * Overrides the current WordPress object with a provided one.
468
-	 *
469
-	 * Resets the post's default values and stores it in the attributes.
470
-	 *
471
-	 * @param WP_Post|WP_Term|null $value
472
-	 *
473
-	 * @return $this
474
-	 */
475
-	private function override_wp_object( $value ) {
476
-		if ( is_object( $value ) ) {
477
-			$this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $value );
478
-		} else {
479
-			$this->attributes[ self::OBJECT_KEY ] = null;
480
-
481
-			if ( $this->uses_wp_object() ) {
482
-				$this->create_wp_object();
483
-			}
484
-		}
485
-
486
-		return $this;
487
-	}
488
-
489
-	/**
490
-	 * Overrides the current table attributes array with a provided one.
491
-	 *
492
-	 * @param array $value
493
-	 *
494
-	 * @return $this
495
-	 */
496
-	private function override_table( array $value ) {
497
-		$this->attributes[ self::TABLE_KEY ] = $value;
498
-
499
-		return $this;
500
-	}
501
-
502
-	/**
503
-	 * Create and set with a new blank post.
504
-	 *
505
-	 * Creates a new WP_Post object, assigns it the default attributes,
506
-	 * and stores it in the attributes.
507
-	 *
508
-	 * @throws LogicException
509
-	 */
510
-	private function create_wp_object() {
511
-		switch ( true ) {
512
-			case $this instanceof UsesWordPressPost:
513
-				$object = new WP_Post( (object) array() );
514
-				break;
515
-			case $this instanceof UsesWordPressTerm:
516
-				$object = new WP_Term( (object) array() );
517
-				break;
518
-			default:
519
-				throw new LogicException;
520
-				break;
521
-		}
522
-
523
-		$this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $object );
524
-	}
525
-
526
-	/**
527
-	 * Enforces values on the post that can't change.
528
-	 *
529
-	 * Primarily, this is used to make sure the post_type always maps
530
-	 * to the model's "$type" property, but this can all be overridden
531
-	 * by the developer to enforce other values in the model.
532
-	 *
533
-	 * @param object $object
534
-	 *
535
-	 * @return object
536
-	 */
537
-	protected function set_wp_object_constants( $object ) {
538
-		if ( $this instanceof UsesWordPressPost ) {
539
-			$object->post_type = static::get_post_type();
540
-		}
541
-
542
-		if ( $this instanceof UsesWordPressTerm ) {
543
-			$object->taxonomy = static::get_taxonomy();
544
-		}
545
-
546
-		return $object;
547
-	}
548
-
549
-	/**
550
-	 * Magic __get method.
551
-	 *
552
-	 * Passes the name and value to get_attribute, which is where the magic happens.
553
-	 *
554
-	 * @param string $name
555
-	 *
556
-	 * @return mixed
557
-	 */
558
-	public function __get( $name ) {
559
-		return $this->get_attribute( $name );
560
-	}
561
-
562
-	/**
563
-	 * Retrieves the model attribute.
564
-	 *
565
-	 * @param string $name
566
-	 *
567
-	 * @return mixed
568
-	 *
569
-	 * @throws PropertyDoesNotExistException If property isn't found.
570
-	 */
571
-	public function get_attribute( $name ) {
572
-		if ( $method = $this->has_map_method( $name ) ) {
573
-			return $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()};
574
-		}
575
-
576
-		if ( $method = $this->has_compute_method( $name ) ) {
577
-			return $this->{$method}();
578
-		}
579
-
580
-		if ( isset( $this->attributes[ self::TABLE_KEY ][ $name ] ) ) {
581
-			return $this->attributes[ self::TABLE_KEY ][ $name ];
582
-		}
583
-
584
-		if ( isset( $this->defaults[ $name ] ) ) {
585
-			return $this->defaults[ $name ];
586
-		}
587
-
588
-		throw new PropertyDoesNotExistException( $name );
589
-	}
590
-
591
-	/**
592
-	 * Retrieve the model's original attribute value.
593
-	 *
594
-	 * @param string $name
595
-	 *
596
-	 * @return mixed
597
-	 *
598
-	 * @throws PropertyDoesNotExistException If property isn't found.
599
-	 */
600
-	public function get_original_attribute( $name ) {
601
-		$original_attributes = $this->original;
602
-
603
-		if ( ! is_object( $original_attributes[ static::OBJECT_KEY ] ) ) {
604
-			unset( $original_attributes[ static::OBJECT_KEY ] );
605
-		}
606
-
607
-		$original = new static( $original_attributes );
608
-
609
-		try {
610
-			return $original->get_attribute( $name );
611
-		} catch ( Exception $exception ) {
612
-			return null;
613
-		}
614
-	}
615
-
616
-	/**
617
-	 * Fetches the Model's primary ID, depending on the model
618
-	 * implementation.
619
-	 *
620
-	 * @return int
621
-	 *
622
-	 * @throws LogicException
623
-	 */
624
-	public function get_primary_id() {
625
-		if ( $this instanceof UsesWordPressPost ) {
626
-			return $this->get_underlying_wp_object()->ID;
627
-		}
628
-
629
-		if ( $this instanceof UsesWordPressTerm ) {
630
-			return $this->get_underlying_wp_object()->term_id;
631
-		}
632
-
633
-		// Model w/o wp_object not yet supported.
634
-		throw new LogicException;
635
-	}
636
-
637
-	/**
638
-	 * Checks whether the attribute has a map method.
639
-	 *
640
-	 * This is used to determine whether the attribute maps to a
641
-	 * property on the underlying WP_Post object. Returns the
642
-	 * method if one exists, returns false if it doesn't.
643
-	 *
644
-	 * @param string $name
645
-	 *
646
-	 * @return false|string
647
-	 */
648
-	protected function has_map_method( $name ) {
649
-		if ( method_exists( $this, $method = "map_{$name}" ) ) {
650
-			return $method;
651
-		}
652
-
653
-		return false;
654
-	}
655
-
656
-	/**
657
-	 * Checks whether the attribute has a compute method.
658
-	 *
659
-	 * This is used to determine if the attribute should be computed
660
-	 * from other attributes.
661
-	 *
662
-	 * @param string $name
663
-	 *
664
-	 * @return false|string
665
-	 */
666
-	protected function has_compute_method( $name ) {
667
-		if ( method_exists( $this, $method = "compute_{$name}" ) ) {
668
-			return $method;
669
-		}
670
-
671
-		return false;
672
-	}
673
-
674
-	/**
675
-	 * Clears all the current attributes from the model.
676
-	 *
677
-	 * This does not touch the model's original attributes, and will
678
-	 * only clear fillable attributes, unless the model is unguarded.
679
-	 *
680
-	 * @return $this
681
-	 */
682
-	public function clear() {
683
-		$keys = array_merge(
684
-			$this->get_table_keys(),
685
-			$this->get_wp_object_keys()
686
-		);
687
-
688
-		foreach ( $keys as $key ) {
689
-			try {
690
-				$this->set_attribute( $key, null );
691
-			} catch ( GuardedPropertyException $e ) {
692
-				// We won't clear out guarded attributes.
693
-			}
694
-		}
695
-
696
-		return $this;
697
-	}
698
-
699
-	/**
700
-	 * Unguards the model.
701
-	 *
702
-	 * Sets the model to be unguarded, allowing the filling of
703
-	 * guarded attributes.
704
-	 */
705
-	public function unguard() {
706
-		$this->is_guarded = false;
707
-	}
708
-
709
-	/**
710
-	 * Reguards the model.
711
-	 *
712
-	 * Sets the model to be guarded, preventing filling of
713
-	 * guarded attributes.
714
-	 */
715
-	public function reguard() {
716
-		$this->is_guarded = true;
717
-	}
718
-
719
-	/**
720
-	 * Retrieves all the compute methods on the model.
721
-	 *
722
-	 * @return array
723
-	 */
724
-	protected function get_compute_methods() {
725
-		$methods = get_class_methods( get_called_class() );
726
-		$methods = array_filter( $methods, function ( $method ) {
727
-			return strrpos( $method, 'compute_', - strlen( $method ) ) !== false;
728
-		} );
729
-		$methods = array_map( function ( $method ) {
730
-			return substr( $method, strlen( 'compute_' ) );
731
-		}, $methods );
732
-
733
-		return $methods;
734
-	}
735
-
736
-	/**
737
-	 * Sets up the memo array for the creating model.
738
-	 */
739
-	private function maybe_boot() {
740
-		if ( ! isset( self::$memo[ get_called_class() ] ) ) {
741
-			self::$memo[ get_called_class() ] = array();
742
-		}
743
-	}
744
-
745
-	/**
746
-	 * Whether this Model uses an underlying WordPress object.
747
-	 *
748
-	 * @return bool
749
-	 */
750
-	protected function uses_wp_object() {
751
-		return $this instanceof UsesWordPressPost ||
752
-			$this instanceof UsesWordPressTerm;
753
-	}
24
+    /**
25
+     * Table attribute key.
26
+     */
27
+    const TABLE_KEY = '@@table';
28
+
29
+    /**
30
+     * Object attribute key.
31
+     */
32
+    const OBJECT_KEY = '@@object';
33
+
34
+    /**
35
+     * Memoized values for class methods.
36
+     *
37
+     * @var array
38
+     */
39
+    private static $memo = array();
40
+
41
+    /**
42
+     * Model attributes.
43
+     *
44
+     * @var array
45
+     */
46
+    private $attributes = array(
47
+        self::TABLE_KEY  => array(),
48
+        self::OBJECT_KEY => null,
49
+    );
50
+
51
+    /**
52
+     * Model's original attributes.
53
+     *
54
+     * @var array
55
+     */
56
+    private $original = array(
57
+        self::TABLE_KEY  => array(),
58
+        self::OBJECT_KEY => null,
59
+    );
60
+
61
+    /**
62
+     * Default attribute values.
63
+     *
64
+     * @var array
65
+     */
66
+    protected $defaults = array();
67
+
68
+    /**
69
+     * Properties which are allowed to be set on the model.
70
+     *
71
+     * If this array is empty, any attributes can be set on the model.
72
+     *
73
+     * @var string[]
74
+     */
75
+    protected $fillable = array();
76
+
77
+    /**
78
+     * Properties which cannot be automatically filled on the model.
79
+     *
80
+     * If the model is unguarded, these properties can be filled.
81
+     *
82
+     * @var array
83
+     */
84
+    protected $guarded = array();
85
+
86
+    /**
87
+     * Properties which should not be serialized.
88
+     *
89
+     * @var array
90
+     */
91
+    protected $hidden = array();
92
+
93
+    /**
94
+     * Properties which should be serialized.
95
+     *
96
+     * @var array
97
+     */
98
+    protected $visible = array();
99
+
100
+    /**
101
+     * Whether the model's properties are guarded.
102
+     *
103
+     * When false, allows guarded properties to be filled.
104
+     *
105
+     * @var bool
106
+     */
107
+    protected $is_guarded = true;
108
+
109
+    /**
110
+     * Constructs a new model with provided attributes.
111
+     *
112
+     * If self::OBJECT_KEY is passed as one of the attributes, the underlying post
113
+     * will be overwritten.
114
+     *
115
+     * @param array <string, mixed> $attributes
116
+     */
117
+    public function __construct( array $attributes = array() ) {
118
+        $this->maybe_boot();
119
+        $this->sync_original();
120
+
121
+        if ( $this->uses_wp_object() ) {
122
+            $this->create_wp_object();
123
+        }
124
+
125
+        $this->unguard();
126
+        $this->refresh( $attributes );
127
+        $this->reguard();
128
+    }
129
+
130
+    /**
131
+     * Refreshes the model's current attributes with the provided array.
132
+     *
133
+     * The model's attributes will match what was provided in the array,
134
+     * and any attributes not passed
135
+     *
136
+     * @param array $attributes
137
+     *
138
+     * @return $this
139
+     */
140
+    public function refresh( array $attributes ) {
141
+        $this->clear();
142
+
143
+        return $this->merge( $attributes );
144
+    }
145
+
146
+    /**
147
+     * Merges the provided attributes with the provided array.
148
+     *
149
+     * @param array $attributes
150
+     *
151
+     * @return $this
152
+     */
153
+    public function merge( array $attributes ) {
154
+        foreach ( $attributes as $name => $value ) {
155
+            $this->set_attribute( $name, $value );
156
+        }
157
+
158
+        return $this;
159
+    }
160
+
161
+    /**
162
+     * Get the model's table attributes.
163
+     *
164
+     * Returns the array of for the model that will either need to be
165
+     * saved in postmeta or a separate table.
166
+     *
167
+     * @return array
168
+     */
169
+    public function get_table_attributes() {
170
+        return $this->attributes[ self::TABLE_KEY ];
171
+    }
172
+
173
+    /**
174
+     * Get the model's original attributes.
175
+     *
176
+     * @return array
177
+     */
178
+    public function get_original_table_attributes() {
179
+        return $this->original[ self::TABLE_KEY ];
180
+    }
181
+
182
+    /**
183
+     * Retrieve an array of the attributes on the model
184
+     * that have changed compared to the model's
185
+     * original data.
186
+     *
187
+     * @return array
188
+     */
189
+    public function get_changed_table_attributes() {
190
+        $changed = array();
191
+
192
+        foreach ( $this->get_table_attributes() as $key => $value ) {
193
+            if ( $value !==
194
+                    $this->get_original_attribute( $key )
195
+            ) {
196
+                $changed[ $key ] = $value;
197
+            }
198
+        }
199
+
200
+        return $changed;
201
+    }
202
+
203
+    /**
204
+     * Get the model's underlying post.
205
+     *
206
+     * Returns the underlying WP_Post object for the model, representing
207
+     * the data that will be save in the wp_posts table.
208
+     *
209
+     * @return false|WP_Post|WP_Term
210
+     */
211
+    public function get_underlying_wp_object() {
212
+        if ( isset( $this->attributes[ self::OBJECT_KEY ] ) ) {
213
+            return $this->attributes[ self::OBJECT_KEY ];
214
+        }
215
+
216
+        return false;
217
+    }
218
+
219
+    /**
220
+     * Get the model's original underlying post.
221
+     *
222
+     * @return WP_Post
223
+     */
224
+    public function get_original_underlying_wp_object() {
225
+        return $this->original[ self::OBJECT_KEY ];
226
+    }
227
+
228
+    /**
229
+     * Get the model attributes on the WordPress object
230
+     * that have changed compared to the model's
231
+     * original attributes.
232
+     *
233
+     * @return array
234
+     */
235
+    public function get_changed_wp_object_attributes() {
236
+        $changed = array();
237
+
238
+        foreach ( $this->get_wp_object_keys() as $key ) {
239
+            if ( $this->get_attribute( $key ) !==
240
+                    $this->get_original_attribute( $key )
241
+            ) {
242
+                $changed[ $key ] = $this->get_attribute( $key );
243
+            }
244
+        }
245
+
246
+        return $changed;
247
+    }
248
+
249
+    /**
250
+     * Magic __set method.
251
+     *
252
+     * Passes the name and value to set_attribute, which is where the magic happens.
253
+     *
254
+     * @param string $name
255
+     * @param mixed  $value
256
+     */
257
+    public function __set( $name, $value ) {
258
+        $this->set_attribute( $name, $value );
259
+    }
260
+
261
+    /**
262
+     * Sets the model attributes.
263
+     *
264
+     * Checks whether the model attribute can be set, check if it
265
+     * maps to the WP_Post property, otherwise, assigns it to the
266
+     * table attribute array.
267
+     *
268
+     * @param string $name
269
+     * @param mixed  $value
270
+     *
271
+     * @return $this
272
+     *
273
+     * @throws GuardedPropertyException
274
+     */
275
+    public function set_attribute( $name, $value ) {
276
+        if ( self::OBJECT_KEY === $name ) {
277
+            return $this->override_wp_object( $value );
278
+        }
279
+
280
+        if ( self::TABLE_KEY === $name ) {
281
+            return $this->override_table( $value );
282
+        }
283
+
284
+        if ( ! $this->is_fillable( $name ) ) {
285
+            throw new GuardedPropertyException;
286
+        }
287
+
288
+        if ( $method = $this->has_map_method( $name ) ) {
289
+            $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()} = $value;
290
+        } else {
291
+            $this->attributes[ self::TABLE_KEY ][ $name ] = $value;
292
+        }
293
+
294
+        return $this;
295
+    }
296
+
297
+    /**
298
+     * Retrieves all the attribute keys for the model.
299
+     *
300
+     * @return array
301
+     */
302
+    public function get_attribute_keys() {
303
+        if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
304
+            return self::$memo[ get_called_class() ][ __METHOD__ ];
305
+        }
306
+
307
+        return self::$memo[ get_called_class() ][ __METHOD__ ]
308
+            = array_merge(
309
+                $this->fillable,
310
+                $this->guarded,
311
+                $this->get_compute_methods()
312
+            );
313
+    }
314
+
315
+    /**
316
+     * Retrieves the attribute keys that aren't mapped to a post.
317
+     *
318
+     * @return array
319
+     */
320
+    public function get_table_keys() {
321
+        if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
322
+            return self::$memo[ get_called_class() ][ __METHOD__ ];
323
+        }
324
+
325
+        $keys = array();
326
+
327
+        foreach ( $this->get_attribute_keys() as $key ) {
328
+            if ( ! $this->has_map_method( $key ) &&
329
+                 ! $this->has_compute_method( $key )
330
+            ) {
331
+                $keys[] = $key;
332
+            }
333
+        }
334
+
335
+        return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
336
+    }
337
+
338
+    /**
339
+     * Retrieves the attribute keys that are mapped to a post.
340
+     *
341
+     * @return array
342
+     */
343
+    public function get_wp_object_keys() {
344
+        if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
345
+            return self::$memo[ get_called_class() ][ __METHOD__ ];
346
+        }
347
+
348
+        $keys = array();
349
+
350
+        foreach ( $this->get_attribute_keys() as $key ) {
351
+            if ( $this->has_map_method( $key ) ) {
352
+                $keys[] = $key;
353
+            }
354
+        }
355
+
356
+        return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
357
+    }
358
+
359
+    /**
360
+     * Returns the model's keys that are computed at call time.
361
+     *
362
+     * @return array
363
+     */
364
+    public function get_computed_keys() {
365
+        if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
366
+            return self::$memo[ get_called_class() ][ __METHOD__ ];
367
+        }
368
+
369
+        $keys = array();
370
+
371
+        foreach ( $this->get_attribute_keys() as $key ) {
372
+            if ( $this->has_compute_method( $key ) ) {
373
+                $keys[] = $key;
374
+            }
375
+        }
376
+
377
+        return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
378
+    }
379
+
380
+    /**
381
+     * Serializes the model's public data into an array.
382
+     *
383
+     * @return array
384
+     */
385
+    public function serialize() {
386
+        $attributes = array();
387
+
388
+        if ( $this->visible ) {
389
+            // If visible attributes are set, we'll only reveal those.
390
+            foreach ( $this->visible as $key ) {
391
+                $attributes[ $key ] = $this->get_attribute( $key );
392
+            }
393
+        } elseif ( $this->hidden ) {
394
+            // If hidden attributes are set, we'll grab everything and hide those.
395
+            foreach ( $this->get_attribute_keys() as $key ) {
396
+                if ( ! in_array( $key, $this->hidden ) ) {
397
+                    $attributes[ $key ] = $this->get_attribute( $key );
398
+                }
399
+            }
400
+        } else {
401
+            // If nothing is hidden/visible, we'll grab and reveal everything.
402
+            foreach ( $this->get_attribute_keys() as $key ) {
403
+                $attributes[ $key ] = $this->get_attribute( $key );
404
+            }
405
+        }
406
+
407
+        return array_map( function ( $attribute ) {
408
+            if ( $attribute instanceof Serializes ) {
409
+                return $attribute->serialize();
410
+            }
411
+
412
+            return $attribute;
413
+        }, $attributes );
414
+    }
415
+
416
+    /**
417
+     * Syncs the current attributes to the model's original.
418
+     *
419
+     * @return $this
420
+     */
421
+    public function sync_original() {
422
+        $this->original = $this->attributes;
423
+
424
+        if ( $this->attributes[ self::OBJECT_KEY ] ) {
425
+            $this->original[ self::OBJECT_KEY ] = clone $this->attributes[ self::OBJECT_KEY ];
426
+        }
427
+
428
+        foreach ( $this->original[ self::TABLE_KEY ] as $key => $item ) {
429
+            if ( is_object( $item ) ) {
430
+                $this->original[ $key ] = clone $item;
431
+            }
432
+        }
433
+
434
+        return $this;
435
+    }
436
+
437
+    /**
438
+     * Checks if a given attribute is mass-fillable.
439
+     *
440
+     * Returns true if the attribute can be filled, false if it can't.
441
+     *
442
+     * @param string $name
443
+     *
444
+     * @return bool
445
+     */
446
+    private function is_fillable( $name ) {
447
+        // If this model isn't guarded, everything is fillable.
448
+        if ( ! $this->is_guarded ) {
449
+            return true;
450
+        }
451
+
452
+        // If it's in the fillable array, then it's fillable.
453
+        if ( in_array( $name, $this->fillable ) ) {
454
+            return true;
455
+        }
456
+
457
+        // If it's explicitly guarded, then it's not fillable.
458
+        if ( in_array( $name, $this->guarded ) ) {
459
+            return false;
460
+        }
461
+
462
+        // If fillable hasn't been defined, then everything else fillable.
463
+        return ! $this->fillable;
464
+    }
465
+
466
+    /**
467
+     * Overrides the current WordPress object with a provided one.
468
+     *
469
+     * Resets the post's default values and stores it in the attributes.
470
+     *
471
+     * @param WP_Post|WP_Term|null $value
472
+     *
473
+     * @return $this
474
+     */
475
+    private function override_wp_object( $value ) {
476
+        if ( is_object( $value ) ) {
477
+            $this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $value );
478
+        } else {
479
+            $this->attributes[ self::OBJECT_KEY ] = null;
480
+
481
+            if ( $this->uses_wp_object() ) {
482
+                $this->create_wp_object();
483
+            }
484
+        }
485
+
486
+        return $this;
487
+    }
488
+
489
+    /**
490
+     * Overrides the current table attributes array with a provided one.
491
+     *
492
+     * @param array $value
493
+     *
494
+     * @return $this
495
+     */
496
+    private function override_table( array $value ) {
497
+        $this->attributes[ self::TABLE_KEY ] = $value;
498
+
499
+        return $this;
500
+    }
501
+
502
+    /**
503
+     * Create and set with a new blank post.
504
+     *
505
+     * Creates a new WP_Post object, assigns it the default attributes,
506
+     * and stores it in the attributes.
507
+     *
508
+     * @throws LogicException
509
+     */
510
+    private function create_wp_object() {
511
+        switch ( true ) {
512
+            case $this instanceof UsesWordPressPost:
513
+                $object = new WP_Post( (object) array() );
514
+                break;
515
+            case $this instanceof UsesWordPressTerm:
516
+                $object = new WP_Term( (object) array() );
517
+                break;
518
+            default:
519
+                throw new LogicException;
520
+                break;
521
+        }
522
+
523
+        $this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $object );
524
+    }
525
+
526
+    /**
527
+     * Enforces values on the post that can't change.
528
+     *
529
+     * Primarily, this is used to make sure the post_type always maps
530
+     * to the model's "$type" property, but this can all be overridden
531
+     * by the developer to enforce other values in the model.
532
+     *
533
+     * @param object $object
534
+     *
535
+     * @return object
536
+     */
537
+    protected function set_wp_object_constants( $object ) {
538
+        if ( $this instanceof UsesWordPressPost ) {
539
+            $object->post_type = static::get_post_type();
540
+        }
541
+
542
+        if ( $this instanceof UsesWordPressTerm ) {
543
+            $object->taxonomy = static::get_taxonomy();
544
+        }
545
+
546
+        return $object;
547
+    }
548
+
549
+    /**
550
+     * Magic __get method.
551
+     *
552
+     * Passes the name and value to get_attribute, which is where the magic happens.
553
+     *
554
+     * @param string $name
555
+     *
556
+     * @return mixed
557
+     */
558
+    public function __get( $name ) {
559
+        return $this->get_attribute( $name );
560
+    }
561
+
562
+    /**
563
+     * Retrieves the model attribute.
564
+     *
565
+     * @param string $name
566
+     *
567
+     * @return mixed
568
+     *
569
+     * @throws PropertyDoesNotExistException If property isn't found.
570
+     */
571
+    public function get_attribute( $name ) {
572
+        if ( $method = $this->has_map_method( $name ) ) {
573
+            return $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()};
574
+        }
575
+
576
+        if ( $method = $this->has_compute_method( $name ) ) {
577
+            return $this->{$method}();
578
+        }
579
+
580
+        if ( isset( $this->attributes[ self::TABLE_KEY ][ $name ] ) ) {
581
+            return $this->attributes[ self::TABLE_KEY ][ $name ];
582
+        }
583
+
584
+        if ( isset( $this->defaults[ $name ] ) ) {
585
+            return $this->defaults[ $name ];
586
+        }
587
+
588
+        throw new PropertyDoesNotExistException( $name );
589
+    }
590
+
591
+    /**
592
+     * Retrieve the model's original attribute value.
593
+     *
594
+     * @param string $name
595
+     *
596
+     * @return mixed
597
+     *
598
+     * @throws PropertyDoesNotExistException If property isn't found.
599
+     */
600
+    public function get_original_attribute( $name ) {
601
+        $original_attributes = $this->original;
602
+
603
+        if ( ! is_object( $original_attributes[ static::OBJECT_KEY ] ) ) {
604
+            unset( $original_attributes[ static::OBJECT_KEY ] );
605
+        }
606
+
607
+        $original = new static( $original_attributes );
608
+
609
+        try {
610
+            return $original->get_attribute( $name );
611
+        } catch ( Exception $exception ) {
612
+            return null;
613
+        }
614
+    }
615
+
616
+    /**
617
+     * Fetches the Model's primary ID, depending on the model
618
+     * implementation.
619
+     *
620
+     * @return int
621
+     *
622
+     * @throws LogicException
623
+     */
624
+    public function get_primary_id() {
625
+        if ( $this instanceof UsesWordPressPost ) {
626
+            return $this->get_underlying_wp_object()->ID;
627
+        }
628
+
629
+        if ( $this instanceof UsesWordPressTerm ) {
630
+            return $this->get_underlying_wp_object()->term_id;
631
+        }
632
+
633
+        // Model w/o wp_object not yet supported.
634
+        throw new LogicException;
635
+    }
636
+
637
+    /**
638
+     * Checks whether the attribute has a map method.
639
+     *
640
+     * This is used to determine whether the attribute maps to a
641
+     * property on the underlying WP_Post object. Returns the
642
+     * method if one exists, returns false if it doesn't.
643
+     *
644
+     * @param string $name
645
+     *
646
+     * @return false|string
647
+     */
648
+    protected function has_map_method( $name ) {
649
+        if ( method_exists( $this, $method = "map_{$name}" ) ) {
650
+            return $method;
651
+        }
652
+
653
+        return false;
654
+    }
655
+
656
+    /**
657
+     * Checks whether the attribute has a compute method.
658
+     *
659
+     * This is used to determine if the attribute should be computed
660
+     * from other attributes.
661
+     *
662
+     * @param string $name
663
+     *
664
+     * @return false|string
665
+     */
666
+    protected function has_compute_method( $name ) {
667
+        if ( method_exists( $this, $method = "compute_{$name}" ) ) {
668
+            return $method;
669
+        }
670
+
671
+        return false;
672
+    }
673
+
674
+    /**
675
+     * Clears all the current attributes from the model.
676
+     *
677
+     * This does not touch the model's original attributes, and will
678
+     * only clear fillable attributes, unless the model is unguarded.
679
+     *
680
+     * @return $this
681
+     */
682
+    public function clear() {
683
+        $keys = array_merge(
684
+            $this->get_table_keys(),
685
+            $this->get_wp_object_keys()
686
+        );
687
+
688
+        foreach ( $keys as $key ) {
689
+            try {
690
+                $this->set_attribute( $key, null );
691
+            } catch ( GuardedPropertyException $e ) {
692
+                // We won't clear out guarded attributes.
693
+            }
694
+        }
695
+
696
+        return $this;
697
+    }
698
+
699
+    /**
700
+     * Unguards the model.
701
+     *
702
+     * Sets the model to be unguarded, allowing the filling of
703
+     * guarded attributes.
704
+     */
705
+    public function unguard() {
706
+        $this->is_guarded = false;
707
+    }
708
+
709
+    /**
710
+     * Reguards the model.
711
+     *
712
+     * Sets the model to be guarded, preventing filling of
713
+     * guarded attributes.
714
+     */
715
+    public function reguard() {
716
+        $this->is_guarded = true;
717
+    }
718
+
719
+    /**
720
+     * Retrieves all the compute methods on the model.
721
+     *
722
+     * @return array
723
+     */
724
+    protected function get_compute_methods() {
725
+        $methods = get_class_methods( get_called_class() );
726
+        $methods = array_filter( $methods, function ( $method ) {
727
+            return strrpos( $method, 'compute_', - strlen( $method ) ) !== false;
728
+        } );
729
+        $methods = array_map( function ( $method ) {
730
+            return substr( $method, strlen( 'compute_' ) );
731
+        }, $methods );
732
+
733
+        return $methods;
734
+    }
735
+
736
+    /**
737
+     * Sets up the memo array for the creating model.
738
+     */
739
+    private function maybe_boot() {
740
+        if ( ! isset( self::$memo[ get_called_class() ] ) ) {
741
+            self::$memo[ get_called_class() ] = array();
742
+        }
743
+    }
744
+
745
+    /**
746
+     * Whether this Model uses an underlying WordPress object.
747
+     *
748
+     * @return bool
749
+     */
750
+    protected function uses_wp_object() {
751
+        return $this instanceof UsesWordPressPost ||
752
+            $this instanceof UsesWordPressTerm;
753
+    }
754 754
 }
Please login to merge, or discard this patch.
Spacing   +121 added lines, -121 removed lines patch added patch discarded remove patch
@@ -114,16 +114,16 @@  discard block
 block discarded – undo
114 114
 	 *
115 115
 	 * @param array <string, mixed> $attributes
116 116
 	 */
117
-	public function __construct( array $attributes = array() ) {
117
+	public function __construct(array $attributes = array()) {
118 118
 		$this->maybe_boot();
119 119
 		$this->sync_original();
120 120
 
121
-		if ( $this->uses_wp_object() ) {
121
+		if ($this->uses_wp_object()) {
122 122
 			$this->create_wp_object();
123 123
 		}
124 124
 
125 125
 		$this->unguard();
126
-		$this->refresh( $attributes );
126
+		$this->refresh($attributes);
127 127
 		$this->reguard();
128 128
 	}
129 129
 
@@ -137,10 +137,10 @@  discard block
 block discarded – undo
137 137
 	 *
138 138
 	 * @return $this
139 139
 	 */
140
-	public function refresh( array $attributes ) {
140
+	public function refresh(array $attributes) {
141 141
 		$this->clear();
142 142
 
143
-		return $this->merge( $attributes );
143
+		return $this->merge($attributes);
144 144
 	}
145 145
 
146 146
 	/**
@@ -150,9 +150,9 @@  discard block
 block discarded – undo
150 150
 	 *
151 151
 	 * @return $this
152 152
 	 */
153
-	public function merge( array $attributes ) {
154
-		foreach ( $attributes as $name => $value ) {
155
-			$this->set_attribute( $name, $value );
153
+	public function merge(array $attributes) {
154
+		foreach ($attributes as $name => $value) {
155
+			$this->set_attribute($name, $value);
156 156
 		}
157 157
 
158 158
 		return $this;
@@ -167,7 +167,7 @@  discard block
 block discarded – undo
167 167
 	 * @return array
168 168
 	 */
169 169
 	public function get_table_attributes() {
170
-		return $this->attributes[ self::TABLE_KEY ];
170
+		return $this->attributes[self::TABLE_KEY];
171 171
 	}
172 172
 
173 173
 	/**
@@ -176,7 +176,7 @@  discard block
 block discarded – undo
176 176
 	 * @return array
177 177
 	 */
178 178
 	public function get_original_table_attributes() {
179
-		return $this->original[ self::TABLE_KEY ];
179
+		return $this->original[self::TABLE_KEY];
180 180
 	}
181 181
 
182 182
 	/**
@@ -189,11 +189,11 @@  discard block
 block discarded – undo
189 189
 	public function get_changed_table_attributes() {
190 190
 		$changed = array();
191 191
 
192
-		foreach ( $this->get_table_attributes() as $key => $value ) {
193
-			if ( $value !==
194
-				 $this->get_original_attribute( $key )
192
+		foreach ($this->get_table_attributes() as $key => $value) {
193
+			if ($value !==
194
+				 $this->get_original_attribute($key)
195 195
 			) {
196
-				$changed[ $key ] = $value;
196
+				$changed[$key] = $value;
197 197
 			}
198 198
 		}
199 199
 
@@ -209,8 +209,8 @@  discard block
 block discarded – undo
209 209
 	 * @return false|WP_Post|WP_Term
210 210
 	 */
211 211
 	public function get_underlying_wp_object() {
212
-		if ( isset( $this->attributes[ self::OBJECT_KEY ] ) ) {
213
-			return $this->attributes[ self::OBJECT_KEY ];
212
+		if (isset($this->attributes[self::OBJECT_KEY])) {
213
+			return $this->attributes[self::OBJECT_KEY];
214 214
 		}
215 215
 
216 216
 		return false;
@@ -222,7 +222,7 @@  discard block
 block discarded – undo
222 222
 	 * @return WP_Post
223 223
 	 */
224 224
 	public function get_original_underlying_wp_object() {
225
-		return $this->original[ self::OBJECT_KEY ];
225
+		return $this->original[self::OBJECT_KEY];
226 226
 	}
227 227
 
228 228
 	/**
@@ -235,11 +235,11 @@  discard block
 block discarded – undo
235 235
 	public function get_changed_wp_object_attributes() {
236 236
 		$changed = array();
237 237
 
238
-		foreach ( $this->get_wp_object_keys() as $key ) {
239
-			if ( $this->get_attribute( $key ) !==
240
-				 $this->get_original_attribute( $key )
238
+		foreach ($this->get_wp_object_keys() as $key) {
239
+			if ($this->get_attribute($key) !==
240
+				 $this->get_original_attribute($key)
241 241
 			) {
242
-				$changed[ $key ] = $this->get_attribute( $key );
242
+				$changed[$key] = $this->get_attribute($key);
243 243
 			}
244 244
 		}
245 245
 
@@ -254,8 +254,8 @@  discard block
 block discarded – undo
254 254
 	 * @param string $name
255 255
 	 * @param mixed  $value
256 256
 	 */
257
-	public function __set( $name, $value ) {
258
-		$this->set_attribute( $name, $value );
257
+	public function __set($name, $value) {
258
+		$this->set_attribute($name, $value);
259 259
 	}
260 260
 
261 261
 	/**
@@ -272,23 +272,23 @@  discard block
 block discarded – undo
272 272
 	 *
273 273
 	 * @throws GuardedPropertyException
274 274
 	 */
275
-	public function set_attribute( $name, $value ) {
276
-		if ( self::OBJECT_KEY === $name ) {
277
-			return $this->override_wp_object( $value );
275
+	public function set_attribute($name, $value) {
276
+		if (self::OBJECT_KEY === $name) {
277
+			return $this->override_wp_object($value);
278 278
 		}
279 279
 
280
-		if ( self::TABLE_KEY === $name ) {
281
-			return $this->override_table( $value );
280
+		if (self::TABLE_KEY === $name) {
281
+			return $this->override_table($value);
282 282
 		}
283 283
 
284
-		if ( ! $this->is_fillable( $name ) ) {
284
+		if (!$this->is_fillable($name)) {
285 285
 			throw new GuardedPropertyException;
286 286
 		}
287 287
 
288
-		if ( $method = $this->has_map_method( $name ) ) {
289
-			$this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()} = $value;
288
+		if ($method = $this->has_map_method($name)) {
289
+			$this->attributes[self::OBJECT_KEY]->{$this->{$method}()} = $value;
290 290
 		} else {
291
-			$this->attributes[ self::TABLE_KEY ][ $name ] = $value;
291
+			$this->attributes[self::TABLE_KEY][$name] = $value;
292 292
 		}
293 293
 
294 294
 		return $this;
@@ -300,11 +300,11 @@  discard block
 block discarded – undo
300 300
 	 * @return array
301 301
 	 */
302 302
 	public function get_attribute_keys() {
303
-		if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
304
-			return self::$memo[ get_called_class() ][ __METHOD__ ];
303
+		if (isset(self::$memo[get_called_class()][__METHOD__])) {
304
+			return self::$memo[get_called_class()][__METHOD__];
305 305
 		}
306 306
 
307
-		return self::$memo[ get_called_class() ][ __METHOD__ ]
307
+		return self::$memo[get_called_class()][__METHOD__]
308 308
 			= array_merge(
309 309
 				$this->fillable,
310 310
 				$this->guarded,
@@ -318,21 +318,21 @@  discard block
 block discarded – undo
318 318
 	 * @return array
319 319
 	 */
320 320
 	public function get_table_keys() {
321
-		if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
322
-			return self::$memo[ get_called_class() ][ __METHOD__ ];
321
+		if (isset(self::$memo[get_called_class()][__METHOD__])) {
322
+			return self::$memo[get_called_class()][__METHOD__];
323 323
 		}
324 324
 
325 325
 		$keys = array();
326 326
 
327
-		foreach ( $this->get_attribute_keys() as $key ) {
328
-			if ( ! $this->has_map_method( $key ) &&
329
-				 ! $this->has_compute_method( $key )
327
+		foreach ($this->get_attribute_keys() as $key) {
328
+			if (!$this->has_map_method($key) &&
329
+				 !$this->has_compute_method($key)
330 330
 			) {
331 331
 				$keys[] = $key;
332 332
 			}
333 333
 		}
334 334
 
335
-		return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
335
+		return self::$memo[get_called_class()][__METHOD__] = $keys;
336 336
 	}
337 337
 
338 338
 	/**
@@ -341,19 +341,19 @@  discard block
 block discarded – undo
341 341
 	 * @return array
342 342
 	 */
343 343
 	public function get_wp_object_keys() {
344
-		if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
345
-			return self::$memo[ get_called_class() ][ __METHOD__ ];
344
+		if (isset(self::$memo[get_called_class()][__METHOD__])) {
345
+			return self::$memo[get_called_class()][__METHOD__];
346 346
 		}
347 347
 
348 348
 		$keys = array();
349 349
 
350
-		foreach ( $this->get_attribute_keys() as $key ) {
351
-			if ( $this->has_map_method( $key ) ) {
350
+		foreach ($this->get_attribute_keys() as $key) {
351
+			if ($this->has_map_method($key)) {
352 352
 				$keys[] = $key;
353 353
 			}
354 354
 		}
355 355
 
356
-		return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
356
+		return self::$memo[get_called_class()][__METHOD__] = $keys;
357 357
 	}
358 358
 
359 359
 	/**
@@ -362,19 +362,19 @@  discard block
 block discarded – undo
362 362
 	 * @return array
363 363
 	 */
364 364
 	public function get_computed_keys() {
365
-		if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
366
-			return self::$memo[ get_called_class() ][ __METHOD__ ];
365
+		if (isset(self::$memo[get_called_class()][__METHOD__])) {
366
+			return self::$memo[get_called_class()][__METHOD__];
367 367
 		}
368 368
 
369 369
 		$keys = array();
370 370
 
371
-		foreach ( $this->get_attribute_keys() as $key ) {
372
-			if ( $this->has_compute_method( $key ) ) {
371
+		foreach ($this->get_attribute_keys() as $key) {
372
+			if ($this->has_compute_method($key)) {
373 373
 				$keys[] = $key;
374 374
 			}
375 375
 		}
376 376
 
377
-		return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
377
+		return self::$memo[get_called_class()][__METHOD__] = $keys;
378 378
 	}
379 379
 
380 380
 	/**
@@ -385,32 +385,32 @@  discard block
 block discarded – undo
385 385
 	public function serialize() {
386 386
 		$attributes = array();
387 387
 
388
-		if ( $this->visible ) {
388
+		if ($this->visible) {
389 389
 			// If visible attributes are set, we'll only reveal those.
390
-			foreach ( $this->visible as $key ) {
391
-				$attributes[ $key ] = $this->get_attribute( $key );
390
+			foreach ($this->visible as $key) {
391
+				$attributes[$key] = $this->get_attribute($key);
392 392
 			}
393
-		} elseif ( $this->hidden ) {
393
+		} elseif ($this->hidden) {
394 394
 			// If hidden attributes are set, we'll grab everything and hide those.
395
-			foreach ( $this->get_attribute_keys() as $key ) {
396
-				if ( ! in_array( $key, $this->hidden ) ) {
397
-					$attributes[ $key ] = $this->get_attribute( $key );
395
+			foreach ($this->get_attribute_keys() as $key) {
396
+				if (!in_array($key, $this->hidden)) {
397
+					$attributes[$key] = $this->get_attribute($key);
398 398
 				}
399 399
 			}
400 400
 		} else {
401 401
 			// If nothing is hidden/visible, we'll grab and reveal everything.
402
-			foreach ( $this->get_attribute_keys() as $key ) {
403
-				$attributes[ $key ] = $this->get_attribute( $key );
402
+			foreach ($this->get_attribute_keys() as $key) {
403
+				$attributes[$key] = $this->get_attribute($key);
404 404
 			}
405 405
 		}
406 406
 
407
-		return array_map( function ( $attribute ) {
408
-			if ( $attribute instanceof Serializes ) {
407
+		return array_map(function($attribute) {
408
+			if ($attribute instanceof Serializes) {
409 409
 				return $attribute->serialize();
410 410
 			}
411 411
 
412 412
 			return $attribute;
413
-		}, $attributes );
413
+		}, $attributes);
414 414
 	}
415 415
 
416 416
 	/**
@@ -421,13 +421,13 @@  discard block
 block discarded – undo
421 421
 	public function sync_original() {
422 422
 		$this->original = $this->attributes;
423 423
 
424
-		if ( $this->attributes[ self::OBJECT_KEY ] ) {
425
-			$this->original[ self::OBJECT_KEY ] = clone $this->attributes[ self::OBJECT_KEY ];
424
+		if ($this->attributes[self::OBJECT_KEY]) {
425
+			$this->original[self::OBJECT_KEY] = clone $this->attributes[self::OBJECT_KEY];
426 426
 		}
427 427
 
428
-		foreach ( $this->original[ self::TABLE_KEY ] as $key => $item ) {
429
-			if ( is_object( $item ) ) {
430
-				$this->original[ $key ] = clone $item;
428
+		foreach ($this->original[self::TABLE_KEY] as $key => $item) {
429
+			if (is_object($item)) {
430
+				$this->original[$key] = clone $item;
431 431
 			}
432 432
 		}
433 433
 
@@ -443,24 +443,24 @@  discard block
 block discarded – undo
443 443
 	 *
444 444
 	 * @return bool
445 445
 	 */
446
-	private function is_fillable( $name ) {
446
+	private function is_fillable($name) {
447 447
 		// If this model isn't guarded, everything is fillable.
448
-		if ( ! $this->is_guarded ) {
448
+		if (!$this->is_guarded) {
449 449
 			return true;
450 450
 		}
451 451
 
452 452
 		// If it's in the fillable array, then it's fillable.
453
-		if ( in_array( $name, $this->fillable ) ) {
453
+		if (in_array($name, $this->fillable)) {
454 454
 			return true;
455 455
 		}
456 456
 
457 457
 		// If it's explicitly guarded, then it's not fillable.
458
-		if ( in_array( $name, $this->guarded ) ) {
458
+		if (in_array($name, $this->guarded)) {
459 459
 			return false;
460 460
 		}
461 461
 
462 462
 		// If fillable hasn't been defined, then everything else fillable.
463
-		return ! $this->fillable;
463
+		return !$this->fillable;
464 464
 	}
465 465
 
466 466
 	/**
@@ -472,13 +472,13 @@  discard block
 block discarded – undo
472 472
 	 *
473 473
 	 * @return $this
474 474
 	 */
475
-	private function override_wp_object( $value ) {
476
-		if ( is_object( $value ) ) {
477
-			$this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $value );
475
+	private function override_wp_object($value) {
476
+		if (is_object($value)) {
477
+			$this->attributes[self::OBJECT_KEY] = $this->set_wp_object_constants($value);
478 478
 		} else {
479
-			$this->attributes[ self::OBJECT_KEY ] = null;
479
+			$this->attributes[self::OBJECT_KEY] = null;
480 480
 
481
-			if ( $this->uses_wp_object() ) {
481
+			if ($this->uses_wp_object()) {
482 482
 				$this->create_wp_object();
483 483
 			}
484 484
 		}
@@ -493,8 +493,8 @@  discard block
 block discarded – undo
493 493
 	 *
494 494
 	 * @return $this
495 495
 	 */
496
-	private function override_table( array $value ) {
497
-		$this->attributes[ self::TABLE_KEY ] = $value;
496
+	private function override_table(array $value) {
497
+		$this->attributes[self::TABLE_KEY] = $value;
498 498
 
499 499
 		return $this;
500 500
 	}
@@ -508,19 +508,19 @@  discard block
 block discarded – undo
508 508
 	 * @throws LogicException
509 509
 	 */
510 510
 	private function create_wp_object() {
511
-		switch ( true ) {
511
+		switch (true) {
512 512
 			case $this instanceof UsesWordPressPost:
513
-				$object = new WP_Post( (object) array() );
513
+				$object = new WP_Post((object) array());
514 514
 				break;
515 515
 			case $this instanceof UsesWordPressTerm:
516
-				$object = new WP_Term( (object) array() );
516
+				$object = new WP_Term((object) array());
517 517
 				break;
518 518
 			default:
519 519
 				throw new LogicException;
520 520
 				break;
521 521
 		}
522 522
 
523
-		$this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $object );
523
+		$this->attributes[self::OBJECT_KEY] = $this->set_wp_object_constants($object);
524 524
 	}
525 525
 
526 526
 	/**
@@ -534,12 +534,12 @@  discard block
 block discarded – undo
534 534
 	 *
535 535
 	 * @return object
536 536
 	 */
537
-	protected function set_wp_object_constants( $object ) {
538
-		if ( $this instanceof UsesWordPressPost ) {
537
+	protected function set_wp_object_constants($object) {
538
+		if ($this instanceof UsesWordPressPost) {
539 539
 			$object->post_type = static::get_post_type();
540 540
 		}
541 541
 
542
-		if ( $this instanceof UsesWordPressTerm ) {
542
+		if ($this instanceof UsesWordPressTerm) {
543 543
 			$object->taxonomy = static::get_taxonomy();
544 544
 		}
545 545
 
@@ -555,8 +555,8 @@  discard block
 block discarded – undo
555 555
 	 *
556 556
 	 * @return mixed
557 557
 	 */
558
-	public function __get( $name ) {
559
-		return $this->get_attribute( $name );
558
+	public function __get($name) {
559
+		return $this->get_attribute($name);
560 560
 	}
561 561
 
562 562
 	/**
@@ -568,24 +568,24 @@  discard block
 block discarded – undo
568 568
 	 *
569 569
 	 * @throws PropertyDoesNotExistException If property isn't found.
570 570
 	 */
571
-	public function get_attribute( $name ) {
572
-		if ( $method = $this->has_map_method( $name ) ) {
573
-			return $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()};
571
+	public function get_attribute($name) {
572
+		if ($method = $this->has_map_method($name)) {
573
+			return $this->attributes[self::OBJECT_KEY]->{$this->{$method}()};
574 574
 		}
575 575
 
576
-		if ( $method = $this->has_compute_method( $name ) ) {
576
+		if ($method = $this->has_compute_method($name)) {
577 577
 			return $this->{$method}();
578 578
 		}
579 579
 
580
-		if ( isset( $this->attributes[ self::TABLE_KEY ][ $name ] ) ) {
581
-			return $this->attributes[ self::TABLE_KEY ][ $name ];
580
+		if (isset($this->attributes[self::TABLE_KEY][$name])) {
581
+			return $this->attributes[self::TABLE_KEY][$name];
582 582
 		}
583 583
 
584
-		if ( isset( $this->defaults[ $name ] ) ) {
585
-			return $this->defaults[ $name ];
584
+		if (isset($this->defaults[$name])) {
585
+			return $this->defaults[$name];
586 586
 		}
587 587
 
588
-		throw new PropertyDoesNotExistException( $name );
588
+		throw new PropertyDoesNotExistException($name);
589 589
 	}
590 590
 
591 591
 	/**
@@ -597,18 +597,18 @@  discard block
 block discarded – undo
597 597
 	 *
598 598
 	 * @throws PropertyDoesNotExistException If property isn't found.
599 599
 	 */
600
-	public function get_original_attribute( $name ) {
600
+	public function get_original_attribute($name) {
601 601
 		$original_attributes = $this->original;
602 602
 
603
-		if ( ! is_object( $original_attributes[ static::OBJECT_KEY ] ) ) {
604
-			unset( $original_attributes[ static::OBJECT_KEY ] );
603
+		if (!is_object($original_attributes[static::OBJECT_KEY])) {
604
+			unset($original_attributes[static::OBJECT_KEY]);
605 605
 		}
606 606
 
607
-		$original = new static( $original_attributes );
607
+		$original = new static($original_attributes);
608 608
 
609 609
 		try {
610
-			return $original->get_attribute( $name );
611
-		} catch ( Exception $exception ) {
610
+			return $original->get_attribute($name);
611
+		} catch (Exception $exception) {
612 612
 			return null;
613 613
 		}
614 614
 	}
@@ -622,11 +622,11 @@  discard block
 block discarded – undo
622 622
 	 * @throws LogicException
623 623
 	 */
624 624
 	public function get_primary_id() {
625
-		if ( $this instanceof UsesWordPressPost ) {
625
+		if ($this instanceof UsesWordPressPost) {
626 626
 			return $this->get_underlying_wp_object()->ID;
627 627
 		}
628 628
 
629
-		if ( $this instanceof UsesWordPressTerm ) {
629
+		if ($this instanceof UsesWordPressTerm) {
630 630
 			return $this->get_underlying_wp_object()->term_id;
631 631
 		}
632 632
 
@@ -645,8 +645,8 @@  discard block
 block discarded – undo
645 645
 	 *
646 646
 	 * @return false|string
647 647
 	 */
648
-	protected function has_map_method( $name ) {
649
-		if ( method_exists( $this, $method = "map_{$name}" ) ) {
648
+	protected function has_map_method($name) {
649
+		if (method_exists($this, $method = "map_{$name}")) {
650 650
 			return $method;
651 651
 		}
652 652
 
@@ -663,8 +663,8 @@  discard block
 block discarded – undo
663 663
 	 *
664 664
 	 * @return false|string
665 665
 	 */
666
-	protected function has_compute_method( $name ) {
667
-		if ( method_exists( $this, $method = "compute_{$name}" ) ) {
666
+	protected function has_compute_method($name) {
667
+		if (method_exists($this, $method = "compute_{$name}")) {
668 668
 			return $method;
669 669
 		}
670 670
 
@@ -685,10 +685,10 @@  discard block
 block discarded – undo
685 685
 			$this->get_wp_object_keys()
686 686
 		);
687 687
 
688
-		foreach ( $keys as $key ) {
688
+		foreach ($keys as $key) {
689 689
 			try {
690
-				$this->set_attribute( $key, null );
691
-			} catch ( GuardedPropertyException $e ) {
690
+				$this->set_attribute($key, null);
691
+			} catch (GuardedPropertyException $e) {
692 692
 				// We won't clear out guarded attributes.
693 693
 			}
694 694
 		}
@@ -722,13 +722,13 @@  discard block
 block discarded – undo
722 722
 	 * @return array
723 723
 	 */
724 724
 	protected function get_compute_methods() {
725
-		$methods = get_class_methods( get_called_class() );
726
-		$methods = array_filter( $methods, function ( $method ) {
727
-			return strrpos( $method, 'compute_', - strlen( $method ) ) !== false;
725
+		$methods = get_class_methods(get_called_class());
726
+		$methods = array_filter($methods, function($method) {
727
+			return strrpos($method, 'compute_', - strlen($method)) !== false;
728 728
 		} );
729
-		$methods = array_map( function ( $method ) {
730
-			return substr( $method, strlen( 'compute_' ) );
731
-		}, $methods );
729
+		$methods = array_map(function($method) {
730
+			return substr($method, strlen('compute_'));
731
+		}, $methods);
732 732
 
733 733
 		return $methods;
734 734
 	}
@@ -737,8 +737,8 @@  discard block
 block discarded – undo
737 737
 	 * Sets up the memo array for the creating model.
738 738
 	 */
739 739
 	private function maybe_boot() {
740
-		if ( ! isset( self::$memo[ get_called_class() ] ) ) {
741
-			self::$memo[ get_called_class() ] = array();
740
+		if (!isset(self::$memo[get_called_class()])) {
741
+			self::$memo[get_called_class()] = array();
742 742
 		}
743 743
 	}
744 744
 
Please login to merge, or discard this patch.