amarkal / amarkal-ui

components/select/controller.php

Spacing +1 added lines, -1 removed lines

@@ -21,7 +21,7 @@
     
     public function required_arguments()
     {
-        return array('name','data');
+        return array('name', 'data');
     }
     
     public function get_template_path() 

Indentation +1 added lines, -1 removed lines

@@ -8,7 +8,7 @@
 class Component_select
 extends AbstractComponent
 implements ValueComponentInterface, 
-           DisableableComponentInterface
+            DisableableComponentInterface
 {
     public $component_type = 'select';
     

functions.php

Braces +3 added lines, -1 removed lines

@@ -17,7 +17,9 @@
 /**
  * Prevent loading the library more than once
  */
-if( defined( 'AMARKAL_UI' ) ) return false;
+if( defined( 'AMARKAL_UI' ) ) {
+    return false;
+}
 define( 'AMARKAL_UI', true );
 
 if(!function_exists('amarkal_ui_render'))

Spacing +14 added lines, -14 removed lines

@@ -12,15 +12,15 @@ 
  */
 
 // Prevent direct file access
-defined( 'ABSPATH' ) or die( 'No script kiddies please!' );
+defined('ABSPATH') or die('No script kiddies please!');
 
 /**
  * Prevent loading the library more than once
  */
-if( defined( 'AMARKAL_UI' ) ) return false;
-define( 'AMARKAL_UI', true );
+if (defined('AMARKAL_UI')) return false;
+define('AMARKAL_UI', true);
 
-if(!function_exists('amarkal_ui_render'))
+if (!function_exists('amarkal_ui_render'))
 {
     /**
      * Render a UI component.
@@ -30,14 +30,14 @@ 
      * @param array $props The component's properties
      * @return string The rendered HTML
      */
-    function amarkal_ui_render( $type, array $props = array() )
+    function amarkal_ui_render($type, array $props = array())
     {
-        $component = Amarkal\UI\ComponentFactory::create( $type, $props );
+        $component = Amarkal\UI\ComponentFactory::create($type, $props);
         return $component->render();
     }
 }
 
-if(!function_exists('amarkal_ui_register_component'))
+if (!function_exists('amarkal_ui_register_component'))
 {
     /**
      * Register a custom UI component. The registered component's class should
@@ -47,13 +47,13 @@ 
      * to one of the core component's type, it will override the core component.
      * @param string $class_name The component's class name.
      */
-    function amarkal_ui_register_component( $type, $class_name )
+    function amarkal_ui_register_component($type, $class_name)
     {
-        Amarkal\UI\ComponentFactory::register( $type, $class_name );
+        Amarkal\UI\ComponentFactory::register($type, $class_name);
     }
 }
 
-if(!function_exists('amarkal_ui_register_scripts'))
+if (!function_exists('amarkal_ui_register_scripts'))
 {
     /**
      * Register Amarkal UI styles & scripts. These scripts are later enqueued by
@@ -61,9 +61,9 @@ 
      */
     function amarkal_ui_register_scripts()
     {
-        \wp_register_script('amarkal-ui',Amarkal\Core\Utility::path_to_url(__DIR__.'/assets/js/dist/amarkal-ui.min.js'),array('jquery'),false,true);
-        \wp_register_script('ace-editor','https://cdnjs.cloudflare.com/ajax/libs/ace/1.2.8/ace.js',array('jquery'),false,true);
-        \wp_register_style('amarkal-ui',Amarkal\Core\Utility::path_to_url(__DIR__.'/assets/css/dist/amarkal-ui.min.css'),array());
+        \wp_register_script('amarkal-ui', Amarkal\Core\Utility::path_to_url(__DIR__.'/assets/js/dist/amarkal-ui.min.js'), array('jquery'), false, true);
+        \wp_register_script('ace-editor', 'https://cdnjs.cloudflare.com/ajax/libs/ace/1.2.8/ace.js', array('jquery'), false, true);
+        \wp_register_style('amarkal-ui', Amarkal\Core\Utility::path_to_url(__DIR__.'/assets/css/dist/amarkal-ui.min.css'), array());
     }
-    \add_action('admin_init','amarkal_ui_register_scripts');
+    \add_action('admin_init', 'amarkal_ui_register_scripts');
 }
\ No newline at end of file

composer.php

Spacing +1 added lines, -1 removed lines

@@ -6,7 +6,7 @@
  */
 
 // Prevent direct file access
-defined( 'ABSPATH' ) or die( 'No script kiddies please!' );
+defined('ABSPATH') or die('No script kiddies please!');
 
 // Load module functions
 require_once 'functions.php';
\ No newline at end of file

ComponentFactory.php

Doc Comments +4 added lines, -4 removed lines

@@ -52,8 +52,8 @@ 
     
     /**
      * 
-     * @param type $type
-     * @param type $props
+     * @param string $type
+     * @param type string
      * @throws \RuntimeException
      */
     private static function create_core_component( $type, $props )
@@ -79,8 +79,8 @@ 
     
     /**
      * 
-     * @param type $type
-     * @param type $props
+     * @param string $type
+     * @param type string
      * @throws \RuntimeException
      */
     private static function create_registered_component( $type, $props )

Spacing +8 added lines, -8 removed lines

@@ -20,7 +20,7 @@ 
      * @param array $props
      * @return AbstractComponent
      */
-    public static function create( $type, array $props )
+    public static function create($type, array $props)
     {
         try {
             $component = self::create_registered_component($type, $props);
@@ -41,9 +41,9 @@ 
      * @param string $class_name
      * @throws \RuntimeException
      */
-    public static function register( $type, $class_name )
+    public static function register($type, $class_name)
     {
-        if( !in_array($type, self::$registered_components) )
+        if (!in_array($type, self::$registered_components))
         {
             self::$registered_components[$type] = $class_name;
         }
@@ -56,15 +56,15 @@ 
      * @param type $props
      * @throws \RuntimeException
      */
-    private static function create_core_component( $type, $props )
+    private static function create_core_component($type, $props)
     {
         $file_name  = __DIR__."/components/$type/controller.php";
         $class_name = 'Amarkal\\UI\\Component_'.$type;
         
         // Load one of the core components
-        if(!class_exists($class_name))
+        if (!class_exists($class_name))
         {
-            if( file_exists( $file_name ) ) 
+            if (file_exists($file_name)) 
             {
                 require_once $file_name;
             }
@@ -83,9 +83,9 @@ 
      * @param type $props
      * @throws \RuntimeException
      */
-    private static function create_registered_component( $type, $props )
+    private static function create_registered_component($type, $props)
     {
-        if(in_array($type, self::$registered_components))
+        if (in_array($type, self::$registered_components))
         {
             $class_name = self::$registered_components[$type];
             return new $class_name($props);

Braces +3 added lines, -3 removed lines

@@ -46,8 +46,9 @@ 
         if( !in_array($type, self::$registered_components) )
         {
             self::$registered_components[$type] = $class_name;
+        } else {
+            throw new \RuntimeException("A component of type '$type' has already been registered.");
         }
-        else throw new \RuntimeException("A component of type '$type' has already been registered.");
     }
     
     /**
@@ -67,8 +68,7 @@ 
             if( file_exists( $file_name ) ) 
             {
                 require_once $file_name;
-            }
-            else 
+            } else 
             {
                 throw new \RuntimeException("A component of type '$type' does not exist.");
             }

Form.php

Braces +3 added lines, -1 removed lines

@@ -202,7 +202,9 @@
      */
     private function validate( $component )
     {
-        if( !($component instanceof ValidatableComponentInterface) ) return;
+        if( !($component instanceof ValidatableComponentInterface) ) {
+            return;
+        }
         
         $name     = $component->name;
         $validate = $component->validation;

Doc Comments +4 added lines, -4 removed lines

@@ -129,7 +129,7 @@ 
     /**
      * Get all components.
      * 
-     * @return array
+     * @return AbstractComponent[]
      */
     public function get_component_list()
     {
@@ -163,7 +163,7 @@ 
     /**
      * Check if the given component is disabled.
      * 
-     * @param UI\AbstractComponent $component
+     * @param ValueComponentInterface $component
      * @return boolean
      */
     private function is_disabled( $component )
@@ -179,7 +179,7 @@ 
     /**
      * Filter the component's value using its filter function (if applicable)
      * 
-     * @param UI\AbstractComponent $component
+     * @param ValueComponentInterface $component
      */
     private function filter( $component )
     {
@@ -201,7 +201,7 @@ 
      * If the value is invalid, the old value is used, and an error message is
      * saved into the errors array as component_name => error_message.
      * 
-     * @param UI\AbstractComponent $component The component to validate.
+     * @param ValueComponentInterface $component The component to validate.
      */
     private function validate( $component )
     {

Spacing +23 added lines, -23 removed lines

@@ -59,9 +59,9 @@ 
      * 
      * @param ComponentList $component_list
      */
-    public function __construct( ComponentList $component_list = null )
+    public function __construct(ComponentList $component_list = null)
     {
-        if(null === $component_list)
+        if (null === $component_list)
         {
             $component_list = new ComponentList();
         }
@@ -85,16 +85,16 @@ 
      * 
      * @return array The updated values array.
      */
-    public function update( array $new_instance = array(), array $old_instance = array() )
+    public function update(array $new_instance = array(), array $old_instance = array())
     {
-        $this->old_instance   = array_merge($this->get_defaults(),$old_instance);
-        $this->new_instance   = array_merge($this->old_instance,$new_instance);
+        $this->old_instance   = array_merge($this->get_defaults(), $old_instance);
+        $this->new_instance   = array_merge($this->old_instance, $new_instance);
         $this->final_instance = $this->new_instance;
         
-        foreach ( $this->component_list->get_value_components() as $component ) 
+        foreach ($this->component_list->get_value_components() as $component) 
         {
             // Update individual fields, as well as the composite parent field.
-            $this->update_component( $component );
+            $this->update_component($component);
         }
         
         return $this->final_instance;
@@ -118,9 +118,9 @@ 
      * @param array $components
      * @return void
      */
-    public function reset_components( array $components )
+    public function reset_components(array $components)
     {
-        foreach( $components as $component )
+        foreach ($components as $component)
         {
             $this->reset_component($component);
         }
@@ -133,7 +133,7 @@ 
      * @param AbstractComponent $component
      * @return void
      */
-    public function reset_component( $component )
+    public function reset_component($component)
     {
         $component->value = $component->default;
         $this->final_instance[$component->name] = $component->default;
@@ -168,21 +168,21 @@ 
      * 
      * @param ValueComponentInterface $component The component to validate.
      */
-    private function update_component( ValueComponentInterface $component )
+    private function update_component(ValueComponentInterface $component)
     {
         $component->value = $this->final_instance[$component->name];
         
         // Skip if this field is disabled
-        if( $this->is_disabled($component) )
+        if ($this->is_disabled($component))
         {
             return;
         }
 
         // Apply user-defined filter
-        $this->filter( $component );
+        $this->filter($component);
         
         // Validate value
-        $this->validate( $component );
+        $this->validate($component);
     }
     
     /**
@@ -191,7 +191,7 @@ 
      * @param UI\AbstractComponent $component
      * @return boolean
      */
-    private function is_disabled( $component )
+    private function is_disabled($component)
     {
         return 
             $component instanceof DisableableComponentInterface &&
@@ -206,13 +206,13 @@ 
      * 
      * @param UI\AbstractComponent $component
      */
-    private function filter( $component )
+    private function filter($component)
     {
-        if( $component instanceof FilterableComponentInterface )
+        if ($component instanceof FilterableComponentInterface)
         {
             $filter = $component->filter;
 
-            if( is_callable( $filter ) ) 
+            if (is_callable($filter)) 
             {
                 $component->value = \call_user_func_array($filter, array($this->final_instance[$component->name]));
                 $this->final_instance[$component->name] = $component->value;
@@ -228,22 +228,22 @@ 
      * 
      * @param UI\AbstractComponent $component The component to validate.
      */
-    private function validate( $component )
+    private function validate($component)
     {
-        if( !($component instanceof ValidatableComponentInterface) ) return;
+        if (!($component instanceof ValidatableComponentInterface)) return;
         
         $name     = $component->name;
         $validate = $component->validation;
         
         $component->validity = $component::VALID;
         
-        if(is_callable($validate))
+        if (is_callable($validate))
         {
             $error = '';
             $valid = \call_user_func_array($validate, array($this->final_instance[$name], &$error));
             
             // Invalid input, use old instance or default value
-            if ( true !== $valid ) 
+            if (true !== $valid) 
             {
                 $this->errors[$name]         = $error ? $error : ValidatableComponentInterface::DEFAULT_MESSAGE;
                 $component->value            = $this->old_instance[$name];
@@ -262,7 +262,7 @@ 
     {
         $defaults = array();
         
-        foreach( $this->component_list->get_value_components() as $component )
+        foreach ($this->component_list->get_value_components() as $component)
         {
             $defaults[$component->name] = $component->default;
         }

Template.php

Braces +1 added lines, -2 removed lines

@@ -90,8 +90,7 @@
             ob_start();
             include( $this->get_template_path() );
             $rendered_html = ob_get_clean();
-        } 
-        else 
+        } else 
         {
             throw new \RuntimeException( "Error: cannot render HTML, template file not found at " . $this->get_template_path() );
         }

Spacing +12 added lines, -12 removed lines

@@ -25,9 +25,9 @@ 
      * @param array $model
      * @param string $template_path
      */
-    public function __construct( array $model = array(), $template_path = null ) 
+    public function __construct(array $model = array(), $template_path = null) 
     {
-        $this->set_model( $model );
+        $this->set_model($model);
         $this->template = $template_path;
     }
     
@@ -38,9 +38,9 @@ 
      * 
      * @return mixed the argument's value.
      */
-    public function __get( $name ) 
+    public function __get($name) 
     {
-        if( isset( $this->model[$name] ) )
+        if (isset($this->model[$name]))
         {
             return $this->model[$name];
         }
@@ -54,7 +54,7 @@ 
      * 
      * @return mixed the settings' argument value.
      */
-    public function __set( $name, $value )
+    public function __set($name, $value)
     {
         $this->model[$name] = $value;
     }
@@ -65,7 +65,7 @@ 
      * @param string $name The argument's name.
      * @return boolean Whether this arguments exists or not.
      */
-    public function __isset( $name )
+    public function __isset($name)
     {
         return isset($this->model[$name]);
     }
@@ -85,7 +85,7 @@ 
      * 
      * @return array
      */
-    public function set_model( $model )
+    public function set_model($model)
     {
         $this->model = $model;
     }
@@ -106,22 +106,22 @@ 
      * @return string The rendered template.
      * @throws TemplateNotFoundException Thrown if the template file cannot be found.
      */
-    public function render( $echo = false )
+    public function render($echo = false)
     {
         $rendered_html = '';
         
-        if( file_exists( $this->get_template_path() ) ) 
+        if (file_exists($this->get_template_path())) 
         {
             ob_start();
-            include( $this->get_template_path() );
+            include($this->get_template_path());
             $rendered_html = ob_get_clean();
         } 
         else 
         {
-            throw new \RuntimeException( "Error: cannot render HTML, template file not found at " . $this->get_template_path() );
+            throw new \RuntimeException("Error: cannot render HTML, template file not found at ".$this->get_template_path());
         }
         
-        if( !$echo )
+        if (!$echo)
         {
             return $rendered_html;
         }

bootstrap.php

Spacing +2 added lines, -2 removed lines

@@ -6,13 +6,13 @@
  */
 
 // Prevent direct file access
-defined( 'ABSPATH' ) or die( 'No script kiddies please!' );
+defined('ABSPATH') or die('No script kiddies please!');
 
 /**
  * Load module functions. If this amarkal module has not been loaded, 
  * functions.php will not return false.
  */
-if(false !== (require_once 'functions.php'))
+if (false !== (require_once 'functions.php'))
 {
     // Load required classes if not using composer
     require_once 'AbstractComponent.php';

components/composite/controller.php

Doc Comments +1 added lines, -1 removed lines

@@ -123,7 +123,7 @@
     /**
      * 
      * @param type $args
-     * @return type
+     * @return AbstractComponent
      */
     private function create_component( $args )
     {

Indentation +3 added lines, -3 removed lines

@@ -8,9 +8,9 @@
 class Component_composite
 extends AbstractComponent
 implements ValueComponentInterface, 
-           DisableableComponentInterface,
-           FilterableComponentInterface,
-           ValidatableComponentInterface
+            DisableableComponentInterface,
+            FilterableComponentInterface,
+            ValidatableComponentInterface
 {
     /**
      * The list of child components.

Spacing +22 added lines, -22 removed lines

@@ -25,16 +25,16 @@ 
      * The __set magic method is overridden here to apply value & name changes to 
      * child components.
      */
-    public function __set( $name, $value )
+    public function __set($name, $value)
     {
         parent::__set($name, $value);
         
-        if( 'value' === $name )
+        if ('value' === $name)
         {
             $this->set_value($value);
         }
 
-        if( 'name' === $name )
+        if ('name' === $name)
         {
             $this->set_name($value);
         }
@@ -46,9 +46,9 @@ 
      * @param array $value
      * @return void
      */
-    public function set_value( array $value )
+    public function set_value(array $value)
     {
-        foreach($value as $n => $v)
+        foreach ($value as $n => $v)
         {
             $component = $this->get_component($n);
             $component->value = $v;
@@ -61,9 +61,9 @@ 
      * @param string $name
      * @return void
      */
-    public function set_name( $name )
+    public function set_name($name)
     {
-        foreach($this->components as $c)
+        foreach ($this->components as $c)
         {
             $c->name_template = str_replace('{{parent_name}}', $this->get_name(), $c->composite_name_template);
         }
@@ -91,7 +91,7 @@ 
      */
     public function required_arguments()
     {
-        return array('name','components','template');
+        return array('name', 'components', 'template');
     }
     
     /**
@@ -109,7 +109,7 @@ 
      */
     public function parse_template()
     {
-        return preg_replace_callback('/\{\{([a-zA-Z\d-_]+)\}\}/', function($a){
+        return preg_replace_callback('/\{\{([a-zA-Z\d-_]+)\}\}/', function($a) {
             $component = $this->get_component($a[1]);
             return $component->render();
         }, $this->model['template']);
@@ -124,7 +124,7 @@ 
      */
     public function get_name()
     {
-        if('' !== $this->parent_name)
+        if ('' !== $this->parent_name)
         {
             return "{$this->parent_name}[{$this->name}]";
         }
@@ -133,9 +133,9 @@ 
 
     public function filter($v)
     {
-        foreach($this->components as $component)
+        foreach ($this->components as $component)
         {
-            if($component instanceof FilterableComponentInterface &&
+            if ($component instanceof FilterableComponentInterface &&
                \is_callable($component->filter))
             {
                 $n = $component->name;
@@ -146,15 +146,15 @@ 
         return $v;
     }
 
-    public function validation($v,&$e)
+    public function validation($v, &$e)
     {
-        foreach($this->components as $component)
+        foreach ($this->components as $component)
         {
-            if($component instanceof ValidatableComponentInterface &&
+            if ($component instanceof ValidatableComponentInterface &&
                \is_callable($component->validation))
             {
                 $n = $component->name;
-                if(!$component->validation($v[$n],$e))
+                if (!$component->validation($v[$n], $e))
                 {
                     return false;
                 }
@@ -168,7 +168,7 @@ 
      */
     protected function on_created()
     {
-        foreach( $this->model['components'] as $args )
+        foreach ($this->model['components'] as $args)
         {
             $this->components[$args['name']] = $this->create_component($args);
         }
@@ -179,16 +179,16 @@ 
      * @param type $args
      * @return type
      */
-    private function create_component( $args )
+    private function create_component($args)
     {
         $type = $args['type'];
         
-        if('composite' === $type)
+        if ('composite' === $type)
         {
             $args['parent_name'] = $this->get_name();
         }
         
-        $c = \Amarkal\UI\ComponentFactory::create( $type, $args );
+        $c = \Amarkal\UI\ComponentFactory::create($type, $args);
         
         // Apply the composite name template
         $c->name_template = str_replace('{{parent_name}}', $this->get_name(), $c->composite_name_template);
@@ -203,9 +203,9 @@ 
      * @return UI\AbstractComponent
      * @throws \RuntimeException If there's no child component corresponding to the given name
      */
-    private function get_component( $name )
+    private function get_component($name)
     {
-        if(!array_key_exists($name, $this->components))
+        if (!array_key_exists($name, $this->components))
         {
             throw new \RuntimeException("Composite sub-component not found with name $name");
         }

components/checkbox/controller.php

Indentation +1 added lines, -1 removed lines

@@ -8,7 +8,7 @@
 class Component_checkbox
 extends AbstractComponent
 implements ValueComponentInterface, 
-           DisableableComponentInterface
+            DisableableComponentInterface
 {
     public $name_template = '{{name}}[]';