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