@@ -11,40 +11,40 @@ |
||
11 | 11 | * @subpackage Assets |
12 | 12 | */ |
13 | 13 | class ServiceProvider implements ServiceProviderContract { |
14 | - /** |
|
15 | - * Container to register with. |
|
16 | - * |
|
17 | - * @var Container |
|
18 | - */ |
|
19 | - protected $container; |
|
14 | + /** |
|
15 | + * Container to register with. |
|
16 | + * |
|
17 | + * @var Container |
|
18 | + */ |
|
19 | + protected $container; |
|
20 | 20 | |
21 | - /** |
|
22 | - * {@inheritDoc} |
|
23 | - * |
|
24 | - * @param Container $container |
|
25 | - */ |
|
26 | - public function register( Container $container ) { |
|
27 | - $this->container = $container; |
|
21 | + /** |
|
22 | + * {@inheritDoc} |
|
23 | + * |
|
24 | + * @param Container $container |
|
25 | + */ |
|
26 | + public function register( Container $container ) { |
|
27 | + $this->container = $container; |
|
28 | 28 | |
29 | - $container->define( |
|
30 | - array( 'assets' => 'Intraxia\Jaxion\Contract\Assets\Register' ), |
|
31 | - $register = new Register( $container->fetch( 'url' ), $container->fetch( 'version' ) ) |
|
32 | - ); |
|
29 | + $container->define( |
|
30 | + array( 'assets' => 'Intraxia\Jaxion\Contract\Assets\Register' ), |
|
31 | + $register = new Register( $container->fetch( 'url' ), $container->fetch( 'version' ) ) |
|
32 | + ); |
|
33 | 33 | |
34 | - $this->add_assets( $register ); |
|
35 | - } |
|
34 | + $this->add_assets( $register ); |
|
35 | + } |
|
36 | 36 | |
37 | - /** |
|
38 | - * Registers the assets on the generated Register. |
|
39 | - * |
|
40 | - * This is a no-op by default by can be overwritten by the implementing developer |
|
41 | - * to provide a single, clean location to register their assets. |
|
42 | - * |
|
43 | - * @param Register $register |
|
44 | - * |
|
45 | - * @codeCoverageIgnore |
|
46 | - */ |
|
47 | - protected function add_assets( Register $register ) { |
|
48 | - // no-op |
|
49 | - } |
|
37 | + /** |
|
38 | + * Registers the assets on the generated Register. |
|
39 | + * |
|
40 | + * This is a no-op by default by can be overwritten by the implementing developer |
|
41 | + * to provide a single, clean location to register their assets. |
|
42 | + * |
|
43 | + * @param Register $register |
|
44 | + * |
|
45 | + * @codeCoverageIgnore |
|
46 | + */ |
|
47 | + protected function add_assets( Register $register ) { |
|
48 | + // no-op |
|
49 | + } |
|
50 | 50 | } |
@@ -15,109 +15,109 @@ |
||
15 | 15 | * @subpackage Core |
16 | 16 | */ |
17 | 17 | class Loader implements LoaderContract { |
18 | - /** |
|
19 | - * Array of action hooks to attach. |
|
20 | - * |
|
21 | - * @var array[] |
|
22 | - */ |
|
23 | - protected $actions = array(); |
|
18 | + /** |
|
19 | + * Array of action hooks to attach. |
|
20 | + * |
|
21 | + * @var array[] |
|
22 | + */ |
|
23 | + protected $actions = array(); |
|
24 | 24 | |
25 | - /** |
|
26 | - * Array of filter hooks to attach. |
|
27 | - * |
|
28 | - * @var array[] |
|
29 | - */ |
|
30 | - protected $filters = array(); |
|
25 | + /** |
|
26 | + * Array of filter hooks to attach. |
|
27 | + * |
|
28 | + * @var array[] |
|
29 | + */ |
|
30 | + protected $filters = array(); |
|
31 | 31 | |
32 | - /** |
|
33 | - * {@inheritDoc} |
|
34 | - */ |
|
35 | - public function run() { |
|
36 | - foreach ( $this->actions as $action ) { |
|
37 | - add_action( |
|
38 | - $action['hook'], |
|
39 | - array( $action['service'], $action['method'] ), |
|
40 | - $action['priority'], |
|
41 | - $action['args'] |
|
42 | - ); |
|
43 | - } |
|
32 | + /** |
|
33 | + * {@inheritDoc} |
|
34 | + */ |
|
35 | + public function run() { |
|
36 | + foreach ( $this->actions as $action ) { |
|
37 | + add_action( |
|
38 | + $action['hook'], |
|
39 | + array( $action['service'], $action['method'] ), |
|
40 | + $action['priority'], |
|
41 | + $action['args'] |
|
42 | + ); |
|
43 | + } |
|
44 | 44 | |
45 | - foreach ( $this->filters as $filter ) { |
|
46 | - add_filter( |
|
47 | - $filter['hook'], |
|
48 | - array( $filter['service'], $filter['method'] ), |
|
49 | - $filter['priority'], |
|
50 | - $filter['args'] |
|
51 | - ); |
|
52 | - } |
|
53 | - } |
|
45 | + foreach ( $this->filters as $filter ) { |
|
46 | + add_filter( |
|
47 | + $filter['hook'], |
|
48 | + array( $filter['service'], $filter['method'] ), |
|
49 | + $filter['priority'], |
|
50 | + $filter['args'] |
|
51 | + ); |
|
52 | + } |
|
53 | + } |
|
54 | 54 | |
55 | - /** |
|
56 | - * {@inheritDoc} |
|
57 | - * |
|
58 | - * @param HasActions $service |
|
59 | - */ |
|
60 | - public function register_actions( HasActions $service ) { |
|
61 | - foreach ( $service->action_hooks() as $action ) { |
|
62 | - $this->actions = $this->add( |
|
63 | - $this->actions, |
|
64 | - $action['hook'], |
|
65 | - $service, |
|
66 | - $action['method'], |
|
67 | - isset( $action['priority'] ) ? $action['priority'] : 10, |
|
68 | - isset( $action['args'] ) ? $action['args'] : 1 |
|
69 | - ); |
|
70 | - } |
|
71 | - } |
|
55 | + /** |
|
56 | + * {@inheritDoc} |
|
57 | + * |
|
58 | + * @param HasActions $service |
|
59 | + */ |
|
60 | + public function register_actions( HasActions $service ) { |
|
61 | + foreach ( $service->action_hooks() as $action ) { |
|
62 | + $this->actions = $this->add( |
|
63 | + $this->actions, |
|
64 | + $action['hook'], |
|
65 | + $service, |
|
66 | + $action['method'], |
|
67 | + isset( $action['priority'] ) ? $action['priority'] : 10, |
|
68 | + isset( $action['args'] ) ? $action['args'] : 1 |
|
69 | + ); |
|
70 | + } |
|
71 | + } |
|
72 | 72 | |
73 | - /** |
|
74 | - * {@inheritDoc} |
|
75 | - * |
|
76 | - * @param HasFilters $service |
|
77 | - */ |
|
78 | - public function register_filters( HasFilters $service ) { |
|
79 | - foreach ( $service->filter_hooks() as $filter ) { |
|
80 | - $this->filters = $this->add( |
|
81 | - $this->filters, |
|
82 | - $filter['hook'], |
|
83 | - $service, |
|
84 | - $filter['method'], |
|
85 | - isset( $filter['priority'] ) ? $filter['priority'] : 10, |
|
86 | - isset( $filter['args'] ) ? $filter['args'] : 1 |
|
87 | - ); |
|
88 | - } |
|
89 | - } |
|
73 | + /** |
|
74 | + * {@inheritDoc} |
|
75 | + * |
|
76 | + * @param HasFilters $service |
|
77 | + */ |
|
78 | + public function register_filters( HasFilters $service ) { |
|
79 | + foreach ( $service->filter_hooks() as $filter ) { |
|
80 | + $this->filters = $this->add( |
|
81 | + $this->filters, |
|
82 | + $filter['hook'], |
|
83 | + $service, |
|
84 | + $filter['method'], |
|
85 | + isset( $filter['priority'] ) ? $filter['priority'] : 10, |
|
86 | + isset( $filter['args'] ) ? $filter['args'] : 1 |
|
87 | + ); |
|
88 | + } |
|
89 | + } |
|
90 | 90 | |
91 | - /** |
|
92 | - * {@inheritDoc} |
|
93 | - * |
|
94 | - * @param HasShortcode $service |
|
95 | - */ |
|
96 | - public function register_shortcode( HasShortcode $service ) { |
|
97 | - add_shortcode( $service->shortcode_name(), array( $service, 'do_shortcode' ) ); |
|
98 | - } |
|
91 | + /** |
|
92 | + * {@inheritDoc} |
|
93 | + * |
|
94 | + * @param HasShortcode $service |
|
95 | + */ |
|
96 | + public function register_shortcode( HasShortcode $service ) { |
|
97 | + add_shortcode( $service->shortcode_name(), array( $service, 'do_shortcode' ) ); |
|
98 | + } |
|
99 | 99 | |
100 | - /** |
|
101 | - * Utility to register the actions and hooks into a single collection. |
|
102 | - * |
|
103 | - * @param array $hooks |
|
104 | - * @param string $hook |
|
105 | - * @param object $service |
|
106 | - * @param string $method |
|
107 | - * @param int $priority |
|
108 | - * @param int $accepted_args |
|
109 | - * |
|
110 | - * @return array |
|
111 | - */ |
|
112 | - protected function add( $hooks, $hook, $service, $method, $priority, $accepted_args ) { |
|
113 | - $hooks[] = array( |
|
114 | - 'hook' => $hook, |
|
115 | - 'service' => $service, |
|
116 | - 'method' => $method, |
|
117 | - 'priority' => $priority, |
|
118 | - 'args' => $accepted_args, |
|
119 | - ); |
|
100 | + /** |
|
101 | + * Utility to register the actions and hooks into a single collection. |
|
102 | + * |
|
103 | + * @param array $hooks |
|
104 | + * @param string $hook |
|
105 | + * @param object $service |
|
106 | + * @param string $method |
|
107 | + * @param int $priority |
|
108 | + * @param int $accepted_args |
|
109 | + * |
|
110 | + * @return array |
|
111 | + */ |
|
112 | + protected function add( $hooks, $hook, $service, $method, $priority, $accepted_args ) { |
|
113 | + $hooks[] = array( |
|
114 | + 'hook' => $hook, |
|
115 | + 'service' => $service, |
|
116 | + 'method' => $method, |
|
117 | + 'priority' => $priority, |
|
118 | + 'args' => $accepted_args, |
|
119 | + ); |
|
120 | 120 | |
121 | - return $hooks; |
|
122 | - } |
|
121 | + return $hooks; |
|
122 | + } |
|
123 | 123 | } |
@@ -13,322 +13,322 @@ |
||
13 | 13 | * @subpackage Core |
14 | 14 | */ |
15 | 15 | class Container implements ContainerContract { |
16 | - /** |
|
17 | - * ServiceProvider names to register with the container. |
|
18 | - * |
|
19 | - * Can be overwritten to include predefined providers. |
|
20 | - * |
|
21 | - * @var string[] |
|
22 | - */ |
|
23 | - protected $providers = array(); |
|
24 | - |
|
25 | - /** |
|
26 | - * Registered definitions. |
|
27 | - * |
|
28 | - * @var mixed[] |
|
29 | - */ |
|
30 | - private $definitions = array(); |
|
31 | - |
|
32 | - /** |
|
33 | - * Aliases to share between fetches. |
|
34 | - * |
|
35 | - * @var <string, true>[] |
|
36 | - */ |
|
37 | - private $shared = array(); |
|
38 | - |
|
39 | - /** |
|
40 | - * Aliases of all the registered services. |
|
41 | - * |
|
42 | - * @var <string, true>[] |
|
43 | - */ |
|
44 | - private $aliases = array(); |
|
45 | - |
|
46 | - /** |
|
47 | - * Array of classes registered on the container. |
|
48 | - * |
|
49 | - * @var <string, true>[] |
|
50 | - */ |
|
51 | - private $classes = array(); |
|
52 | - |
|
53 | - /** |
|
54 | - * Current position in the loop. |
|
55 | - * |
|
56 | - * @var int |
|
57 | - */ |
|
58 | - private $position; |
|
59 | - |
|
60 | - /** |
|
61 | - * 0-indexed array of aliases for looping. |
|
62 | - * |
|
63 | - * @var string[] |
|
64 | - */ |
|
65 | - private $keys = array(); |
|
66 | - |
|
67 | - /** |
|
68 | - * Create a new container with the given providers. |
|
69 | - * |
|
70 | - * Providers can be instances or the class of the provider as a string. |
|
71 | - * |
|
72 | - * @param ServiceProvider[]|string[] $providers |
|
73 | - */ |
|
74 | - public function __construct( array $providers = array() ) { |
|
75 | - // array_unique ensures we only register each provider once. |
|
76 | - $providers = array_unique( array_merge( $this->providers, $providers ) ); |
|
77 | - |
|
78 | - foreach ( $providers as $provider ) { |
|
79 | - if ( is_string( $provider ) && class_exists( $provider ) ) { |
|
80 | - $provider = new $provider; |
|
81 | - } |
|
82 | - |
|
83 | - if ( $provider instanceof ServiceProvider ) { |
|
84 | - $this->register( $provider ); |
|
85 | - } |
|
86 | - } |
|
87 | - } |
|
88 | - |
|
89 | - |
|
90 | - /** |
|
91 | - * {@inheritdoc} |
|
92 | - * |
|
93 | - * @param string|array $alias |
|
94 | - * @param mixed $definition |
|
95 | - * |
|
96 | - * @throws DefinedAliasException |
|
97 | - * |
|
98 | - * @return $this |
|
99 | - */ |
|
100 | - public function define( $alias, $definition ) { |
|
101 | - if ( is_array( $alias ) ) { |
|
102 | - $class = current( $alias ); |
|
103 | - $alias = key( $alias ); |
|
104 | - } |
|
105 | - |
|
106 | - if ( isset( $this->aliases[ $alias ] ) ) { |
|
107 | - throw new DefinedAliasException( $alias ); |
|
108 | - } |
|
109 | - |
|
110 | - $this->aliases[ $alias ] = true; |
|
111 | - $this->definitions[ $alias ] = $definition; |
|
112 | - |
|
113 | - // Closures are treated as factories unless |
|
114 | - // defined via Container::share. |
|
115 | - if ( ! $definition instanceof \Closure ) { |
|
116 | - $this->shared[ $alias ] = true; |
|
117 | - } |
|
118 | - |
|
119 | - if ( isset( $class ) ) { |
|
120 | - $this->classes[ $class ] = $alias; |
|
121 | - } |
|
122 | - |
|
123 | - return $this; |
|
124 | - } |
|
125 | - |
|
126 | - /** |
|
127 | - * {@inheritdoc} |
|
128 | - * |
|
129 | - * @param string|array $alias |
|
130 | - * @param mixed $definition |
|
131 | - * |
|
132 | - * @throws DefinedAliasException |
|
133 | - * |
|
134 | - * @return $this |
|
135 | - */ |
|
136 | - public function share( $alias, $definition ) { |
|
137 | - $this->define( $alias, $definition ); |
|
138 | - |
|
139 | - if ( is_array( $alias ) ) { |
|
140 | - $alias = key( $alias ); |
|
141 | - } |
|
142 | - |
|
143 | - $this->shared[ $alias ] = true; |
|
144 | - |
|
145 | - return $this; |
|
146 | - } |
|
147 | - |
|
148 | - /** |
|
149 | - * {@inheritdoc} |
|
150 | - * |
|
151 | - * @param string $alias |
|
152 | - * |
|
153 | - * @throws UndefinedAliasException |
|
154 | - * |
|
155 | - * @return mixed |
|
156 | - */ |
|
157 | - public function fetch( $alias ) { |
|
158 | - if ( isset( $this->classes[ $alias ] ) ) { |
|
159 | - // If the alias is a class name, |
|
160 | - // then retrieve its linked alias. |
|
161 | - // This is only registered when |
|
162 | - // registering using an array. |
|
163 | - $alias = $this->classes[ $alias ]; |
|
164 | - } |
|
165 | - |
|
166 | - if ( ! isset( $this->aliases[ $alias ] ) ) { |
|
167 | - throw new UndefinedAliasException( $alias ); |
|
168 | - } |
|
169 | - |
|
170 | - $value = $this->definitions[ $alias ]; |
|
171 | - |
|
172 | - // If the shared value is a closure, |
|
173 | - // execute it and assign the result |
|
174 | - // in place of the closure. |
|
175 | - if ( $value instanceof \Closure ) { |
|
176 | - $factory = $value; |
|
177 | - $value = $factory( $this ); |
|
178 | - } |
|
179 | - |
|
180 | - // If the value is shared, save the shared value. |
|
181 | - if ( isset( $this->shared[ $alias ] ) ) { |
|
182 | - $this->definitions[ $alias ] = $value; |
|
183 | - } |
|
184 | - |
|
185 | - // Return the fetched value. |
|
186 | - return $value; |
|
187 | - } |
|
188 | - |
|
189 | - /** |
|
190 | - * {@inheritdoc} |
|
191 | - * |
|
192 | - * @param string $alias |
|
193 | - * |
|
194 | - * @return bool |
|
195 | - */ |
|
196 | - public function has( $alias ) { |
|
197 | - return isset( $this->aliases[ $alias ] ); |
|
198 | - } |
|
199 | - |
|
200 | - /** |
|
201 | - * {@inheritDoc} |
|
202 | - * |
|
203 | - * @param string $alias |
|
204 | - * |
|
205 | - * @return $this |
|
206 | - */ |
|
207 | - public function remove( $alias ) { |
|
208 | - if ( isset( $this->aliases[ $alias ] ) ) { |
|
209 | - /** |
|
210 | - * If there's no reference in the aliases array, |
|
211 | - * the service won't be found on fetching and |
|
212 | - * can be overwritten on setting. |
|
213 | - * |
|
214 | - * Pros: Quick setting/unsetting, faster |
|
215 | - * performance on those operations when doing |
|
216 | - * a lot of these. |
|
217 | - * |
|
218 | - * Cons: Objects and values set in the container |
|
219 | - * can't get garbage collected. |
|
220 | - * |
|
221 | - * If this is a problem, this may need to be revisited. |
|
222 | - */ |
|
223 | - unset( $this->aliases[ $alias ] ); |
|
224 | - } |
|
225 | - |
|
226 | - return $this; |
|
227 | - } |
|
228 | - |
|
229 | - /** |
|
230 | - * {@inheritDoc} |
|
231 | - * |
|
232 | - * @param ServiceProvider $provider |
|
233 | - * |
|
234 | - * @return $this |
|
235 | - */ |
|
236 | - public function register( ServiceProvider $provider ) { |
|
237 | - // @todo make sure provider is only registered once |
|
238 | - $provider->register( $this ); |
|
239 | - |
|
240 | - return $this; |
|
241 | - } |
|
242 | - |
|
243 | - /** |
|
244 | - * Set a value into the container. |
|
245 | - * |
|
246 | - * @param string $id |
|
247 | - * @param mixed $value |
|
248 | - * |
|
249 | - * @see define |
|
250 | - */ |
|
251 | - public function offsetSet( $id, $value ) { |
|
252 | - $this->define( $id, $value ); |
|
253 | - } |
|
254 | - |
|
255 | - /** |
|
256 | - * Get an value from the container. |
|
257 | - * |
|
258 | - * @param string $id |
|
259 | - * |
|
260 | - * @return object |
|
261 | - * @throws UndefinedAliasException |
|
262 | - * |
|
263 | - * @see fetch |
|
264 | - */ |
|
265 | - public function offsetGet( $id ) { |
|
266 | - return $this->fetch( $id ); |
|
267 | - } |
|
268 | - |
|
269 | - /** |
|
270 | - * Checks if a key is set on the container. |
|
271 | - * |
|
272 | - * @param string $id |
|
273 | - * |
|
274 | - * @return bool |
|
275 | - * |
|
276 | - * @see has |
|
277 | - */ |
|
278 | - public function offsetExists( $id ) { |
|
279 | - return $this->has( $id ); |
|
280 | - } |
|
281 | - |
|
282 | - /** |
|
283 | - * Remove a key from the container. |
|
284 | - * |
|
285 | - * @param string $id |
|
286 | - * |
|
287 | - * @see remove |
|
288 | - */ |
|
289 | - public function offsetUnset( $id ) { |
|
290 | - $this->remove( $id ); |
|
291 | - } |
|
292 | - |
|
293 | - /** |
|
294 | - * Sets the object properties to prepare for the loop. |
|
295 | - */ |
|
296 | - public function rewind() { |
|
297 | - $this->position = 0; |
|
298 | - $this->keys = array_keys( $this->aliases ); |
|
299 | - } |
|
300 | - |
|
301 | - /** |
|
302 | - * Retrieves the service object for the current step in the loop. |
|
303 | - * |
|
304 | - * @return object |
|
305 | - */ |
|
306 | - public function current() { |
|
307 | - return $this->fetch( $this->keys[ $this->position ] ); |
|
308 | - } |
|
309 | - |
|
310 | - /** |
|
311 | - * Retrieves the key for the current step in the loop. |
|
312 | - * |
|
313 | - * @return string |
|
314 | - */ |
|
315 | - public function key() { |
|
316 | - return $this->keys[ $this->position ]; |
|
317 | - } |
|
318 | - |
|
319 | - /** |
|
320 | - * Increments to the next step in the loop. |
|
321 | - */ |
|
322 | - public function next() { |
|
323 | - $this->position ++; |
|
324 | - } |
|
325 | - |
|
326 | - /** |
|
327 | - * Checks if the next step in the loop in valid. |
|
328 | - * |
|
329 | - * @return bool |
|
330 | - */ |
|
331 | - public function valid() { |
|
332 | - return isset( $this->keys[ $this->position ] ); |
|
333 | - } |
|
16 | + /** |
|
17 | + * ServiceProvider names to register with the container. |
|
18 | + * |
|
19 | + * Can be overwritten to include predefined providers. |
|
20 | + * |
|
21 | + * @var string[] |
|
22 | + */ |
|
23 | + protected $providers = array(); |
|
24 | + |
|
25 | + /** |
|
26 | + * Registered definitions. |
|
27 | + * |
|
28 | + * @var mixed[] |
|
29 | + */ |
|
30 | + private $definitions = array(); |
|
31 | + |
|
32 | + /** |
|
33 | + * Aliases to share between fetches. |
|
34 | + * |
|
35 | + * @var <string, true>[] |
|
36 | + */ |
|
37 | + private $shared = array(); |
|
38 | + |
|
39 | + /** |
|
40 | + * Aliases of all the registered services. |
|
41 | + * |
|
42 | + * @var <string, true>[] |
|
43 | + */ |
|
44 | + private $aliases = array(); |
|
45 | + |
|
46 | + /** |
|
47 | + * Array of classes registered on the container. |
|
48 | + * |
|
49 | + * @var <string, true>[] |
|
50 | + */ |
|
51 | + private $classes = array(); |
|
52 | + |
|
53 | + /** |
|
54 | + * Current position in the loop. |
|
55 | + * |
|
56 | + * @var int |
|
57 | + */ |
|
58 | + private $position; |
|
59 | + |
|
60 | + /** |
|
61 | + * 0-indexed array of aliases for looping. |
|
62 | + * |
|
63 | + * @var string[] |
|
64 | + */ |
|
65 | + private $keys = array(); |
|
66 | + |
|
67 | + /** |
|
68 | + * Create a new container with the given providers. |
|
69 | + * |
|
70 | + * Providers can be instances or the class of the provider as a string. |
|
71 | + * |
|
72 | + * @param ServiceProvider[]|string[] $providers |
|
73 | + */ |
|
74 | + public function __construct( array $providers = array() ) { |
|
75 | + // array_unique ensures we only register each provider once. |
|
76 | + $providers = array_unique( array_merge( $this->providers, $providers ) ); |
|
77 | + |
|
78 | + foreach ( $providers as $provider ) { |
|
79 | + if ( is_string( $provider ) && class_exists( $provider ) ) { |
|
80 | + $provider = new $provider; |
|
81 | + } |
|
82 | + |
|
83 | + if ( $provider instanceof ServiceProvider ) { |
|
84 | + $this->register( $provider ); |
|
85 | + } |
|
86 | + } |
|
87 | + } |
|
88 | + |
|
89 | + |
|
90 | + /** |
|
91 | + * {@inheritdoc} |
|
92 | + * |
|
93 | + * @param string|array $alias |
|
94 | + * @param mixed $definition |
|
95 | + * |
|
96 | + * @throws DefinedAliasException |
|
97 | + * |
|
98 | + * @return $this |
|
99 | + */ |
|
100 | + public function define( $alias, $definition ) { |
|
101 | + if ( is_array( $alias ) ) { |
|
102 | + $class = current( $alias ); |
|
103 | + $alias = key( $alias ); |
|
104 | + } |
|
105 | + |
|
106 | + if ( isset( $this->aliases[ $alias ] ) ) { |
|
107 | + throw new DefinedAliasException( $alias ); |
|
108 | + } |
|
109 | + |
|
110 | + $this->aliases[ $alias ] = true; |
|
111 | + $this->definitions[ $alias ] = $definition; |
|
112 | + |
|
113 | + // Closures are treated as factories unless |
|
114 | + // defined via Container::share. |
|
115 | + if ( ! $definition instanceof \Closure ) { |
|
116 | + $this->shared[ $alias ] = true; |
|
117 | + } |
|
118 | + |
|
119 | + if ( isset( $class ) ) { |
|
120 | + $this->classes[ $class ] = $alias; |
|
121 | + } |
|
122 | + |
|
123 | + return $this; |
|
124 | + } |
|
125 | + |
|
126 | + /** |
|
127 | + * {@inheritdoc} |
|
128 | + * |
|
129 | + * @param string|array $alias |
|
130 | + * @param mixed $definition |
|
131 | + * |
|
132 | + * @throws DefinedAliasException |
|
133 | + * |
|
134 | + * @return $this |
|
135 | + */ |
|
136 | + public function share( $alias, $definition ) { |
|
137 | + $this->define( $alias, $definition ); |
|
138 | + |
|
139 | + if ( is_array( $alias ) ) { |
|
140 | + $alias = key( $alias ); |
|
141 | + } |
|
142 | + |
|
143 | + $this->shared[ $alias ] = true; |
|
144 | + |
|
145 | + return $this; |
|
146 | + } |
|
147 | + |
|
148 | + /** |
|
149 | + * {@inheritdoc} |
|
150 | + * |
|
151 | + * @param string $alias |
|
152 | + * |
|
153 | + * @throws UndefinedAliasException |
|
154 | + * |
|
155 | + * @return mixed |
|
156 | + */ |
|
157 | + public function fetch( $alias ) { |
|
158 | + if ( isset( $this->classes[ $alias ] ) ) { |
|
159 | + // If the alias is a class name, |
|
160 | + // then retrieve its linked alias. |
|
161 | + // This is only registered when |
|
162 | + // registering using an array. |
|
163 | + $alias = $this->classes[ $alias ]; |
|
164 | + } |
|
165 | + |
|
166 | + if ( ! isset( $this->aliases[ $alias ] ) ) { |
|
167 | + throw new UndefinedAliasException( $alias ); |
|
168 | + } |
|
169 | + |
|
170 | + $value = $this->definitions[ $alias ]; |
|
171 | + |
|
172 | + // If the shared value is a closure, |
|
173 | + // execute it and assign the result |
|
174 | + // in place of the closure. |
|
175 | + if ( $value instanceof \Closure ) { |
|
176 | + $factory = $value; |
|
177 | + $value = $factory( $this ); |
|
178 | + } |
|
179 | + |
|
180 | + // If the value is shared, save the shared value. |
|
181 | + if ( isset( $this->shared[ $alias ] ) ) { |
|
182 | + $this->definitions[ $alias ] = $value; |
|
183 | + } |
|
184 | + |
|
185 | + // Return the fetched value. |
|
186 | + return $value; |
|
187 | + } |
|
188 | + |
|
189 | + /** |
|
190 | + * {@inheritdoc} |
|
191 | + * |
|
192 | + * @param string $alias |
|
193 | + * |
|
194 | + * @return bool |
|
195 | + */ |
|
196 | + public function has( $alias ) { |
|
197 | + return isset( $this->aliases[ $alias ] ); |
|
198 | + } |
|
199 | + |
|
200 | + /** |
|
201 | + * {@inheritDoc} |
|
202 | + * |
|
203 | + * @param string $alias |
|
204 | + * |
|
205 | + * @return $this |
|
206 | + */ |
|
207 | + public function remove( $alias ) { |
|
208 | + if ( isset( $this->aliases[ $alias ] ) ) { |
|
209 | + /** |
|
210 | + * If there's no reference in the aliases array, |
|
211 | + * the service won't be found on fetching and |
|
212 | + * can be overwritten on setting. |
|
213 | + * |
|
214 | + * Pros: Quick setting/unsetting, faster |
|
215 | + * performance on those operations when doing |
|
216 | + * a lot of these. |
|
217 | + * |
|
218 | + * Cons: Objects and values set in the container |
|
219 | + * can't get garbage collected. |
|
220 | + * |
|
221 | + * If this is a problem, this may need to be revisited. |
|
222 | + */ |
|
223 | + unset( $this->aliases[ $alias ] ); |
|
224 | + } |
|
225 | + |
|
226 | + return $this; |
|
227 | + } |
|
228 | + |
|
229 | + /** |
|
230 | + * {@inheritDoc} |
|
231 | + * |
|
232 | + * @param ServiceProvider $provider |
|
233 | + * |
|
234 | + * @return $this |
|
235 | + */ |
|
236 | + public function register( ServiceProvider $provider ) { |
|
237 | + // @todo make sure provider is only registered once |
|
238 | + $provider->register( $this ); |
|
239 | + |
|
240 | + return $this; |
|
241 | + } |
|
242 | + |
|
243 | + /** |
|
244 | + * Set a value into the container. |
|
245 | + * |
|
246 | + * @param string $id |
|
247 | + * @param mixed $value |
|
248 | + * |
|
249 | + * @see define |
|
250 | + */ |
|
251 | + public function offsetSet( $id, $value ) { |
|
252 | + $this->define( $id, $value ); |
|
253 | + } |
|
254 | + |
|
255 | + /** |
|
256 | + * Get an value from the container. |
|
257 | + * |
|
258 | + * @param string $id |
|
259 | + * |
|
260 | + * @return object |
|
261 | + * @throws UndefinedAliasException |
|
262 | + * |
|
263 | + * @see fetch |
|
264 | + */ |
|
265 | + public function offsetGet( $id ) { |
|
266 | + return $this->fetch( $id ); |
|
267 | + } |
|
268 | + |
|
269 | + /** |
|
270 | + * Checks if a key is set on the container. |
|
271 | + * |
|
272 | + * @param string $id |
|
273 | + * |
|
274 | + * @return bool |
|
275 | + * |
|
276 | + * @see has |
|
277 | + */ |
|
278 | + public function offsetExists( $id ) { |
|
279 | + return $this->has( $id ); |
|
280 | + } |
|
281 | + |
|
282 | + /** |
|
283 | + * Remove a key from the container. |
|
284 | + * |
|
285 | + * @param string $id |
|
286 | + * |
|
287 | + * @see remove |
|
288 | + */ |
|
289 | + public function offsetUnset( $id ) { |
|
290 | + $this->remove( $id ); |
|
291 | + } |
|
292 | + |
|
293 | + /** |
|
294 | + * Sets the object properties to prepare for the loop. |
|
295 | + */ |
|
296 | + public function rewind() { |
|
297 | + $this->position = 0; |
|
298 | + $this->keys = array_keys( $this->aliases ); |
|
299 | + } |
|
300 | + |
|
301 | + /** |
|
302 | + * Retrieves the service object for the current step in the loop. |
|
303 | + * |
|
304 | + * @return object |
|
305 | + */ |
|
306 | + public function current() { |
|
307 | + return $this->fetch( $this->keys[ $this->position ] ); |
|
308 | + } |
|
309 | + |
|
310 | + /** |
|
311 | + * Retrieves the key for the current step in the loop. |
|
312 | + * |
|
313 | + * @return string |
|
314 | + */ |
|
315 | + public function key() { |
|
316 | + return $this->keys[ $this->position ]; |
|
317 | + } |
|
318 | + |
|
319 | + /** |
|
320 | + * Increments to the next step in the loop. |
|
321 | + */ |
|
322 | + public function next() { |
|
323 | + $this->position ++; |
|
324 | + } |
|
325 | + |
|
326 | + /** |
|
327 | + * Checks if the next step in the loop in valid. |
|
328 | + * |
|
329 | + * @return bool |
|
330 | + */ |
|
331 | + public function valid() { |
|
332 | + return isset( $this->keys[ $this->position ] ); |
|
333 | + } |
|
334 | 334 | } |
@@ -13,146 +13,146 @@ |
||
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 $instance = null; |
|
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 string $file |
|
35 | - * @param array $providers |
|
36 | - * |
|
37 | - * @throws ApplicationAlreadyBootedException |
|
38 | - */ |
|
39 | - public function __construct( $file, array $providers = array() ) { |
|
40 | - if ( null !== static::$instance ) { |
|
41 | - throw new ApplicationAlreadyBootedException; |
|
42 | - } |
|
43 | - |
|
44 | - static::$instance = $this; |
|
45 | - |
|
46 | - $this->register_constants( $file ); |
|
47 | - $this->register_core_services(); |
|
48 | - $this->load_i18n(); |
|
49 | - |
|
50 | - register_activation_hook( $file, array( $this, 'activate' ) ); |
|
51 | - register_deactivation_hook( $file, array( $this, 'deactivate' ) ); |
|
52 | - |
|
53 | - parent::__construct( $providers ); |
|
54 | - } |
|
55 | - |
|
56 | - /** |
|
57 | - * {@inheritDoc} |
|
58 | - * |
|
59 | - * @throws UnexpectedValueException |
|
60 | - */ |
|
61 | - public function boot() { |
|
62 | - $loader = $this->fetch( 'loader' ); |
|
63 | - |
|
64 | - if ( ! $loader instanceof LoaderContract ) { |
|
65 | - throw new UnexpectedValueException; |
|
66 | - } |
|
67 | - |
|
68 | - foreach ( $this as $alias => $value ) { |
|
69 | - if ( $value instanceof HasActions ) { |
|
70 | - $loader->register_actions( $value ); |
|
71 | - } |
|
72 | - |
|
73 | - if ( $value instanceof HasFilters ) { |
|
74 | - $loader->register_filters( $value ); |
|
75 | - } |
|
76 | - |
|
77 | - if ( $value instanceof HasShortcode ) { |
|
78 | - $loader->register_shortcode( $value ); |
|
79 | - } |
|
80 | - } |
|
81 | - |
|
82 | - add_action( 'plugins_loaded', array( $loader, 'run' ) ); |
|
83 | - } |
|
84 | - |
|
85 | - /** |
|
86 | - * {@inheritdoc} |
|
87 | - * |
|
88 | - * @codeCoverageIgnore |
|
89 | - */ |
|
90 | - public function activate() { |
|
91 | - // no-op |
|
92 | - } |
|
93 | - |
|
94 | - /** |
|
95 | - * {@inheritdoc} |
|
96 | - * |
|
97 | - * @codeCoverageIgnore |
|
98 | - */ |
|
99 | - public function deactivate() { |
|
100 | - // no-op |
|
101 | - } |
|
102 | - |
|
103 | - /** |
|
104 | - * {@inheritDoc} |
|
105 | - * |
|
106 | - * @return Application |
|
107 | - * @throws ApplicationNotBootedException |
|
108 | - */ |
|
109 | - public static function instance() { |
|
110 | - if ( null === static::$instance ) { |
|
111 | - throw new ApplicationNotBootedException; |
|
112 | - } |
|
113 | - |
|
114 | - return static::$instance; |
|
115 | - } |
|
116 | - |
|
117 | - /** |
|
118 | - * {@inheritDoc} |
|
119 | - */ |
|
120 | - public static function shutdown() { |
|
121 | - if ( null !== static::$instance ) { |
|
122 | - static::$instance = null; |
|
123 | - } |
|
124 | - } |
|
125 | - |
|
126 | - /** |
|
127 | - * Sets the plugin's url, path, and basename. |
|
128 | - * |
|
129 | - * @param string $file |
|
130 | - */ |
|
131 | - private function register_constants( $file ) { |
|
132 | - $this->share( 'url', plugin_dir_url( $file ) ); |
|
133 | - $this->share( 'path', plugin_dir_path( $file ) ); |
|
134 | - $this->share( 'basename', $basename = plugin_basename( $file ) ); |
|
135 | - $this->share( 'slug', dirname( $basename ) ); |
|
136 | - $this->share( 'version', static::VERSION ); |
|
137 | - } |
|
138 | - |
|
139 | - /** |
|
140 | - * Registers the built-in services with the Application container. |
|
141 | - */ |
|
142 | - private function register_core_services() { |
|
143 | - $this->share( array( 'loader' => 'Intraxia\Jaxion\Contract\Core\Loader' ), function ( $app ) { |
|
144 | - return new Loader( $app ); |
|
145 | - } ); |
|
146 | - } |
|
147 | - |
|
148 | - /** |
|
149 | - * Load's the plugin's translation files. |
|
150 | - */ |
|
151 | - private function load_i18n() { |
|
152 | - load_plugin_textdomain( |
|
153 | - $this->fetch( 'basename' ), |
|
154 | - false, |
|
155 | - basename( $this->fetch( 'path' ) ) . '/languages/' |
|
156 | - ); |
|
157 | - } |
|
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 $instance = null; |
|
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 string $file |
|
35 | + * @param array $providers |
|
36 | + * |
|
37 | + * @throws ApplicationAlreadyBootedException |
|
38 | + */ |
|
39 | + public function __construct( $file, array $providers = array() ) { |
|
40 | + if ( null !== static::$instance ) { |
|
41 | + throw new ApplicationAlreadyBootedException; |
|
42 | + } |
|
43 | + |
|
44 | + static::$instance = $this; |
|
45 | + |
|
46 | + $this->register_constants( $file ); |
|
47 | + $this->register_core_services(); |
|
48 | + $this->load_i18n(); |
|
49 | + |
|
50 | + register_activation_hook( $file, array( $this, 'activate' ) ); |
|
51 | + register_deactivation_hook( $file, array( $this, 'deactivate' ) ); |
|
52 | + |
|
53 | + parent::__construct( $providers ); |
|
54 | + } |
|
55 | + |
|
56 | + /** |
|
57 | + * {@inheritDoc} |
|
58 | + * |
|
59 | + * @throws UnexpectedValueException |
|
60 | + */ |
|
61 | + public function boot() { |
|
62 | + $loader = $this->fetch( 'loader' ); |
|
63 | + |
|
64 | + if ( ! $loader instanceof LoaderContract ) { |
|
65 | + throw new UnexpectedValueException; |
|
66 | + } |
|
67 | + |
|
68 | + foreach ( $this as $alias => $value ) { |
|
69 | + if ( $value instanceof HasActions ) { |
|
70 | + $loader->register_actions( $value ); |
|
71 | + } |
|
72 | + |
|
73 | + if ( $value instanceof HasFilters ) { |
|
74 | + $loader->register_filters( $value ); |
|
75 | + } |
|
76 | + |
|
77 | + if ( $value instanceof HasShortcode ) { |
|
78 | + $loader->register_shortcode( $value ); |
|
79 | + } |
|
80 | + } |
|
81 | + |
|
82 | + add_action( 'plugins_loaded', array( $loader, 'run' ) ); |
|
83 | + } |
|
84 | + |
|
85 | + /** |
|
86 | + * {@inheritdoc} |
|
87 | + * |
|
88 | + * @codeCoverageIgnore |
|
89 | + */ |
|
90 | + public function activate() { |
|
91 | + // no-op |
|
92 | + } |
|
93 | + |
|
94 | + /** |
|
95 | + * {@inheritdoc} |
|
96 | + * |
|
97 | + * @codeCoverageIgnore |
|
98 | + */ |
|
99 | + public function deactivate() { |
|
100 | + // no-op |
|
101 | + } |
|
102 | + |
|
103 | + /** |
|
104 | + * {@inheritDoc} |
|
105 | + * |
|
106 | + * @return Application |
|
107 | + * @throws ApplicationNotBootedException |
|
108 | + */ |
|
109 | + public static function instance() { |
|
110 | + if ( null === static::$instance ) { |
|
111 | + throw new ApplicationNotBootedException; |
|
112 | + } |
|
113 | + |
|
114 | + return static::$instance; |
|
115 | + } |
|
116 | + |
|
117 | + /** |
|
118 | + * {@inheritDoc} |
|
119 | + */ |
|
120 | + public static function shutdown() { |
|
121 | + if ( null !== static::$instance ) { |
|
122 | + static::$instance = null; |
|
123 | + } |
|
124 | + } |
|
125 | + |
|
126 | + /** |
|
127 | + * Sets the plugin's url, path, and basename. |
|
128 | + * |
|
129 | + * @param string $file |
|
130 | + */ |
|
131 | + private function register_constants( $file ) { |
|
132 | + $this->share( 'url', plugin_dir_url( $file ) ); |
|
133 | + $this->share( 'path', plugin_dir_path( $file ) ); |
|
134 | + $this->share( 'basename', $basename = plugin_basename( $file ) ); |
|
135 | + $this->share( 'slug', dirname( $basename ) ); |
|
136 | + $this->share( 'version', static::VERSION ); |
|
137 | + } |
|
138 | + |
|
139 | + /** |
|
140 | + * Registers the built-in services with the Application container. |
|
141 | + */ |
|
142 | + private function register_core_services() { |
|
143 | + $this->share( array( 'loader' => 'Intraxia\Jaxion\Contract\Core\Loader' ), function ( $app ) { |
|
144 | + return new Loader( $app ); |
|
145 | + } ); |
|
146 | + } |
|
147 | + |
|
148 | + /** |
|
149 | + * Load's the plugin's translation files. |
|
150 | + */ |
|
151 | + private function load_i18n() { |
|
152 | + load_plugin_textdomain( |
|
153 | + $this->fetch( 'basename' ), |
|
154 | + false, |
|
155 | + basename( $this->fetch( 'path' ) ) . '/languages/' |
|
156 | + ); |
|
157 | + } |
|
158 | 158 | } |
@@ -14,152 +14,152 @@ |
||
14 | 14 | * @subpackage Axolotl |
15 | 15 | */ |
16 | 16 | class Collection implements Countable, Iterator, Serializes { |
17 | - /** |
|
18 | - * Collection elements. |
|
19 | - * |
|
20 | - * @var array |
|
21 | - */ |
|
22 | - protected $elements = array(); |
|
23 | - |
|
24 | - /** |
|
25 | - * Models registered to the collection. |
|
26 | - * |
|
27 | - * @var string |
|
28 | - */ |
|
29 | - protected $model; |
|
30 | - |
|
31 | - /** |
|
32 | - * Where Collection is in loop. |
|
33 | - * |
|
34 | - * @var int |
|
35 | - */ |
|
36 | - protected $position = 0; |
|
37 | - |
|
38 | - /** |
|
39 | - * Collection constructor. |
|
40 | - * |
|
41 | - * @param array $elements |
|
42 | - * @param array $config |
|
43 | - */ |
|
44 | - public function __construct( array $elements = array(), array $config = array() ) { |
|
45 | - $this->parse_config( $config ); |
|
46 | - |
|
47 | - foreach ( $elements as $element ) { |
|
48 | - $this->add( $element ); |
|
49 | - } |
|
50 | - } |
|
51 | - |
|
52 | - /** |
|
53 | - * Adds a new element to the Collection. |
|
54 | - * |
|
55 | - * @param mixed $element |
|
56 | - * |
|
57 | - * @throws RuntimeException |
|
58 | - */ |
|
59 | - public function add( $element ) { |
|
60 | - if ( $this->model && is_array( $element ) ) { |
|
61 | - $element = new $this->model( $element ); |
|
62 | - } |
|
63 | - |
|
64 | - if ( $this->model && ! ( $element instanceof $this->model ) ) { |
|
65 | - throw new RuntimeException; |
|
66 | - } |
|
67 | - |
|
68 | - $this->elements[] = $element; |
|
69 | - } |
|
70 | - |
|
71 | - /** |
|
72 | - * Fetches the element at the provided index. |
|
73 | - * |
|
74 | - * @param int $index |
|
75 | - * |
|
76 | - * @return mixed |
|
77 | - */ |
|
78 | - public function at( $index ) { |
|
79 | - return $this->elements[ $index ]; |
|
80 | - } |
|
81 | - |
|
82 | - /** |
|
83 | - * Return the current element. |
|
84 | - * |
|
85 | - * @return mixed |
|
86 | - */ |
|
87 | - public function current() { |
|
88 | - return $this->at( $this->position ); |
|
89 | - } |
|
90 | - |
|
91 | - /** |
|
92 | - * Move forward to next element. |
|
93 | - */ |
|
94 | - public function next() { |
|
95 | - $this->position ++; |
|
96 | - } |
|
97 | - |
|
98 | - /** |
|
99 | - * Return the key of the current element. |
|
100 | - * |
|
101 | - * @return mixed |
|
102 | - */ |
|
103 | - public function key() { |
|
104 | - return $this->position; |
|
105 | - } |
|
106 | - |
|
107 | - /** |
|
108 | - * Checks if current position is valid. |
|
109 | - * |
|
110 | - * @return bool |
|
111 | - */ |
|
112 | - public function valid() { |
|
113 | - return isset( $this->elements[ $this->position ] ); |
|
114 | - } |
|
115 | - |
|
116 | - /** |
|
117 | - * Rewind the Iterator to the first element. |
|
118 | - */ |
|
119 | - public function rewind() { |
|
120 | - $this->position = 0; |
|
121 | - } |
|
122 | - |
|
123 | - /** |
|
124 | - * Count elements of an object. |
|
125 | - * |
|
126 | - * @return int |
|
127 | - */ |
|
128 | - public function count() { |
|
129 | - return count( $this->elements ); |
|
130 | - } |
|
131 | - |
|
132 | - /** |
|
133 | - * Parses the Collection config to set its properties. |
|
134 | - * |
|
135 | - * @param array $config |
|
136 | - * |
|
137 | - * @throws LogicException |
|
138 | - */ |
|
139 | - protected function parse_config( array $config ) { |
|
140 | - if ( isset( $config['model'] ) ) { |
|
141 | - $model = $config['model']; |
|
142 | - |
|
143 | - if ( ! is_subclass_of( $model, 'Intraxia\Jaxion\Axolotl\Model' ) ) { |
|
144 | - throw new LogicException; |
|
145 | - } |
|
146 | - |
|
147 | - $this->model = $model; |
|
148 | - } |
|
149 | - } |
|
150 | - |
|
151 | - /** |
|
152 | - * {@inheritDoc} |
|
153 | - * |
|
154 | - * @return array |
|
155 | - */ |
|
156 | - public function serialize() { |
|
157 | - return array_map(function( $element ) { |
|
158 | - if ( $element instanceof Serializes ) { |
|
159 | - return $element->serialize(); |
|
160 | - } |
|
161 | - |
|
162 | - return $element; |
|
163 | - }, $this->elements); |
|
164 | - } |
|
17 | + /** |
|
18 | + * Collection elements. |
|
19 | + * |
|
20 | + * @var array |
|
21 | + */ |
|
22 | + protected $elements = array(); |
|
23 | + |
|
24 | + /** |
|
25 | + * Models registered to the collection. |
|
26 | + * |
|
27 | + * @var string |
|
28 | + */ |
|
29 | + protected $model; |
|
30 | + |
|
31 | + /** |
|
32 | + * Where Collection is in loop. |
|
33 | + * |
|
34 | + * @var int |
|
35 | + */ |
|
36 | + protected $position = 0; |
|
37 | + |
|
38 | + /** |
|
39 | + * Collection constructor. |
|
40 | + * |
|
41 | + * @param array $elements |
|
42 | + * @param array $config |
|
43 | + */ |
|
44 | + public function __construct( array $elements = array(), array $config = array() ) { |
|
45 | + $this->parse_config( $config ); |
|
46 | + |
|
47 | + foreach ( $elements as $element ) { |
|
48 | + $this->add( $element ); |
|
49 | + } |
|
50 | + } |
|
51 | + |
|
52 | + /** |
|
53 | + * Adds a new element to the Collection. |
|
54 | + * |
|
55 | + * @param mixed $element |
|
56 | + * |
|
57 | + * @throws RuntimeException |
|
58 | + */ |
|
59 | + public function add( $element ) { |
|
60 | + if ( $this->model && is_array( $element ) ) { |
|
61 | + $element = new $this->model( $element ); |
|
62 | + } |
|
63 | + |
|
64 | + if ( $this->model && ! ( $element instanceof $this->model ) ) { |
|
65 | + throw new RuntimeException; |
|
66 | + } |
|
67 | + |
|
68 | + $this->elements[] = $element; |
|
69 | + } |
|
70 | + |
|
71 | + /** |
|
72 | + * Fetches the element at the provided index. |
|
73 | + * |
|
74 | + * @param int $index |
|
75 | + * |
|
76 | + * @return mixed |
|
77 | + */ |
|
78 | + public function at( $index ) { |
|
79 | + return $this->elements[ $index ]; |
|
80 | + } |
|
81 | + |
|
82 | + /** |
|
83 | + * Return the current element. |
|
84 | + * |
|
85 | + * @return mixed |
|
86 | + */ |
|
87 | + public function current() { |
|
88 | + return $this->at( $this->position ); |
|
89 | + } |
|
90 | + |
|
91 | + /** |
|
92 | + * Move forward to next element. |
|
93 | + */ |
|
94 | + public function next() { |
|
95 | + $this->position ++; |
|
96 | + } |
|
97 | + |
|
98 | + /** |
|
99 | + * Return the key of the current element. |
|
100 | + * |
|
101 | + * @return mixed |
|
102 | + */ |
|
103 | + public function key() { |
|
104 | + return $this->position; |
|
105 | + } |
|
106 | + |
|
107 | + /** |
|
108 | + * Checks if current position is valid. |
|
109 | + * |
|
110 | + * @return bool |
|
111 | + */ |
|
112 | + public function valid() { |
|
113 | + return isset( $this->elements[ $this->position ] ); |
|
114 | + } |
|
115 | + |
|
116 | + /** |
|
117 | + * Rewind the Iterator to the first element. |
|
118 | + */ |
|
119 | + public function rewind() { |
|
120 | + $this->position = 0; |
|
121 | + } |
|
122 | + |
|
123 | + /** |
|
124 | + * Count elements of an object. |
|
125 | + * |
|
126 | + * @return int |
|
127 | + */ |
|
128 | + public function count() { |
|
129 | + return count( $this->elements ); |
|
130 | + } |
|
131 | + |
|
132 | + /** |
|
133 | + * Parses the Collection config to set its properties. |
|
134 | + * |
|
135 | + * @param array $config |
|
136 | + * |
|
137 | + * @throws LogicException |
|
138 | + */ |
|
139 | + protected function parse_config( array $config ) { |
|
140 | + if ( isset( $config['model'] ) ) { |
|
141 | + $model = $config['model']; |
|
142 | + |
|
143 | + if ( ! is_subclass_of( $model, 'Intraxia\Jaxion\Axolotl\Model' ) ) { |
|
144 | + throw new LogicException; |
|
145 | + } |
|
146 | + |
|
147 | + $this->model = $model; |
|
148 | + } |
|
149 | + } |
|
150 | + |
|
151 | + /** |
|
152 | + * {@inheritDoc} |
|
153 | + * |
|
154 | + * @return array |
|
155 | + */ |
|
156 | + public function serialize() { |
|
157 | + return array_map(function( $element ) { |
|
158 | + if ( $element instanceof Serializes ) { |
|
159 | + return $element->serialize(); |
|
160 | + } |
|
161 | + |
|
162 | + return $element; |
|
163 | + }, $this->elements); |
|
164 | + } |
|
165 | 165 | } |
@@ -11,39 +11,39 @@ |
||
11 | 11 | * @subpackage Utility |
12 | 12 | */ |
13 | 13 | class Str { |
14 | - /** |
|
15 | - * Determine if a given string starts with a given substring. |
|
16 | - * |
|
17 | - * @param string $haystack |
|
18 | - * @param string|array $needles |
|
19 | - * |
|
20 | - * @return bool |
|
21 | - */ |
|
22 | - public static function starts_with( $haystack, $needles ) { |
|
23 | - foreach ( (array) $needles as $needle ) { |
|
24 | - if ( '' !== $needle && 0 === strpos( $haystack, $needle ) ) { |
|
25 | - return true; |
|
26 | - } |
|
27 | - } |
|
14 | + /** |
|
15 | + * Determine if a given string starts with a given substring. |
|
16 | + * |
|
17 | + * @param string $haystack |
|
18 | + * @param string|array $needles |
|
19 | + * |
|
20 | + * @return bool |
|
21 | + */ |
|
22 | + public static function starts_with( $haystack, $needles ) { |
|
23 | + foreach ( (array) $needles as $needle ) { |
|
24 | + if ( '' !== $needle && 0 === strpos( $haystack, $needle ) ) { |
|
25 | + return true; |
|
26 | + } |
|
27 | + } |
|
28 | 28 | |
29 | - return false; |
|
30 | - } |
|
29 | + return false; |
|
30 | + } |
|
31 | 31 | |
32 | - /** |
|
33 | - * Determine if a given string ends with a given substring. |
|
34 | - * |
|
35 | - * @param string $haystack |
|
36 | - * @param string|array $needles |
|
37 | - * |
|
38 | - * @return bool |
|
39 | - */ |
|
40 | - public static function ends_with( $haystack, $needles ) { |
|
41 | - foreach ( (array) $needles as $needle ) { |
|
42 | - if ( substr( $haystack, - strlen( $needle ) ) === (string) $needle ) { |
|
43 | - return true; |
|
44 | - } |
|
45 | - } |
|
32 | + /** |
|
33 | + * Determine if a given string ends with a given substring. |
|
34 | + * |
|
35 | + * @param string $haystack |
|
36 | + * @param string|array $needles |
|
37 | + * |
|
38 | + * @return bool |
|
39 | + */ |
|
40 | + public static function ends_with( $haystack, $needles ) { |
|
41 | + foreach ( (array) $needles as $needle ) { |
|
42 | + if ( substr( $haystack, - strlen( $needle ) ) === (string) $needle ) { |
|
43 | + return true; |
|
44 | + } |
|
45 | + } |
|
46 | 46 | |
47 | - return false; |
|
48 | - } |
|
47 | + return false; |
|
48 | + } |
|
49 | 49 | } |
@@ -6,54 +6,54 @@ |
||
6 | 6 | use WP_Error; |
7 | 7 | |
8 | 8 | interface EntityManager { |
9 | - /** |
|
10 | - * Get a single model of the provided class with the given ID. |
|
11 | - * |
|
12 | - * @param string $class Fully qualified class name of model. |
|
13 | - * @param int $id ID of the model. |
|
14 | - * |
|
15 | - * @return Model|WP_Error |
|
16 | - */ |
|
17 | - public function find( $class, $id ); |
|
9 | + /** |
|
10 | + * Get a single model of the provided class with the given ID. |
|
11 | + * |
|
12 | + * @param string $class Fully qualified class name of model. |
|
13 | + * @param int $id ID of the model. |
|
14 | + * |
|
15 | + * @return Model|WP_Error |
|
16 | + */ |
|
17 | + public function find( $class, $id ); |
|
18 | 18 | |
19 | - /** |
|
20 | - * Finds all the models of the provided class for the given params. |
|
21 | - * |
|
22 | - * This method will return an empty Collection if the query returns no models. |
|
23 | - * |
|
24 | - * @param string $class Fully qualified class name of models to find. |
|
25 | - * @param array $params Params to constrain the find. |
|
26 | - * |
|
27 | - * @return Collection|WP_Error |
|
28 | - */ |
|
29 | - public function find_by( $class, $params = array() ); |
|
19 | + /** |
|
20 | + * Finds all the models of the provided class for the given params. |
|
21 | + * |
|
22 | + * This method will return an empty Collection if the query returns no models. |
|
23 | + * |
|
24 | + * @param string $class Fully qualified class name of models to find. |
|
25 | + * @param array $params Params to constrain the find. |
|
26 | + * |
|
27 | + * @return Collection|WP_Error |
|
28 | + */ |
|
29 | + public function find_by( $class, $params = array() ); |
|
30 | 30 | |
31 | - /** |
|
32 | - * Saves a new model of the provided class with the given data. |
|
33 | - * |
|
34 | - * @param string $class |
|
35 | - * @param array $data |
|
36 | - * |
|
37 | - * @return Model|WP_Error |
|
38 | - */ |
|
39 | - public function create( $class, $data = array() ); |
|
31 | + /** |
|
32 | + * Saves a new model of the provided class with the given data. |
|
33 | + * |
|
34 | + * @param string $class |
|
35 | + * @param array $data |
|
36 | + * |
|
37 | + * @return Model|WP_Error |
|
38 | + */ |
|
39 | + public function create( $class, $data = array() ); |
|
40 | 40 | |
41 | - /** |
|
42 | - * Updates a model with its latest dataE. |
|
43 | - * |
|
44 | - * @param Model $model |
|
45 | - * |
|
46 | - * @return Model|WP_Error |
|
47 | - */ |
|
48 | - public function persist( Model $model ); |
|
41 | + /** |
|
42 | + * Updates a model with its latest dataE. |
|
43 | + * |
|
44 | + * @param Model $model |
|
45 | + * |
|
46 | + * @return Model|WP_Error |
|
47 | + */ |
|
48 | + public function persist( Model $model ); |
|
49 | 49 | |
50 | - /** |
|
51 | - * Delete the provide |
|
52 | - * |
|
53 | - * @param Model $model |
|
54 | - * @param bool $force |
|
55 | - * |
|
56 | - * @return mixed |
|
57 | - */ |
|
58 | - public function delete( Model $model, $force = false ); |
|
50 | + /** |
|
51 | + * Delete the provide |
|
52 | + * |
|
53 | + * @param Model $model |
|
54 | + * @param bool $force |
|
55 | + * |
|
56 | + * @return mixed |
|
57 | + */ |
|
58 | + public function delete( Model $model, $force = false ); |
|
59 | 59 | } |
@@ -20,667 +20,667 @@ |
||
20 | 20 | * @since 0.1.0 |
21 | 21 | */ |
22 | 22 | abstract class Model implements Serializes { |
23 | - /** |
|
24 | - * Memoized values for class methods. |
|
25 | - * |
|
26 | - * @var array |
|
27 | - */ |
|
28 | - private static $memo = array(); |
|
29 | - |
|
30 | - /** |
|
31 | - * Model attributes. |
|
32 | - * |
|
33 | - * @var array |
|
34 | - */ |
|
35 | - private $attributes = array( |
|
36 | - 'table' => array(), |
|
37 | - 'object' => null, |
|
38 | - ); |
|
39 | - |
|
40 | - /** |
|
41 | - * Model's original attributes. |
|
42 | - * |
|
43 | - * @var array |
|
44 | - */ |
|
45 | - private $original = array( |
|
46 | - 'table' => array(), |
|
47 | - 'object' => null, |
|
48 | - ); |
|
49 | - |
|
50 | - /** |
|
51 | - * Properties which are allowed to be set on the model. |
|
52 | - * |
|
53 | - * If this array is empty, any attributes can be set on the model. |
|
54 | - * |
|
55 | - * @var string[] |
|
56 | - */ |
|
57 | - protected $fillable = array(); |
|
58 | - |
|
59 | - /** |
|
60 | - * Properties which cannot be automatically filled on the model. |
|
61 | - * |
|
62 | - * If the model is unguarded, these properties can be filled. |
|
63 | - * |
|
64 | - * @var array |
|
65 | - */ |
|
66 | - protected $guarded = array(); |
|
67 | - |
|
68 | - /** |
|
69 | - * Properties which should not be serialized. |
|
70 | - * |
|
71 | - * @var array |
|
72 | - */ |
|
73 | - protected $hidden = array(); |
|
74 | - |
|
75 | - /** |
|
76 | - * Properties which should be serialized. |
|
77 | - * |
|
78 | - * @var array |
|
79 | - */ |
|
80 | - protected $visible = array(); |
|
81 | - |
|
82 | - /** |
|
83 | - * Whether the model's properties are guarded. |
|
84 | - * |
|
85 | - * When false, allows guarded properties to be filled. |
|
86 | - * |
|
87 | - * @var bool |
|
88 | - */ |
|
89 | - protected $is_guarded = true; |
|
90 | - |
|
91 | - /** |
|
92 | - * Constructs a new model with provided attributes. |
|
93 | - * |
|
94 | - * If 'object' is passed as one of the attributes, the underlying post |
|
95 | - * will be overwritten. |
|
96 | - * |
|
97 | - * @param array <string, mixed> $attributes |
|
98 | - */ |
|
99 | - public function __construct( array $attributes = array() ) { |
|
100 | - $this->maybe_boot(); |
|
101 | - $this->sync_original(); |
|
102 | - |
|
103 | - if ( $this->uses_wp_object() ) { |
|
104 | - $this->create_wp_object(); |
|
105 | - } |
|
106 | - |
|
107 | - $this->refresh( $attributes ); |
|
108 | - } |
|
109 | - |
|
110 | - /** |
|
111 | - * Refreshes the model's current attributes with the provided array. |
|
112 | - * |
|
113 | - * The model's attributes will match what was provided in the array, |
|
114 | - * and any attributes not passed |
|
115 | - * |
|
116 | - * @param array $attributes |
|
117 | - * |
|
118 | - * @return $this |
|
119 | - */ |
|
120 | - public function refresh( array $attributes ) { |
|
121 | - $this->clear(); |
|
122 | - |
|
123 | - return $this->merge( $attributes ); |
|
124 | - } |
|
125 | - |
|
126 | - /** |
|
127 | - * Merges the provided attributes with the provided array. |
|
128 | - * |
|
129 | - * @param array $attributes |
|
130 | - * |
|
131 | - * @return $this |
|
132 | - */ |
|
133 | - public function merge( array $attributes ) { |
|
134 | - foreach ( $attributes as $name => $value ) { |
|
135 | - $this->set_attribute( $name, $value ); |
|
136 | - } |
|
137 | - |
|
138 | - return $this; |
|
139 | - } |
|
140 | - |
|
141 | - /** |
|
142 | - * Get the model's table attributes. |
|
143 | - * |
|
144 | - * Returns the array of for the model that will either need to be |
|
145 | - * saved in postmeta or a separate table. |
|
146 | - * |
|
147 | - * @return array |
|
148 | - */ |
|
149 | - public function get_table_attributes() { |
|
150 | - return $this->attributes['table']; |
|
151 | - } |
|
152 | - |
|
153 | - /** |
|
154 | - * Get the model's original attributes. |
|
155 | - * |
|
156 | - * @return array |
|
157 | - */ |
|
158 | - public function get_original_table_attributes() { |
|
159 | - return $this->original['table']; |
|
160 | - } |
|
161 | - |
|
162 | - /** |
|
163 | - * Retrieve an array of the attributes on the model |
|
164 | - * that have changed compared to the model's |
|
165 | - * original data. |
|
166 | - * |
|
167 | - * @return array |
|
168 | - */ |
|
169 | - public function get_changed_table_attributes() { |
|
170 | - $changed = array(); |
|
171 | - |
|
172 | - foreach ( $this->get_table_attributes() as $attribute ) { |
|
173 | - if ( $this->get_attribute( $attribute ) !== |
|
174 | - $this->get_original_attribute( $attribute ) |
|
175 | - ) { |
|
176 | - $changed[ $attribute ] = $this->get_attribute( $attribute ); |
|
177 | - } |
|
178 | - } |
|
179 | - |
|
180 | - return $changed; |
|
181 | - } |
|
182 | - |
|
183 | - /** |
|
184 | - * Get the model's underlying post. |
|
185 | - * |
|
186 | - * Returns the underlying WP_Post object for the model, representing |
|
187 | - * the data that will be save in the wp_posts table. |
|
188 | - * |
|
189 | - * @return false|WP_Post|WP_Term |
|
190 | - */ |
|
191 | - public function get_underlying_wp_object() { |
|
192 | - if ( isset( $this->attributes['object'] ) ) { |
|
193 | - return $this->attributes['object']; |
|
194 | - } |
|
195 | - |
|
196 | - return false; |
|
197 | - } |
|
198 | - |
|
199 | - /** |
|
200 | - * Get the model's original underlying post. |
|
201 | - * |
|
202 | - * @return WP_Post |
|
203 | - */ |
|
204 | - public function get_original_underlying_wp_object() { |
|
205 | - return $this->original['object']; |
|
206 | - } |
|
207 | - |
|
208 | - /** |
|
209 | - * Get the model attributes on the WordPress object |
|
210 | - * that have changed compared to the model's |
|
211 | - * original attributes. |
|
212 | - * |
|
213 | - * @return array |
|
214 | - */ |
|
215 | - public function get_changed_wp_object_attributes() { |
|
216 | - $changed = array(); |
|
217 | - |
|
218 | - foreach ( $this->get_wp_object_keys() as $key ) { |
|
219 | - if ( $this->get_attribute( $key ) !== |
|
220 | - $this->get_original_attribute( $key ) |
|
221 | - ) { |
|
222 | - $changed[ $key ] = $this->get_attribute( $key ); |
|
223 | - } |
|
224 | - } |
|
225 | - |
|
226 | - return $changed; |
|
227 | - } |
|
228 | - |
|
229 | - /** |
|
230 | - * Magic __set method. |
|
231 | - * |
|
232 | - * Passes the name and value to set_attribute, which is where the magic happens. |
|
233 | - * |
|
234 | - * @param string $name |
|
235 | - * @param mixed $value |
|
236 | - */ |
|
237 | - public function __set( $name, $value ) { |
|
238 | - $this->set_attribute( $name, $value ); |
|
239 | - } |
|
240 | - |
|
241 | - /** |
|
242 | - * Sets the model attributes. |
|
243 | - * |
|
244 | - * Checks whether the model attribute can be set, check if it |
|
245 | - * maps to the WP_Post property, otherwise, assigns it to the |
|
246 | - * table attribute array. |
|
247 | - * |
|
248 | - * @param string $name |
|
249 | - * @param mixed $value |
|
250 | - * |
|
251 | - * @return $this |
|
252 | - * |
|
253 | - * @throws GuardedPropertyException |
|
254 | - */ |
|
255 | - public function set_attribute( $name, $value ) { |
|
256 | - if ( 'object' === $name ) { |
|
257 | - return $this->override_wp_object( $value ); |
|
258 | - } |
|
259 | - |
|
260 | - if ( ! $this->is_fillable( $name ) ) { |
|
261 | - throw new GuardedPropertyException; |
|
262 | - } |
|
263 | - |
|
264 | - if ( $method = $this->has_map_method( $name ) ) { |
|
265 | - $this->attributes['object']->{$this->{$method}()} = $value; |
|
266 | - } else { |
|
267 | - $this->attributes['table'][ $name ] = $value; |
|
268 | - } |
|
269 | - |
|
270 | - return $this; |
|
271 | - } |
|
272 | - |
|
273 | - /** |
|
274 | - * Retrieves all the attribute keys for the model. |
|
275 | - * |
|
276 | - * @return array |
|
277 | - */ |
|
278 | - public function get_attribute_keys() { |
|
279 | - if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
280 | - return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
281 | - } |
|
282 | - |
|
283 | - return self::$memo[ get_called_class() ][ __METHOD__ ] |
|
284 | - = array_merge( |
|
285 | - $this->fillable, |
|
286 | - $this->guarded, |
|
287 | - $this->get_compute_methods() |
|
288 | - ); |
|
289 | - } |
|
290 | - |
|
291 | - /** |
|
292 | - * Retrieves the attribute keys that aren't mapped to a post. |
|
293 | - * |
|
294 | - * @return array |
|
295 | - */ |
|
296 | - public function get_table_keys() { |
|
297 | - if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
298 | - return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
299 | - } |
|
300 | - |
|
301 | - $keys = array(); |
|
302 | - |
|
303 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
304 | - if ( ! $this->has_map_method( $key ) && |
|
305 | - ! $this->has_compute_method( $key ) |
|
306 | - ) { |
|
307 | - $keys[] = $key; |
|
308 | - } |
|
309 | - } |
|
310 | - |
|
311 | - return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
312 | - } |
|
313 | - |
|
314 | - /** |
|
315 | - * Retrieves the attribute keys that are mapped to a post. |
|
316 | - * |
|
317 | - * @return array |
|
318 | - */ |
|
319 | - public function get_wp_object_keys() { |
|
320 | - if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
321 | - return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
322 | - } |
|
323 | - |
|
324 | - $keys = array(); |
|
325 | - |
|
326 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
327 | - if ( $this->has_map_method( $key ) ) { |
|
328 | - $keys[] = $key; |
|
329 | - } |
|
330 | - } |
|
331 | - |
|
332 | - return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
333 | - } |
|
334 | - |
|
335 | - /** |
|
336 | - * Returns the model's keys that are computed at call time. |
|
337 | - * |
|
338 | - * @return array |
|
339 | - */ |
|
340 | - public function get_computed_keys() { |
|
341 | - if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
342 | - return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
343 | - } |
|
344 | - |
|
345 | - $keys = array(); |
|
346 | - |
|
347 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
348 | - if ( $this->has_compute_method( $key ) ) { |
|
349 | - $keys[] = $key; |
|
350 | - } |
|
351 | - } |
|
352 | - |
|
353 | - return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
354 | - } |
|
355 | - |
|
356 | - /** |
|
357 | - * Serializes the model's public data into an array. |
|
358 | - * |
|
359 | - * @return array |
|
360 | - */ |
|
361 | - public function serialize() { |
|
362 | - $attributes = array(); |
|
363 | - |
|
364 | - if ( $this->visible ) { |
|
365 | - // If visible attributes are set, we'll only reveal those. |
|
366 | - foreach ( $this->visible as $key ) { |
|
367 | - $attributes[ $key ] = $this->get_attribute( $key ); |
|
368 | - } |
|
369 | - } elseif ( $this->hidden ) { |
|
370 | - // If hidden attributes are set, we'll grab everything and hide those. |
|
371 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
372 | - if ( ! in_array( $key, $this->hidden ) ) { |
|
373 | - $attributes[ $key ] = $this->get_attribute( $key ); |
|
374 | - } |
|
375 | - } |
|
376 | - } else { |
|
377 | - // If nothing is hidden/visible, we'll grab and reveal everything. |
|
378 | - foreach ( $this->get_attribute_keys() as $key ) { |
|
379 | - $attributes[ $key ] = $this->get_attribute( $key ); |
|
380 | - } |
|
381 | - } |
|
382 | - |
|
383 | - return array_map( function ( $attribute ) { |
|
384 | - if ( $attribute instanceof Serializes ) { |
|
385 | - return $attribute->serialize(); |
|
386 | - } |
|
387 | - |
|
388 | - return $attribute; |
|
389 | - }, $attributes ); |
|
390 | - } |
|
391 | - |
|
392 | - /** |
|
393 | - * Syncs the current attributes to the model's original. |
|
394 | - * |
|
395 | - * @return $this |
|
396 | - */ |
|
397 | - public function sync_original() { |
|
398 | - $this->original = $this->attributes; |
|
399 | - |
|
400 | - if ( $this->attributes['object'] ) { |
|
401 | - $this->original['object'] = clone $this->attributes['object']; |
|
402 | - } |
|
403 | - |
|
404 | - return $this; |
|
405 | - } |
|
406 | - |
|
407 | - /** |
|
408 | - * Checks if a given attribute is mass-fillable. |
|
409 | - * |
|
410 | - * Returns true if the attribute can be filled, false if it can't. |
|
411 | - * |
|
412 | - * @param string $name |
|
413 | - * |
|
414 | - * @return bool |
|
415 | - */ |
|
416 | - private function is_fillable( $name ) { |
|
417 | - // If this model isn't guarded, everything is fillable. |
|
418 | - if ( ! $this->is_guarded ) { |
|
419 | - return true; |
|
420 | - } |
|
421 | - |
|
422 | - // If it's in the fillable array, then it's fillable. |
|
423 | - if ( in_array( $name, $this->fillable ) ) { |
|
424 | - return true; |
|
425 | - } |
|
426 | - |
|
427 | - // If it's explicitly guarded, then it's not fillable. |
|
428 | - if ( in_array( $name, $this->guarded ) ) { |
|
429 | - return false; |
|
430 | - } |
|
431 | - |
|
432 | - // If fillable hasn't been defined, then everything else fillable. |
|
433 | - return ! $this->fillable; |
|
434 | - } |
|
435 | - |
|
436 | - /** |
|
437 | - * Overrides the current WP_Post with a provided one. |
|
438 | - * |
|
439 | - * Resets the post's default values and stores it in the attributes. |
|
440 | - * |
|
441 | - * @param WP_Post $value |
|
442 | - * |
|
443 | - * @return $this |
|
444 | - */ |
|
445 | - private function override_wp_object( $value ) { |
|
446 | - $this->attributes['object'] = $this->set_wp_object_constants( $value ); |
|
447 | - |
|
448 | - return $this; |
|
449 | - } |
|
450 | - |
|
451 | - /** |
|
452 | - * Create and set with a new blank post. |
|
453 | - * |
|
454 | - * Creates a new WP_Post object, assigns it the default attributes, |
|
455 | - * and stores it in the attributes. |
|
456 | - * |
|
457 | - * @throws LogicException |
|
458 | - */ |
|
459 | - private function create_wp_object() { |
|
460 | - switch ( true ) { |
|
461 | - case $this instanceof UsesWordPressPost: |
|
462 | - $object = new WP_Post( (object) array() ); |
|
463 | - break; |
|
464 | - case $this instanceof UsesWordPressTerm: |
|
465 | - $object = new WP_Term( (object) array() ); |
|
466 | - break; |
|
467 | - default: |
|
468 | - throw new LogicException; |
|
469 | - break; |
|
470 | - } |
|
471 | - |
|
472 | - $this->attributes['object'] = $this->set_wp_object_constants( $object ); |
|
473 | - } |
|
474 | - |
|
475 | - /** |
|
476 | - * Enforces values on the post that can't change. |
|
477 | - * |
|
478 | - * Primarily, this is used to make sure the post_type always maps |
|
479 | - * to the model's "$type" property, but this can all be overridden |
|
480 | - * by the developer to enforce other values in the model. |
|
481 | - * |
|
482 | - * @param object $object |
|
483 | - * |
|
484 | - * @return object |
|
485 | - */ |
|
486 | - protected function set_wp_object_constants( $object ) { |
|
487 | - if ( $this instanceof UsesWordPressPost ) { |
|
488 | - $object->post_type = $this::get_post_type(); |
|
489 | - } |
|
490 | - |
|
491 | - if ( $this instanceof UsesWordPressTerm ) { |
|
492 | - $object->taxonomy = $this::get_taxonomy(); |
|
493 | - } |
|
494 | - |
|
495 | - return $object; |
|
496 | - } |
|
497 | - |
|
498 | - /** |
|
499 | - * Magic __get method. |
|
500 | - * |
|
501 | - * Passes the name and value to get_attribute, which is where the magic happens. |
|
502 | - * |
|
503 | - * @param string $name |
|
504 | - * |
|
505 | - * @return mixed |
|
506 | - */ |
|
507 | - public function __get( $name ) { |
|
508 | - return $this->get_attribute( $name ); |
|
509 | - } |
|
510 | - |
|
511 | - /** |
|
512 | - * Retrieves the model attribute. |
|
513 | - * |
|
514 | - * @param string $name |
|
515 | - * |
|
516 | - * @return mixed |
|
517 | - * |
|
518 | - * @throws PropertyDoesNotExistException If property isn't found. |
|
519 | - */ |
|
520 | - public function get_attribute( $name ) { |
|
521 | - if ( $method = $this->has_map_method( $name ) ) { |
|
522 | - $value = $this->attributes['object']->{$this->{$method}()}; |
|
523 | - } elseif ( $method = $this->has_compute_method( $name ) ) { |
|
524 | - $value = $this->{$method}(); |
|
525 | - } else { |
|
526 | - if ( ! isset( $this->attributes['table'][ $name ] ) ) { |
|
527 | - throw new PropertyDoesNotExistException; |
|
528 | - } |
|
529 | - |
|
530 | - $value = $this->attributes['table'][ $name ]; |
|
531 | - } |
|
532 | - |
|
533 | - return $value; |
|
534 | - } |
|
535 | - |
|
536 | - /** |
|
537 | - * Retrieve the model's original attribute value. |
|
538 | - * |
|
539 | - * @param string $name |
|
540 | - * |
|
541 | - * @return mixed |
|
542 | - * |
|
543 | - * @throws PropertyDoesNotExistException If property isn't found. |
|
544 | - */ |
|
545 | - public function get_original_attribute( $name ) { |
|
546 | - $original = new static( $this->original ); |
|
547 | - |
|
548 | - return $original->get_attribute( $name ); |
|
549 | - } |
|
550 | - |
|
551 | - /** |
|
552 | - * Fetches the Model's primary ID, depending on the model |
|
553 | - * implementation. |
|
554 | - * |
|
555 | - * @return int |
|
556 | - * |
|
557 | - * @throws LogicException |
|
558 | - */ |
|
559 | - public function get_primary_id() { |
|
560 | - if ( $this instanceof UsesWordPressPost ) { |
|
561 | - return $this->get_underlying_wp_object()->ID; |
|
562 | - } |
|
563 | - |
|
564 | - if ( $this instanceof UsesWordPressTerm ) { |
|
565 | - return $this->get_underlying_wp_object()->term_id; |
|
566 | - } |
|
567 | - |
|
568 | - // Model w/o wp_object not yet supported. |
|
569 | - throw new LogicException; |
|
570 | - } |
|
571 | - |
|
572 | - /** |
|
573 | - * Checks whether the attribute has a map method. |
|
574 | - * |
|
575 | - * This is used to determine whether the attribute maps to a |
|
576 | - * property on the underlying WP_Post object. Returns the |
|
577 | - * method if one exists, returns false if it doesn't. |
|
578 | - * |
|
579 | - * @param string $name |
|
580 | - * |
|
581 | - * @return false|string |
|
582 | - */ |
|
583 | - protected function has_map_method( $name ) { |
|
584 | - if ( method_exists( $this, $method = "map_{$name}" ) ) { |
|
585 | - return $method; |
|
586 | - } |
|
587 | - |
|
588 | - return false; |
|
589 | - } |
|
590 | - |
|
591 | - /** |
|
592 | - * Checks whether the attribute has a compute method. |
|
593 | - * |
|
594 | - * This is used to determine if the attribute should be computed |
|
595 | - * from other attributes. |
|
596 | - * |
|
597 | - * @param string $name |
|
598 | - * |
|
599 | - * @return false|string |
|
600 | - */ |
|
601 | - protected function has_compute_method( $name ) { |
|
602 | - if ( method_exists( $this, $method = "compute_{$name}" ) ) { |
|
603 | - return $method; |
|
604 | - } |
|
605 | - |
|
606 | - return false; |
|
607 | - } |
|
608 | - |
|
609 | - /** |
|
610 | - * Clears all the current attributes from the model. |
|
611 | - * |
|
612 | - * This does not touch the model's original attributes, and will |
|
613 | - * only clear fillable attributes, unless the model is unguarded. |
|
614 | - * |
|
615 | - * @return $this |
|
616 | - */ |
|
617 | - public function clear() { |
|
618 | - $keys = $this->get_attribute_keys(); |
|
619 | - |
|
620 | - foreach ( $keys as $key ) { |
|
621 | - try { |
|
622 | - $this->set_attribute( $key, null ); |
|
623 | - } catch ( GuardedPropertyException $e ) { |
|
624 | - // We won't clear out guarded attributes. |
|
625 | - } |
|
626 | - } |
|
627 | - |
|
628 | - return $this; |
|
629 | - } |
|
630 | - |
|
631 | - /** |
|
632 | - * Unguards the model. |
|
633 | - * |
|
634 | - * Sets the model to be unguarded, allowing the filling of |
|
635 | - * guarded attributes. |
|
636 | - */ |
|
637 | - public function unguard() { |
|
638 | - $this->is_guarded = false; |
|
639 | - } |
|
640 | - |
|
641 | - /** |
|
642 | - * Reguards the model. |
|
643 | - * |
|
644 | - * Sets the model to be guarded, preventing filling of |
|
645 | - * guarded attributes. |
|
646 | - */ |
|
647 | - public function reguard() { |
|
648 | - $this->is_guarded = true; |
|
649 | - } |
|
650 | - |
|
651 | - /** |
|
652 | - * Retrieves all the compute methods on the model. |
|
653 | - * |
|
654 | - * @return array |
|
655 | - */ |
|
656 | - protected function get_compute_methods() { |
|
657 | - $methods = get_class_methods( get_called_class() ); |
|
658 | - $methods = array_filter( $methods, function ( $method ) { |
|
659 | - return strrpos( $method, 'compute_', - strlen( $method ) ) !== false; |
|
660 | - } ); |
|
661 | - $methods = array_map( function ( $method ) { |
|
662 | - return substr( $method, strlen( 'compute_' ) ); |
|
663 | - }, $methods ); |
|
664 | - |
|
665 | - return $methods; |
|
666 | - } |
|
667 | - |
|
668 | - /** |
|
669 | - * Sets up the memo array for the creating model. |
|
670 | - */ |
|
671 | - private function maybe_boot() { |
|
672 | - if ( ! isset( self::$memo[ get_called_class() ] ) ) { |
|
673 | - self::$memo[ get_called_class() ] = array(); |
|
674 | - } |
|
675 | - } |
|
676 | - |
|
677 | - /** |
|
678 | - * Whether this Model uses an underlying WordPress object. |
|
679 | - * |
|
680 | - * @return bool |
|
681 | - */ |
|
682 | - protected function uses_wp_object() { |
|
683 | - return $this instanceof UsesWordPressPost || |
|
684 | - $this instanceof UsesWordPressTerm; |
|
685 | - } |
|
23 | + /** |
|
24 | + * Memoized values for class methods. |
|
25 | + * |
|
26 | + * @var array |
|
27 | + */ |
|
28 | + private static $memo = array(); |
|
29 | + |
|
30 | + /** |
|
31 | + * Model attributes. |
|
32 | + * |
|
33 | + * @var array |
|
34 | + */ |
|
35 | + private $attributes = array( |
|
36 | + 'table' => array(), |
|
37 | + 'object' => null, |
|
38 | + ); |
|
39 | + |
|
40 | + /** |
|
41 | + * Model's original attributes. |
|
42 | + * |
|
43 | + * @var array |
|
44 | + */ |
|
45 | + private $original = array( |
|
46 | + 'table' => array(), |
|
47 | + 'object' => null, |
|
48 | + ); |
|
49 | + |
|
50 | + /** |
|
51 | + * Properties which are allowed to be set on the model. |
|
52 | + * |
|
53 | + * If this array is empty, any attributes can be set on the model. |
|
54 | + * |
|
55 | + * @var string[] |
|
56 | + */ |
|
57 | + protected $fillable = array(); |
|
58 | + |
|
59 | + /** |
|
60 | + * Properties which cannot be automatically filled on the model. |
|
61 | + * |
|
62 | + * If the model is unguarded, these properties can be filled. |
|
63 | + * |
|
64 | + * @var array |
|
65 | + */ |
|
66 | + protected $guarded = array(); |
|
67 | + |
|
68 | + /** |
|
69 | + * Properties which should not be serialized. |
|
70 | + * |
|
71 | + * @var array |
|
72 | + */ |
|
73 | + protected $hidden = array(); |
|
74 | + |
|
75 | + /** |
|
76 | + * Properties which should be serialized. |
|
77 | + * |
|
78 | + * @var array |
|
79 | + */ |
|
80 | + protected $visible = array(); |
|
81 | + |
|
82 | + /** |
|
83 | + * Whether the model's properties are guarded. |
|
84 | + * |
|
85 | + * When false, allows guarded properties to be filled. |
|
86 | + * |
|
87 | + * @var bool |
|
88 | + */ |
|
89 | + protected $is_guarded = true; |
|
90 | + |
|
91 | + /** |
|
92 | + * Constructs a new model with provided attributes. |
|
93 | + * |
|
94 | + * If 'object' is passed as one of the attributes, the underlying post |
|
95 | + * will be overwritten. |
|
96 | + * |
|
97 | + * @param array <string, mixed> $attributes |
|
98 | + */ |
|
99 | + public function __construct( array $attributes = array() ) { |
|
100 | + $this->maybe_boot(); |
|
101 | + $this->sync_original(); |
|
102 | + |
|
103 | + if ( $this->uses_wp_object() ) { |
|
104 | + $this->create_wp_object(); |
|
105 | + } |
|
106 | + |
|
107 | + $this->refresh( $attributes ); |
|
108 | + } |
|
109 | + |
|
110 | + /** |
|
111 | + * Refreshes the model's current attributes with the provided array. |
|
112 | + * |
|
113 | + * The model's attributes will match what was provided in the array, |
|
114 | + * and any attributes not passed |
|
115 | + * |
|
116 | + * @param array $attributes |
|
117 | + * |
|
118 | + * @return $this |
|
119 | + */ |
|
120 | + public function refresh( array $attributes ) { |
|
121 | + $this->clear(); |
|
122 | + |
|
123 | + return $this->merge( $attributes ); |
|
124 | + } |
|
125 | + |
|
126 | + /** |
|
127 | + * Merges the provided attributes with the provided array. |
|
128 | + * |
|
129 | + * @param array $attributes |
|
130 | + * |
|
131 | + * @return $this |
|
132 | + */ |
|
133 | + public function merge( array $attributes ) { |
|
134 | + foreach ( $attributes as $name => $value ) { |
|
135 | + $this->set_attribute( $name, $value ); |
|
136 | + } |
|
137 | + |
|
138 | + return $this; |
|
139 | + } |
|
140 | + |
|
141 | + /** |
|
142 | + * Get the model's table attributes. |
|
143 | + * |
|
144 | + * Returns the array of for the model that will either need to be |
|
145 | + * saved in postmeta or a separate table. |
|
146 | + * |
|
147 | + * @return array |
|
148 | + */ |
|
149 | + public function get_table_attributes() { |
|
150 | + return $this->attributes['table']; |
|
151 | + } |
|
152 | + |
|
153 | + /** |
|
154 | + * Get the model's original attributes. |
|
155 | + * |
|
156 | + * @return array |
|
157 | + */ |
|
158 | + public function get_original_table_attributes() { |
|
159 | + return $this->original['table']; |
|
160 | + } |
|
161 | + |
|
162 | + /** |
|
163 | + * Retrieve an array of the attributes on the model |
|
164 | + * that have changed compared to the model's |
|
165 | + * original data. |
|
166 | + * |
|
167 | + * @return array |
|
168 | + */ |
|
169 | + public function get_changed_table_attributes() { |
|
170 | + $changed = array(); |
|
171 | + |
|
172 | + foreach ( $this->get_table_attributes() as $attribute ) { |
|
173 | + if ( $this->get_attribute( $attribute ) !== |
|
174 | + $this->get_original_attribute( $attribute ) |
|
175 | + ) { |
|
176 | + $changed[ $attribute ] = $this->get_attribute( $attribute ); |
|
177 | + } |
|
178 | + } |
|
179 | + |
|
180 | + return $changed; |
|
181 | + } |
|
182 | + |
|
183 | + /** |
|
184 | + * Get the model's underlying post. |
|
185 | + * |
|
186 | + * Returns the underlying WP_Post object for the model, representing |
|
187 | + * the data that will be save in the wp_posts table. |
|
188 | + * |
|
189 | + * @return false|WP_Post|WP_Term |
|
190 | + */ |
|
191 | + public function get_underlying_wp_object() { |
|
192 | + if ( isset( $this->attributes['object'] ) ) { |
|
193 | + return $this->attributes['object']; |
|
194 | + } |
|
195 | + |
|
196 | + return false; |
|
197 | + } |
|
198 | + |
|
199 | + /** |
|
200 | + * Get the model's original underlying post. |
|
201 | + * |
|
202 | + * @return WP_Post |
|
203 | + */ |
|
204 | + public function get_original_underlying_wp_object() { |
|
205 | + return $this->original['object']; |
|
206 | + } |
|
207 | + |
|
208 | + /** |
|
209 | + * Get the model attributes on the WordPress object |
|
210 | + * that have changed compared to the model's |
|
211 | + * original attributes. |
|
212 | + * |
|
213 | + * @return array |
|
214 | + */ |
|
215 | + public function get_changed_wp_object_attributes() { |
|
216 | + $changed = array(); |
|
217 | + |
|
218 | + foreach ( $this->get_wp_object_keys() as $key ) { |
|
219 | + if ( $this->get_attribute( $key ) !== |
|
220 | + $this->get_original_attribute( $key ) |
|
221 | + ) { |
|
222 | + $changed[ $key ] = $this->get_attribute( $key ); |
|
223 | + } |
|
224 | + } |
|
225 | + |
|
226 | + return $changed; |
|
227 | + } |
|
228 | + |
|
229 | + /** |
|
230 | + * Magic __set method. |
|
231 | + * |
|
232 | + * Passes the name and value to set_attribute, which is where the magic happens. |
|
233 | + * |
|
234 | + * @param string $name |
|
235 | + * @param mixed $value |
|
236 | + */ |
|
237 | + public function __set( $name, $value ) { |
|
238 | + $this->set_attribute( $name, $value ); |
|
239 | + } |
|
240 | + |
|
241 | + /** |
|
242 | + * Sets the model attributes. |
|
243 | + * |
|
244 | + * Checks whether the model attribute can be set, check if it |
|
245 | + * maps to the WP_Post property, otherwise, assigns it to the |
|
246 | + * table attribute array. |
|
247 | + * |
|
248 | + * @param string $name |
|
249 | + * @param mixed $value |
|
250 | + * |
|
251 | + * @return $this |
|
252 | + * |
|
253 | + * @throws GuardedPropertyException |
|
254 | + */ |
|
255 | + public function set_attribute( $name, $value ) { |
|
256 | + if ( 'object' === $name ) { |
|
257 | + return $this->override_wp_object( $value ); |
|
258 | + } |
|
259 | + |
|
260 | + if ( ! $this->is_fillable( $name ) ) { |
|
261 | + throw new GuardedPropertyException; |
|
262 | + } |
|
263 | + |
|
264 | + if ( $method = $this->has_map_method( $name ) ) { |
|
265 | + $this->attributes['object']->{$this->{$method}()} = $value; |
|
266 | + } else { |
|
267 | + $this->attributes['table'][ $name ] = $value; |
|
268 | + } |
|
269 | + |
|
270 | + return $this; |
|
271 | + } |
|
272 | + |
|
273 | + /** |
|
274 | + * Retrieves all the attribute keys for the model. |
|
275 | + * |
|
276 | + * @return array |
|
277 | + */ |
|
278 | + public function get_attribute_keys() { |
|
279 | + if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
280 | + return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
281 | + } |
|
282 | + |
|
283 | + return self::$memo[ get_called_class() ][ __METHOD__ ] |
|
284 | + = array_merge( |
|
285 | + $this->fillable, |
|
286 | + $this->guarded, |
|
287 | + $this->get_compute_methods() |
|
288 | + ); |
|
289 | + } |
|
290 | + |
|
291 | + /** |
|
292 | + * Retrieves the attribute keys that aren't mapped to a post. |
|
293 | + * |
|
294 | + * @return array |
|
295 | + */ |
|
296 | + public function get_table_keys() { |
|
297 | + if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
298 | + return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
299 | + } |
|
300 | + |
|
301 | + $keys = array(); |
|
302 | + |
|
303 | + foreach ( $this->get_attribute_keys() as $key ) { |
|
304 | + if ( ! $this->has_map_method( $key ) && |
|
305 | + ! $this->has_compute_method( $key ) |
|
306 | + ) { |
|
307 | + $keys[] = $key; |
|
308 | + } |
|
309 | + } |
|
310 | + |
|
311 | + return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
312 | + } |
|
313 | + |
|
314 | + /** |
|
315 | + * Retrieves the attribute keys that are mapped to a post. |
|
316 | + * |
|
317 | + * @return array |
|
318 | + */ |
|
319 | + public function get_wp_object_keys() { |
|
320 | + if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
321 | + return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
322 | + } |
|
323 | + |
|
324 | + $keys = array(); |
|
325 | + |
|
326 | + foreach ( $this->get_attribute_keys() as $key ) { |
|
327 | + if ( $this->has_map_method( $key ) ) { |
|
328 | + $keys[] = $key; |
|
329 | + } |
|
330 | + } |
|
331 | + |
|
332 | + return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
333 | + } |
|
334 | + |
|
335 | + /** |
|
336 | + * Returns the model's keys that are computed at call time. |
|
337 | + * |
|
338 | + * @return array |
|
339 | + */ |
|
340 | + public function get_computed_keys() { |
|
341 | + if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) { |
|
342 | + return self::$memo[ get_called_class() ][ __METHOD__ ]; |
|
343 | + } |
|
344 | + |
|
345 | + $keys = array(); |
|
346 | + |
|
347 | + foreach ( $this->get_attribute_keys() as $key ) { |
|
348 | + if ( $this->has_compute_method( $key ) ) { |
|
349 | + $keys[] = $key; |
|
350 | + } |
|
351 | + } |
|
352 | + |
|
353 | + return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys; |
|
354 | + } |
|
355 | + |
|
356 | + /** |
|
357 | + * Serializes the model's public data into an array. |
|
358 | + * |
|
359 | + * @return array |
|
360 | + */ |
|
361 | + public function serialize() { |
|
362 | + $attributes = array(); |
|
363 | + |
|
364 | + if ( $this->visible ) { |
|
365 | + // If visible attributes are set, we'll only reveal those. |
|
366 | + foreach ( $this->visible as $key ) { |
|
367 | + $attributes[ $key ] = $this->get_attribute( $key ); |
|
368 | + } |
|
369 | + } elseif ( $this->hidden ) { |
|
370 | + // If hidden attributes are set, we'll grab everything and hide those. |
|
371 | + foreach ( $this->get_attribute_keys() as $key ) { |
|
372 | + if ( ! in_array( $key, $this->hidden ) ) { |
|
373 | + $attributes[ $key ] = $this->get_attribute( $key ); |
|
374 | + } |
|
375 | + } |
|
376 | + } else { |
|
377 | + // If nothing is hidden/visible, we'll grab and reveal everything. |
|
378 | + foreach ( $this->get_attribute_keys() as $key ) { |
|
379 | + $attributes[ $key ] = $this->get_attribute( $key ); |
|
380 | + } |
|
381 | + } |
|
382 | + |
|
383 | + return array_map( function ( $attribute ) { |
|
384 | + if ( $attribute instanceof Serializes ) { |
|
385 | + return $attribute->serialize(); |
|
386 | + } |
|
387 | + |
|
388 | + return $attribute; |
|
389 | + }, $attributes ); |
|
390 | + } |
|
391 | + |
|
392 | + /** |
|
393 | + * Syncs the current attributes to the model's original. |
|
394 | + * |
|
395 | + * @return $this |
|
396 | + */ |
|
397 | + public function sync_original() { |
|
398 | + $this->original = $this->attributes; |
|
399 | + |
|
400 | + if ( $this->attributes['object'] ) { |
|
401 | + $this->original['object'] = clone $this->attributes['object']; |
|
402 | + } |
|
403 | + |
|
404 | + return $this; |
|
405 | + } |
|
406 | + |
|
407 | + /** |
|
408 | + * Checks if a given attribute is mass-fillable. |
|
409 | + * |
|
410 | + * Returns true if the attribute can be filled, false if it can't. |
|
411 | + * |
|
412 | + * @param string $name |
|
413 | + * |
|
414 | + * @return bool |
|
415 | + */ |
|
416 | + private function is_fillable( $name ) { |
|
417 | + // If this model isn't guarded, everything is fillable. |
|
418 | + if ( ! $this->is_guarded ) { |
|
419 | + return true; |
|
420 | + } |
|
421 | + |
|
422 | + // If it's in the fillable array, then it's fillable. |
|
423 | + if ( in_array( $name, $this->fillable ) ) { |
|
424 | + return true; |
|
425 | + } |
|
426 | + |
|
427 | + // If it's explicitly guarded, then it's not fillable. |
|
428 | + if ( in_array( $name, $this->guarded ) ) { |
|
429 | + return false; |
|
430 | + } |
|
431 | + |
|
432 | + // If fillable hasn't been defined, then everything else fillable. |
|
433 | + return ! $this->fillable; |
|
434 | + } |
|
435 | + |
|
436 | + /** |
|
437 | + * Overrides the current WP_Post with a provided one. |
|
438 | + * |
|
439 | + * Resets the post's default values and stores it in the attributes. |
|
440 | + * |
|
441 | + * @param WP_Post $value |
|
442 | + * |
|
443 | + * @return $this |
|
444 | + */ |
|
445 | + private function override_wp_object( $value ) { |
|
446 | + $this->attributes['object'] = $this->set_wp_object_constants( $value ); |
|
447 | + |
|
448 | + return $this; |
|
449 | + } |
|
450 | + |
|
451 | + /** |
|
452 | + * Create and set with a new blank post. |
|
453 | + * |
|
454 | + * Creates a new WP_Post object, assigns it the default attributes, |
|
455 | + * and stores it in the attributes. |
|
456 | + * |
|
457 | + * @throws LogicException |
|
458 | + */ |
|
459 | + private function create_wp_object() { |
|
460 | + switch ( true ) { |
|
461 | + case $this instanceof UsesWordPressPost: |
|
462 | + $object = new WP_Post( (object) array() ); |
|
463 | + break; |
|
464 | + case $this instanceof UsesWordPressTerm: |
|
465 | + $object = new WP_Term( (object) array() ); |
|
466 | + break; |
|
467 | + default: |
|
468 | + throw new LogicException; |
|
469 | + break; |
|
470 | + } |
|
471 | + |
|
472 | + $this->attributes['object'] = $this->set_wp_object_constants( $object ); |
|
473 | + } |
|
474 | + |
|
475 | + /** |
|
476 | + * Enforces values on the post that can't change. |
|
477 | + * |
|
478 | + * Primarily, this is used to make sure the post_type always maps |
|
479 | + * to the model's "$type" property, but this can all be overridden |
|
480 | + * by the developer to enforce other values in the model. |
|
481 | + * |
|
482 | + * @param object $object |
|
483 | + * |
|
484 | + * @return object |
|
485 | + */ |
|
486 | + protected function set_wp_object_constants( $object ) { |
|
487 | + if ( $this instanceof UsesWordPressPost ) { |
|
488 | + $object->post_type = $this::get_post_type(); |
|
489 | + } |
|
490 | + |
|
491 | + if ( $this instanceof UsesWordPressTerm ) { |
|
492 | + $object->taxonomy = $this::get_taxonomy(); |
|
493 | + } |
|
494 | + |
|
495 | + return $object; |
|
496 | + } |
|
497 | + |
|
498 | + /** |
|
499 | + * Magic __get method. |
|
500 | + * |
|
501 | + * Passes the name and value to get_attribute, which is where the magic happens. |
|
502 | + * |
|
503 | + * @param string $name |
|
504 | + * |
|
505 | + * @return mixed |
|
506 | + */ |
|
507 | + public function __get( $name ) { |
|
508 | + return $this->get_attribute( $name ); |
|
509 | + } |
|
510 | + |
|
511 | + /** |
|
512 | + * Retrieves the model attribute. |
|
513 | + * |
|
514 | + * @param string $name |
|
515 | + * |
|
516 | + * @return mixed |
|
517 | + * |
|
518 | + * @throws PropertyDoesNotExistException If property isn't found. |
|
519 | + */ |
|
520 | + public function get_attribute( $name ) { |
|
521 | + if ( $method = $this->has_map_method( $name ) ) { |
|
522 | + $value = $this->attributes['object']->{$this->{$method}()}; |
|
523 | + } elseif ( $method = $this->has_compute_method( $name ) ) { |
|
524 | + $value = $this->{$method}(); |
|
525 | + } else { |
|
526 | + if ( ! isset( $this->attributes['table'][ $name ] ) ) { |
|
527 | + throw new PropertyDoesNotExistException; |
|
528 | + } |
|
529 | + |
|
530 | + $value = $this->attributes['table'][ $name ]; |
|
531 | + } |
|
532 | + |
|
533 | + return $value; |
|
534 | + } |
|
535 | + |
|
536 | + /** |
|
537 | + * Retrieve the model's original attribute value. |
|
538 | + * |
|
539 | + * @param string $name |
|
540 | + * |
|
541 | + * @return mixed |
|
542 | + * |
|
543 | + * @throws PropertyDoesNotExistException If property isn't found. |
|
544 | + */ |
|
545 | + public function get_original_attribute( $name ) { |
|
546 | + $original = new static( $this->original ); |
|
547 | + |
|
548 | + return $original->get_attribute( $name ); |
|
549 | + } |
|
550 | + |
|
551 | + /** |
|
552 | + * Fetches the Model's primary ID, depending on the model |
|
553 | + * implementation. |
|
554 | + * |
|
555 | + * @return int |
|
556 | + * |
|
557 | + * @throws LogicException |
|
558 | + */ |
|
559 | + public function get_primary_id() { |
|
560 | + if ( $this instanceof UsesWordPressPost ) { |
|
561 | + return $this->get_underlying_wp_object()->ID; |
|
562 | + } |
|
563 | + |
|
564 | + if ( $this instanceof UsesWordPressTerm ) { |
|
565 | + return $this->get_underlying_wp_object()->term_id; |
|
566 | + } |
|
567 | + |
|
568 | + // Model w/o wp_object not yet supported. |
|
569 | + throw new LogicException; |
|
570 | + } |
|
571 | + |
|
572 | + /** |
|
573 | + * Checks whether the attribute has a map method. |
|
574 | + * |
|
575 | + * This is used to determine whether the attribute maps to a |
|
576 | + * property on the underlying WP_Post object. Returns the |
|
577 | + * method if one exists, returns false if it doesn't. |
|
578 | + * |
|
579 | + * @param string $name |
|
580 | + * |
|
581 | + * @return false|string |
|
582 | + */ |
|
583 | + protected function has_map_method( $name ) { |
|
584 | + if ( method_exists( $this, $method = "map_{$name}" ) ) { |
|
585 | + return $method; |
|
586 | + } |
|
587 | + |
|
588 | + return false; |
|
589 | + } |
|
590 | + |
|
591 | + /** |
|
592 | + * Checks whether the attribute has a compute method. |
|
593 | + * |
|
594 | + * This is used to determine if the attribute should be computed |
|
595 | + * from other attributes. |
|
596 | + * |
|
597 | + * @param string $name |
|
598 | + * |
|
599 | + * @return false|string |
|
600 | + */ |
|
601 | + protected function has_compute_method( $name ) { |
|
602 | + if ( method_exists( $this, $method = "compute_{$name}" ) ) { |
|
603 | + return $method; |
|
604 | + } |
|
605 | + |
|
606 | + return false; |
|
607 | + } |
|
608 | + |
|
609 | + /** |
|
610 | + * Clears all the current attributes from the model. |
|
611 | + * |
|
612 | + * This does not touch the model's original attributes, and will |
|
613 | + * only clear fillable attributes, unless the model is unguarded. |
|
614 | + * |
|
615 | + * @return $this |
|
616 | + */ |
|
617 | + public function clear() { |
|
618 | + $keys = $this->get_attribute_keys(); |
|
619 | + |
|
620 | + foreach ( $keys as $key ) { |
|
621 | + try { |
|
622 | + $this->set_attribute( $key, null ); |
|
623 | + } catch ( GuardedPropertyException $e ) { |
|
624 | + // We won't clear out guarded attributes. |
|
625 | + } |
|
626 | + } |
|
627 | + |
|
628 | + return $this; |
|
629 | + } |
|
630 | + |
|
631 | + /** |
|
632 | + * Unguards the model. |
|
633 | + * |
|
634 | + * Sets the model to be unguarded, allowing the filling of |
|
635 | + * guarded attributes. |
|
636 | + */ |
|
637 | + public function unguard() { |
|
638 | + $this->is_guarded = false; |
|
639 | + } |
|
640 | + |
|
641 | + /** |
|
642 | + * Reguards the model. |
|
643 | + * |
|
644 | + * Sets the model to be guarded, preventing filling of |
|
645 | + * guarded attributes. |
|
646 | + */ |
|
647 | + public function reguard() { |
|
648 | + $this->is_guarded = true; |
|
649 | + } |
|
650 | + |
|
651 | + /** |
|
652 | + * Retrieves all the compute methods on the model. |
|
653 | + * |
|
654 | + * @return array |
|
655 | + */ |
|
656 | + protected function get_compute_methods() { |
|
657 | + $methods = get_class_methods( get_called_class() ); |
|
658 | + $methods = array_filter( $methods, function ( $method ) { |
|
659 | + return strrpos( $method, 'compute_', - strlen( $method ) ) !== false; |
|
660 | + } ); |
|
661 | + $methods = array_map( function ( $method ) { |
|
662 | + return substr( $method, strlen( 'compute_' ) ); |
|
663 | + }, $methods ); |
|
664 | + |
|
665 | + return $methods; |
|
666 | + } |
|
667 | + |
|
668 | + /** |
|
669 | + * Sets up the memo array for the creating model. |
|
670 | + */ |
|
671 | + private function maybe_boot() { |
|
672 | + if ( ! isset( self::$memo[ get_called_class() ] ) ) { |
|
673 | + self::$memo[ get_called_class() ] = array(); |
|
674 | + } |
|
675 | + } |
|
676 | + |
|
677 | + /** |
|
678 | + * Whether this Model uses an underlying WordPress object. |
|
679 | + * |
|
680 | + * @return bool |
|
681 | + */ |
|
682 | + protected function uses_wp_object() { |
|
683 | + return $this instanceof UsesWordPressPost || |
|
684 | + $this instanceof UsesWordPressTerm; |
|
685 | + } |
|
686 | 686 | } |