@@ -21,7 +21,7 @@ |
||
21 | 21 | |
22 | 22 | public function required_arguments() |
23 | 23 | { |
24 | - return array('name','data'); |
|
24 | + return array('name', 'data'); |
|
25 | 25 | } |
26 | 26 | |
27 | 27 | public function get_template_path() |
@@ -8,7 +8,7 @@ |
||
8 | 8 | class Component_select |
9 | 9 | extends AbstractComponent |
10 | 10 | implements ValueComponentInterface, |
11 | - DisableableComponentInterface |
|
11 | + DisableableComponentInterface |
|
12 | 12 | { |
13 | 13 | public function default_model() |
14 | 14 | { |
@@ -13,7 +13,7 @@ discard block |
||
13 | 13 | * |
14 | 14 | * @param array $model |
15 | 15 | */ |
16 | - public function __construct( array $model = array() ) |
|
16 | + public function __construct(array $model = array()) |
|
17 | 17 | { |
18 | 18 | parent::__construct($model); |
19 | 19 | $this->on_created(); |
@@ -48,24 +48,24 @@ discard block |
||
48 | 48 | * |
49 | 49 | * @return array |
50 | 50 | */ |
51 | - public function set_model( $model ) |
|
51 | + public function set_model($model) |
|
52 | 52 | { |
53 | 53 | // Check that the required arguments are provided. |
54 | - foreach( $this->required_arguments() as $key ) |
|
54 | + foreach ($this->required_arguments() as $key) |
|
55 | 55 | { |
56 | - if ( !isset($model[$key]) ) |
|
56 | + if (!isset($model[$key])) |
|
57 | 57 | { |
58 | 58 | throw new \RuntimeException('The required argument "'.$key.'" was not provided for '.get_called_class()); |
59 | 59 | } |
60 | 60 | } |
61 | 61 | |
62 | 62 | // Assign the name of the component as the id if no id was specified |
63 | - if( !isset($model['id']) ) |
|
63 | + if (!isset($model['id'])) |
|
64 | 64 | { |
65 | 65 | $model['id'] = $model['name']; |
66 | 66 | } |
67 | 67 | |
68 | - $this->model = array_merge( $this->default_model(), $model ); |
|
68 | + $this->model = array_merge($this->default_model(), $model); |
|
69 | 69 | } |
70 | 70 | |
71 | 71 | /** |
@@ -17,7 +17,9 @@ |
||
17 | 17 | /** |
18 | 18 | * Prevent loading the library more than once |
19 | 19 | */ |
20 | -if( defined( 'AMARKAL_UI' ) ) return false; |
|
20 | +if( defined( 'AMARKAL_UI' ) ) { |
|
21 | + return false; |
|
22 | +} |
|
21 | 23 | define( 'AMARKAL_UI', true ); |
22 | 24 | |
23 | 25 | if(!function_exists('amarkal_ui_render')) |
@@ -12,15 +12,15 @@ discard block |
||
12 | 12 | */ |
13 | 13 | |
14 | 14 | // Prevent direct file access |
15 | -defined( 'ABSPATH' ) or die( 'No script kiddies please!' ); |
|
15 | +defined('ABSPATH') or die('No script kiddies please!'); |
|
16 | 16 | |
17 | 17 | /** |
18 | 18 | * Prevent loading the library more than once |
19 | 19 | */ |
20 | -if( defined( 'AMARKAL_UI' ) ) return false; |
|
21 | -define( 'AMARKAL_UI', true ); |
|
20 | +if (defined('AMARKAL_UI')) return false; |
|
21 | +define('AMARKAL_UI', true); |
|
22 | 22 | |
23 | -if(!function_exists('amarkal_ui_render')) |
|
23 | +if (!function_exists('amarkal_ui_render')) |
|
24 | 24 | { |
25 | 25 | /** |
26 | 26 | * Render a UI component. |
@@ -30,14 +30,14 @@ discard block |
||
30 | 30 | * @param array $props The component's properties |
31 | 31 | * @return string The rendered HTML |
32 | 32 | */ |
33 | - function amarkal_ui_render( $type, array $props = array() ) |
|
33 | + function amarkal_ui_render($type, array $props = array()) |
|
34 | 34 | { |
35 | - $component = Amarkal\UI\ComponentFactory::create( $type, $props ); |
|
35 | + $component = Amarkal\UI\ComponentFactory::create($type, $props); |
|
36 | 36 | return $component->render(); |
37 | 37 | } |
38 | 38 | } |
39 | 39 | |
40 | -if(!function_exists('amarkal_ui_register_component')) |
|
40 | +if (!function_exists('amarkal_ui_register_component')) |
|
41 | 41 | { |
42 | 42 | /** |
43 | 43 | * Register a custom UI component. The registered component's class should |
@@ -47,8 +47,8 @@ discard block |
||
47 | 47 | * to one of the core component's type, it will override the core component. |
48 | 48 | * @param string $class_name The component's class name. |
49 | 49 | */ |
50 | - function amarkal_ui_register_component( $type, $class_name ) |
|
50 | + function amarkal_ui_register_component($type, $class_name) |
|
51 | 51 | { |
52 | - Amarkal\UI\ComponentFactory::register( $type, $class_name ); |
|
52 | + Amarkal\UI\ComponentFactory::register($type, $class_name); |
|
53 | 53 | } |
54 | 54 | } |
55 | 55 | \ No newline at end of file |
@@ -6,7 +6,7 @@ |
||
6 | 6 | */ |
7 | 7 | |
8 | 8 | // Prevent direct file access |
9 | -defined( 'ABSPATH' ) or die( 'No script kiddies please!' ); |
|
9 | +defined('ABSPATH') or die('No script kiddies please!'); |
|
10 | 10 | |
11 | 11 | // Load module functions |
12 | 12 | require_once 'functions.php'; |
13 | 13 | \ No newline at end of file |
@@ -6,13 +6,13 @@ |
||
6 | 6 | */ |
7 | 7 | |
8 | 8 | // Prevent direct file access |
9 | -defined( 'ABSPATH' ) or die( 'No script kiddies please!' ); |
|
9 | +defined('ABSPATH') or die('No script kiddies please!'); |
|
10 | 10 | |
11 | 11 | /** |
12 | 12 | * Load module functions. If this amarkal module has not been loaded, |
13 | 13 | * functions.php will not return false. |
14 | 14 | */ |
15 | -if(false !== (require_once 'functions.php')) |
|
15 | +if (false !== (require_once 'functions.php')) |
|
16 | 16 | { |
17 | 17 | // Load required classes if not using composer |
18 | 18 | require_once 'Renderer.php'; |
@@ -52,8 +52,8 @@ discard block |
||
52 | 52 | |
53 | 53 | /** |
54 | 54 | * |
55 | - * @param type $type |
|
56 | - * @param type $props |
|
55 | + * @param string $type |
|
56 | + * @param type string |
|
57 | 57 | * @throws \RuntimeException |
58 | 58 | */ |
59 | 59 | private static function create_core_component( $type, $props ) |
@@ -79,8 +79,8 @@ discard block |
||
79 | 79 | |
80 | 80 | /** |
81 | 81 | * |
82 | - * @param type $type |
|
83 | - * @param type $props |
|
82 | + * @param string $type |
|
83 | + * @param type string |
|
84 | 84 | * @throws \RuntimeException |
85 | 85 | */ |
86 | 86 | private static function create_registered_component( $type, $props ) |
@@ -20,7 +20,7 @@ discard block |
||
20 | 20 | * @param array $props |
21 | 21 | * @return AbstractComponent |
22 | 22 | */ |
23 | - public static function create( $type, array $props ) |
|
23 | + public static function create($type, array $props) |
|
24 | 24 | { |
25 | 25 | try { |
26 | 26 | $component = self::create_registered_component($type, $props); |
@@ -41,9 +41,9 @@ discard block |
||
41 | 41 | * @param string $class_name |
42 | 42 | * @throws \RuntimeException |
43 | 43 | */ |
44 | - public static function register( $type, $class_name ) |
|
44 | + public static function register($type, $class_name) |
|
45 | 45 | { |
46 | - if( !in_array($type, self::$registered_components) ) |
|
46 | + if (!in_array($type, self::$registered_components)) |
|
47 | 47 | { |
48 | 48 | self::$registered_components[$type] = $class_name; |
49 | 49 | } |
@@ -56,15 +56,15 @@ discard block |
||
56 | 56 | * @param type $props |
57 | 57 | * @throws \RuntimeException |
58 | 58 | */ |
59 | - private static function create_core_component( $type, $props ) |
|
59 | + private static function create_core_component($type, $props) |
|
60 | 60 | { |
61 | 61 | $file_name = __DIR__."/components/$type/controller.php"; |
62 | 62 | $class_name = 'Amarkal\\UI\\Component_'.$type; |
63 | 63 | |
64 | 64 | // Load one of the core components |
65 | - if(!class_exists($class_name)) |
|
65 | + if (!class_exists($class_name)) |
|
66 | 66 | { |
67 | - if( file_exists( $file_name ) ) |
|
67 | + if (file_exists($file_name)) |
|
68 | 68 | { |
69 | 69 | require_once $file_name; |
70 | 70 | } |
@@ -83,9 +83,9 @@ discard block |
||
83 | 83 | * @param type $props |
84 | 84 | * @throws \RuntimeException |
85 | 85 | */ |
86 | - private static function create_registered_component( $type, $props ) |
|
86 | + private static function create_registered_component($type, $props) |
|
87 | 87 | { |
88 | - if(in_array($type, self::$registered_components)) |
|
88 | + if (in_array($type, self::$registered_components)) |
|
89 | 89 | { |
90 | 90 | $class_name = self::$registered_components[$type]; |
91 | 91 | return new $class_name($props); |
@@ -46,8 +46,9 @@ discard block |
||
46 | 46 | if( !in_array($type, self::$registered_components) ) |
47 | 47 | { |
48 | 48 | self::$registered_components[$type] = $class_name; |
49 | + } else { |
|
50 | + throw new \RuntimeException("A component of type '$type' has already been registered."); |
|
49 | 51 | } |
50 | - else throw new \RuntimeException("A component of type '$type' has already been registered."); |
|
51 | 52 | } |
52 | 53 | |
53 | 54 | /** |
@@ -67,8 +68,7 @@ discard block |
||
67 | 68 | if( file_exists( $file_name ) ) |
68 | 69 | { |
69 | 70 | require_once $file_name; |
70 | - } |
|
71 | - else |
|
71 | + } else |
|
72 | 72 | { |
73 | 73 | throw new \RuntimeException("A component of type '$type' does not exist."); |
74 | 74 | } |
@@ -8,9 +8,9 @@ |
||
8 | 8 | class Component_text |
9 | 9 | extends AbstractComponent |
10 | 10 | implements ValueComponentInterface, |
11 | - DisableableComponentInterface, |
|
12 | - FilterableComponentInterface, |
|
13 | - ValidatableComponentInterface |
|
11 | + DisableableComponentInterface, |
|
12 | + FilterableComponentInterface, |
|
13 | + ValidatableComponentInterface |
|
14 | 14 | { |
15 | 15 | public function default_model() |
16 | 16 | { |
@@ -202,7 +202,9 @@ |
||
202 | 202 | */ |
203 | 203 | private function validate( $component ) |
204 | 204 | { |
205 | - if( !($component instanceof ValidatableComponentInterface) ) return; |
|
205 | + if( !($component instanceof ValidatableComponentInterface) ) { |
|
206 | + return; |
|
207 | + } |
|
206 | 208 | |
207 | 209 | $name = $component->name; |
208 | 210 | $validate = $component->validation; |
@@ -137,7 +137,7 @@ discard block |
||
137 | 137 | * Get a component by its name. |
138 | 138 | * |
139 | 139 | * @param string $name |
140 | - * @return UI\AbstractComponent |
|
140 | + * @return AbstractComponent |
|
141 | 141 | */ |
142 | 142 | public function get_component( $name ) |
143 | 143 | { |
@@ -147,7 +147,7 @@ discard block |
||
147 | 147 | /** |
148 | 148 | * Get all components. |
149 | 149 | * |
150 | - * @return array |
|
150 | + * @return AbstractComponent[] |
|
151 | 151 | */ |
152 | 152 | public function get_components() |
153 | 153 | { |
@@ -181,7 +181,7 @@ discard block |
||
181 | 181 | /** |
182 | 182 | * Check if the given component is disabled. |
183 | 183 | * |
184 | - * @param UI\AbstractComponent $component |
|
184 | + * @param ValueComponentInterface $component |
|
185 | 185 | * @return boolean |
186 | 186 | */ |
187 | 187 | private function is_disabled( $component ) |
@@ -197,7 +197,7 @@ discard block |
||
197 | 197 | /** |
198 | 198 | * Filter the component's value using its filter function (if applicable) |
199 | 199 | * |
200 | - * @param UI\AbstractComponent $component |
|
200 | + * @param ValueComponentInterface $component |
|
201 | 201 | */ |
202 | 202 | private function filter( $component ) |
203 | 203 | { |
@@ -219,7 +219,7 @@ discard block |
||
219 | 219 | * If the value is invalid, the old value is used, and an error message is |
220 | 220 | * saved into the errors array as component_name => error_message. |
221 | 221 | * |
222 | - * @param UI\AbstractComponent $component The component to validate. |
|
222 | + * @param ValueComponentInterface $component The component to validate. |
|
223 | 223 | */ |
224 | 224 | private function validate( $component ) |
225 | 225 | { |
@@ -59,7 +59,7 @@ discard block |
||
59 | 59 | * |
60 | 60 | * @param array $components An array of arrays of component arguments |
61 | 61 | */ |
62 | - public function __construct( array $components = array() ) |
|
62 | + public function __construct(array $components = array()) |
|
63 | 63 | { |
64 | 64 | $this->add_components($components); |
65 | 65 | } |
@@ -81,18 +81,18 @@ discard block |
||
81 | 81 | * |
82 | 82 | * @return array The updated values array. |
83 | 83 | */ |
84 | - public function update( array $new_instance = array(), array $old_instance = array() ) |
|
84 | + public function update(array $new_instance = array(), array $old_instance = array()) |
|
85 | 85 | { |
86 | - $this->old_instance = array_merge($this->get_defaults(),$old_instance); |
|
87 | - $this->new_instance = array_merge($this->old_instance,$new_instance); |
|
86 | + $this->old_instance = array_merge($this->get_defaults(), $old_instance); |
|
87 | + $this->new_instance = array_merge($this->old_instance, $new_instance); |
|
88 | 88 | $this->final_instance = $this->new_instance; |
89 | 89 | |
90 | - foreach ( $this->components as $component ) |
|
90 | + foreach ($this->components as $component) |
|
91 | 91 | { |
92 | 92 | // Update individual fields, as well as the composite parent field. |
93 | - if ( $component instanceof ValueComponentInterface ) |
|
93 | + if ($component instanceof ValueComponentInterface) |
|
94 | 94 | { |
95 | - $this->update_component( $component ); |
|
95 | + $this->update_component($component); |
|
96 | 96 | } |
97 | 97 | } |
98 | 98 | |
@@ -106,7 +106,7 @@ discard block |
||
106 | 106 | */ |
107 | 107 | public function reset() |
108 | 108 | { |
109 | - foreach( $this->components as $c ) |
|
109 | + foreach ($this->components as $c) |
|
110 | 110 | { |
111 | 111 | $c->value = $c->default; |
112 | 112 | $this->final_instance[$c->name] = $c->default; |
@@ -131,10 +131,10 @@ discard block |
||
131 | 131 | * @param array $args The component arguments |
132 | 132 | * @throws \RuntimeException If a component with the same name has already been registered |
133 | 133 | */ |
134 | - public function add_component( array $args ) |
|
134 | + public function add_component(array $args) |
|
135 | 135 | { |
136 | 136 | $name = $args['name']; |
137 | - if(array_key_exists($name, $this->components)) |
|
137 | + if (array_key_exists($name, $this->components)) |
|
138 | 138 | { |
139 | 139 | throw new \RuntimeException("A component with the name <b>$name</b> has already been created"); |
140 | 140 | } |
@@ -146,9 +146,9 @@ discard block |
||
146 | 146 | * |
147 | 147 | * @param array $components |
148 | 148 | */ |
149 | - public function add_components( array $components ) |
|
149 | + public function add_components(array $components) |
|
150 | 150 | { |
151 | - foreach( $components as $component ) |
|
151 | + foreach ($components as $component) |
|
152 | 152 | { |
153 | 153 | $this->add_component($component); |
154 | 154 | } |
@@ -160,7 +160,7 @@ discard block |
||
160 | 160 | * @param string $name |
161 | 161 | * @return UI\AbstractComponent |
162 | 162 | */ |
163 | - public function get_component( $name ) |
|
163 | + public function get_component($name) |
|
164 | 164 | { |
165 | 165 | return $this->components[$name]; |
166 | 166 | } |
@@ -182,21 +182,21 @@ discard block |
||
182 | 182 | * |
183 | 183 | * @param ValueComponentInterface $component The component to validate. |
184 | 184 | */ |
185 | - private function update_component( ValueComponentInterface $component ) |
|
185 | + private function update_component(ValueComponentInterface $component) |
|
186 | 186 | { |
187 | 187 | $component->value = $this->final_instance[$component->name]; |
188 | 188 | |
189 | 189 | // Skip if this field is disabled |
190 | - if( $this->is_disabled($component) ) |
|
190 | + if ($this->is_disabled($component)) |
|
191 | 191 | { |
192 | 192 | return; |
193 | 193 | } |
194 | 194 | |
195 | 195 | // Apply user-defined filter |
196 | - $this->filter( $component ); |
|
196 | + $this->filter($component); |
|
197 | 197 | |
198 | 198 | // Validate value |
199 | - $this->validate( $component ); |
|
199 | + $this->validate($component); |
|
200 | 200 | } |
201 | 201 | |
202 | 202 | /** |
@@ -205,7 +205,7 @@ discard block |
||
205 | 205 | * @param UI\AbstractComponent $component |
206 | 206 | * @return boolean |
207 | 207 | */ |
208 | - private function is_disabled( $component ) |
|
208 | + private function is_disabled($component) |
|
209 | 209 | { |
210 | 210 | return |
211 | 211 | $component instanceof DisableableComponentInterface && |
@@ -220,13 +220,13 @@ discard block |
||
220 | 220 | * |
221 | 221 | * @param UI\AbstractComponent $component |
222 | 222 | */ |
223 | - private function filter( $component ) |
|
223 | + private function filter($component) |
|
224 | 224 | { |
225 | - if( $component instanceof FilterableComponentInterface ) |
|
225 | + if ($component instanceof FilterableComponentInterface) |
|
226 | 226 | { |
227 | 227 | $filter = $component->filter; |
228 | 228 | |
229 | - if( is_callable( $filter ) ) |
|
229 | + if (is_callable($filter)) |
|
230 | 230 | { |
231 | 231 | $component->value = \call_user_func_array($filter, array($this->final_instance[$component->name])); |
232 | 232 | $this->final_instance[$component->name] = $component->value; |
@@ -242,22 +242,22 @@ discard block |
||
242 | 242 | * |
243 | 243 | * @param UI\AbstractComponent $component The component to validate. |
244 | 244 | */ |
245 | - private function validate( $component ) |
|
245 | + private function validate($component) |
|
246 | 246 | { |
247 | - if( !($component instanceof ValidatableComponentInterface) ) return; |
|
247 | + if (!($component instanceof ValidatableComponentInterface)) return; |
|
248 | 248 | |
249 | 249 | $name = $component->name; |
250 | 250 | $validate = $component->validation; |
251 | 251 | |
252 | 252 | $component->validity = $component::VALID; |
253 | 253 | |
254 | - if(is_callable($validate)) |
|
254 | + if (is_callable($validate)) |
|
255 | 255 | { |
256 | 256 | $error = ''; |
257 | 257 | $valid = \call_user_func_array($validate, array($this->final_instance[$name], &$error)); |
258 | 258 | |
259 | 259 | // Invalid input, use old instance or default value |
260 | - if ( true !== $valid ) |
|
260 | + if (true !== $valid) |
|
261 | 261 | { |
262 | 262 | $this->errors[$name] = $error ? $error : ValidatableComponentInterface::DEFAULT_MESSAGE; |
263 | 263 | $component->value = $this->old_instance[$name]; |
@@ -276,7 +276,7 @@ discard block |
||
276 | 276 | { |
277 | 277 | $defaults = array(); |
278 | 278 | |
279 | - foreach( $this->components as $component ) |
|
279 | + foreach ($this->components as $component) |
|
280 | 280 | { |
281 | 281 | $defaults[$component->name] = $component->default; |
282 | 282 | } |
@@ -8,9 +8,9 @@ |
||
8 | 8 | class Component_textarea |
9 | 9 | extends AbstractComponent |
10 | 10 | implements ValueComponentInterface, |
11 | - DisableableComponentInterface, |
|
12 | - FilterableComponentInterface, |
|
13 | - ValidatableComponentInterface |
|
11 | + DisableableComponentInterface, |
|
12 | + FilterableComponentInterface, |
|
13 | + ValidatableComponentInterface |
|
14 | 14 | { |
15 | 15 | public function default_model() |
16 | 16 | { |