amarkal / amarkal-ui

ComponentList.php

Doc Comments +1 added lines, -1 removed lines

@@ -159,7 +159,7 @@
     /**
      * Filter the list of components
      *
-     * @param function $callable
+     * @param \Closure $callable
      * @return array
      */
     private function filter( $callable )

Spacing +12 added lines, -12 removed lines

@@ -19,7 +19,7 @@ 
      *
      * @param array $components
      */
-    public function __construct( array $components = array() )
+    public function __construct(array $components = array())
     {
         $this->add_components($components);
     }
@@ -30,12 +30,12 @@ 
      * @param string $name
      * @return AbstractComponent
      */
-    public function get_by_name( $name )
+    public function get_by_name($name)
     {
         $filtered = $this->filter(function($c) use ($name) {
             return $c instanceof ValueComponentInterface && $c->name === $name;
         });
-        if(count($filtered) < 1)
+        if (count($filtered) < 1)
         {
             throw new \RuntimeException("No component with the name <b>$name</b> could be found.");
         }
@@ -48,7 +48,7 @@ 
      * @param string $type
      * @return AbstractComponent[]
      */
-    public function get_by_type( $type )
+    public function get_by_type($type)
     {
         return $this->filter(function($c) use ($type) {
             return $c->component_type === $type;
@@ -107,9 +107,9 @@ 
      * @param AbstractComponent[] $components
      * @return void
      */
-    public function add_components( array $components )
+    public function add_components(array $components)
     {
-        foreach( $components as $component )
+        foreach ($components as $component)
         {
             $this->add_component($component);
         }
@@ -121,9 +121,9 @@ 
      * @param AbstractComponent[] $args
      * @return void
      */
-    public function add_component( array $args )
+    public function add_component(array $args)
     {
-        if(!array_key_exists('type', $args))
+        if (!array_key_exists('type', $args))
         {
             throw new \RuntimeException("Component configuration arrays must have a <b>type</b> argument");
         }
@@ -140,16 +140,16 @@ 
      * @param AbstractComponent $comp
      * @return void
      */
-    private function verify_name_uniqueness( AbstractComponent $comp )
+    private function verify_name_uniqueness(AbstractComponent $comp)
     {
-        if(!($comp instanceof ValueComponentInterface))
+        if (!($comp instanceof ValueComponentInterface))
         {
             return;
         }
 
         foreach ($this->components as $c) 
         {
-            if($c->name === $comp->name)
+            if ($c->name === $comp->name)
             {
                 throw new \RuntimeException("Duplicate component name detected for the name <b>{$c->name}</b>.");
             }
@@ -162,7 +162,7 @@ 
      * @param function $callable
      * @return array
      */
-    private function filter( $callable )
+    private function filter($callable)
     {
         return array_filter($this->components, $callable);
     }

Form.php

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 +21 added lines, -21 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;
@@ -107,7 +107,7 @@ 
      */
     public function reset()
     {
-        foreach( $this->component_list->get_value_components() as $c )
+        foreach ($this->component_list->get_value_components() as $c)
         {
             $c->value = $c->default;
             $this->final_instance[$c->name] = $c->default;
@@ -143,21 +143,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);
     }
     
     /**
@@ -166,7 +166,7 @@ 
      * @param UI\AbstractComponent $component
      * @return boolean
      */
-    private function is_disabled( $component )
+    private function is_disabled($component)
     {
         return 
             $component instanceof DisableableComponentInterface &&
@@ -181,13 +181,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;
@@ -203,22 +203,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];
@@ -237,7 +237,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;
         }

AbstractComponent.php

Spacing +16 added lines, -16 removed lines

@@ -38,7 +38,7 @@ 
      * 
      * @param array $model
      */
-    public function __construct( array $model = array() ) 
+    public function __construct(array $model = array()) 
     {
         parent::__construct($model);
         
@@ -79,24 +79,24 @@ 
      * 
      * @return array
      */
-    public function set_model( $model )
+    public function set_model($model)
     {
         // Check that the required arguments are provided.
-        foreach( $this->required_arguments() as $key )
+        foreach ($this->required_arguments() as $key)
         {
-            if ( !isset($model[$key]) )
+            if (!isset($model[$key]))
             {
                 throw new \RuntimeException('The required argument "'.$key.'" was not provided for '.get_called_class());
             }
         }
         
         // Assign the name of the component as the id if no id was specified
-        if( !isset($model['id']) && isset($model['name']) )
+        if (!isset($model['id']) && isset($model['name']))
         {
             $model['id'] = $model['name'];
         }
         
-        $this->model = array_merge( $this->default_model(), $model );
+        $this->model = array_merge($this->default_model(), $model);
     }
     
     /**
@@ -115,9 +115,9 @@ 
      * 
      * @param string $class
      */
-    public function add_html_class( $class )
+    public function add_html_class($class)
     {
-        if( !in_array($class, $this->html_classes) )
+        if (!in_array($class, $this->html_classes))
         {
             $this->html_classes[] = $class;
         }
@@ -129,14 +129,14 @@ 
      * 
      * @param string $class
      */
-    public function remove_html_class( $class )
+    public function remove_html_class($class)
     {
         $i = 0;
-        foreach( $this->html_classes as $c )
+        foreach ($this->html_classes as $c)
         {
-            if( $c === $class )
+            if ($c === $class)
             {
-                array_splice($this->html_classes,$i,1);
+                array_splice($this->html_classes, $i, 1);
                 break;
             }
             $i++;
@@ -148,10 +148,10 @@ 
      * 
      * @param type $validity
      */
-    Public function set_validity( $validity )
+    Public function set_validity($validity)
     {
         $this->validity = $validity;
-        if($validity === $this::INVALID)
+        if ($validity === $this::INVALID)
         {
             $this->add_html_class('amarkal-ui-component-error');
         }
@@ -174,7 +174,7 @@ 
      * 
      * {@inheritdoc}
      */
-    public function render( $echo = false )
+    public function render($echo = false)
     {
         $this->enqueue_scripts();
         
@@ -182,7 +182,7 @@ 
         include dirname(__FILE__).'/AbstractComponent.phtml';
         $html = ob_get_clean();
 
-        if( !$echo )
+        if (!$echo)
         {
             return $html;
         }