Form::is_disabled() - Code Metrics - Inspection of "Improved code quality and comments" - amarkal/amarkal-ui - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bcd23f...ead358 )

by Askupa

created 2017-04-07 21:57 UTC

Form::is_disabled() A

↳ Parent: Form

Complexity

Conditions	3
Paths	3

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	5
nc	3
nop	1
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0

<?php

namespace Amarkal\UI;

/**
 * Implements a Form controller.
 * 
 * The form object is used to encapsulate UI components and the update/validation 
 * process into a single entity.
 */
class Form
{
    /**
     * The list of AbstractComponent type objects to be updated.
     * 
     * @var AbstractComponent[] objects array.
     */
    private $components;
    
    /**
     * The old component values array. These values are used if the new values
     * are invalid.
     * Structure: component_name => component_value
     * 
     * @var array Old values array.
     */
    private $old_instance;
    
    /**
     * The new component values array.
     * Structure: component_name => component_value
     * 
     * @var array New values array.
     */
    private $new_instance;
    
    /**
     * The final values array, after filtering and validation.
     * This is returned by the update function.
     * Structure: component_name => component_value
     * 
     * @var array Final values array. 
     */
    private $final_instance = array();
    
    /**
     * Array of names of components that were invalid, and the error message 
     * recieved.
     * Structure: component_name => error_message
     * 
     * @var string[] Array of error messages. 
     */
    private $errors = array();
    
    /**
     * When instantiating a form, a list of component arguments arrays must be 
     * provided. Each arguments array must have a 'type' argument, in addition 
     * to the component's original arguments.
     * 
     * @param array $components An array of arrays of component arguments
     */
    public function __construct( array $components = array() )
    {
        foreach( $components as $args )
        {
            $name = $args['name'];
            if(array_key_exists($name, $components))
            {
                throw new \RuntimeException("A component with the name <b>$name</b> has already been created");
            }
            $this->components[$name] = ComponentFactory::create($args['type'], $args);
        }
    }
    
    /**
     * Get the updated component values (validated, filtered or ignored).
     * 
     * Loops through each component and acts according to its type:
     * - Disableable components are ignored if they are disabled.
     * - Validatable components are validated using their validation function. 
     *   If the new value is invalid, the old value will be used.
     * - Filterable components are filtered using their filter function.
     * - Non-value components are skipped altogether.
     * 
     * Each component is also set with its new value.
     * 
     * @param array $new_instance The new component values array.
     * @param array $old_instance The old component values array.
     * 
     * @return array The updated values array.
     */
    public function update( array $new_instance, 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->final_instance = $this->new_instance;
        
        foreach ( $this->components as $component ) 
        {
            // Update individual fields, as well as the composite parent field.
            if ( $component instanceof ValueComponentInterface )
            {
                $this->update_component( $component );
            }
        }
        
        return $this->final_instance;
    }
    
    /**
     * Reset all fields to their default values.
     * 
     * @return array The updated values array.
     */
    public function reset()
    {
        foreach( $this->components as $c )
        {
            $c->value = $c->default;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->final_instance[$c->name] = $c->default;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
        return $this->final_instance;
    }
    
    /**
     * Get the list of error messages for components that could not be validated.
     * Structure: components_name => error_message
     * 
     * @return string[] Array of error messages. 
     */
    public function get_errors()
    {
        return $this->errors;
    }
    
    /**
     * Update the component's value with the new value.
     * NOTE: this function also updates the $final_instance
     * array.
     * 
     * @param ValueComponentInterface $component The component to validate.
     */
    private function update_component( ValueComponentInterface $component )
    {
        $component->value = $this->final_instance[$component->name];
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        
        // Skip if this field is disabled
        if( $this->is_disabled($component) )
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        {
            return;
        }
        
        // Apply user-defined filter
        $this->filter( $component );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        
        // Validate value
        $this->validate( $component );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }
    
    /**
     * Check if the given component is disabled.
     * 
     * @param UI\AbstractComponent $component
     * @return boolean
     */
    private function is_disabled( $component )
    {
        return 
            $component instanceof DisableableComponentInterface &&
            (
                true === $component->disabled ||
                true === $component->readonly
            );
    }
    
    /**
     * Filter the component's value using its filter function (if applicable)
     * 
     * @param UI\AbstractComponent $component
     */
    private function filter( $component )
    {
        if( $component instanceof FilterableComponentInterface )
        {
            $filter = $component->filter;

            if( is_callable( $filter ) ) 
            {
                $component->value = $filter( $this->final_instance[$component->name] );
                $this->final_instance[$component->name] = $component->value;
            }
        }
    }
    
    /**
     * Validate the component's value using its validation function.
     * 
     * 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.
     */
    private function validate( $component )
    {
        if( !($component instanceof ValidatableComponentInterface) ) return;
        
        $name     = $component->name;
        $validate = $component->validation;
        $valid    = true;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        
        $component->validity = $component::VALID;
        
        if(is_callable($validate))
        {
            $valid = $validate($this->new_instance[$name]);
            
            // Invalid input, use old instance or default value
            if ( true !== $valid ) 
            {
                $this->errors[$name]         = $valid;
                $component->value            = $this->old_instance[$name];
                $component->validity         = $component::INVALID;
                $this->final_instance[$name] = $this->old_instance[$name];
            }
        }
    }
    
    /**
     * Get the default values for all form components as an array of name => default_value
     * 
     * @return array
     */
    private function get_defaults()
    {
        $defaults = array();
        
        foreach( $this->components as $component )
        {
            $defaults[$component->name] = $component->default;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
        
        return $defaults;
    }
}

Push — master ( bcd23f...ead358 )

Form::is_disabled() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2
3			namespace Amarkal\UI;
4
5			/**
6			* Implements a Form controller.
7			*
8			* The form object is used to encapsulate UI components and the update/validation
9			* process into a single entity.
10			*/
11			class Form
12			{
13			/**
14			* The list of AbstractComponent type objects to be updated.
15			*
16			* @var AbstractComponent[] objects array.
17			*/
18			private $components;
19
20			/**
21			* The old component values array. These values are used if the new values
22			* are invalid.
23			* Structure: component_name => component_value
24			*
25			* @var array Old values array.
26			*/
27			private $old_instance;
28
29			/**
30			* The new component values array.
31			* Structure: component_name => component_value
32			*
33			* @var array New values array.
34			*/
35			private $new_instance;
36
37			/**
38			* The final values array, after filtering and validation.
39			* This is returned by the update function.
40			* Structure: component_name => component_value
41			*
42			* @var array Final values array.
43			*/
44			private $final_instance = array();
45
46			/**
47			* Array of names of components that were invalid, and the error message
48			* recieved.
49			* Structure: component_name => error_message
50			*
51			* @var string[] Array of error messages.
52			*/
53			private $errors = array();
54
55			/**
56			* When instantiating a form, a list of component arguments arrays must be
57			* provided. Each arguments array must have a 'type' argument, in addition
58			* to the component's original arguments.
59			*
60			* @param array $components An array of arrays of component arguments
61			*/
62			public function __construct( array $components = array() )
63			{
64			foreach( $components as $args )
65			{
66			$name = $args['name'];
67			if(array_key_exists($name, $components))
68			{
69			throw new \RuntimeException("A component with the name <b>$name</b> has already been created");
70			}
71			$this->components[$name] = ComponentFactory::create($args['type'], $args);
72			}
73			}
74
75			/**
76			* Get the updated component values (validated, filtered or ignored).
77			*
78			* Loops through each component and acts according to its type:
79			* - Disableable components are ignored if they are disabled.
80			* - Validatable components are validated using their validation function.
81			* If the new value is invalid, the old value will be used.
82			* - Filterable components are filtered using their filter function.
83			* - Non-value components are skipped altogether.
84			*
85			* Each component is also set with its new value.
86			*
87			* @param array $new_instance The new component values array.
88			* @param array $old_instance The old component values array.
89			*
90			* @return array The updated values array.
91			*/
92			public function update( array $new_instance, array $old_instance = array() )
93			{
94			$this->old_instance = array_merge($this->get_defaults(),$old_instance);
95			$this->new_instance = array_merge($this->old_instance,$new_instance);
96			$this->final_instance = $this->new_instance;
97
98			foreach ( $this->components as $component )
99			{
100			// Update individual fields, as well as the composite parent field.
101			if ( $component instanceof ValueComponentInterface )
102			{
103			$this->update_component( $component );
104			}
105			}
106
107			return $this->final_instance;
108			}
109
110			/**
111			* Reset all fields to their default values.
112			*
113			* @return array The updated values array.
114			*/
115			public function reset()
116			{
117			foreach( $this->components as $c )
118			{
119			$c->value = $c->default;
			0 ignored issues – show Documentation introduced 2017-04-07 21:59 UTC by Report Bug Copy Issue Report The property `value` does not exist on `object<Amarkal\UI\AbstractComponent>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text / class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Documentation introduced 2017-04-07 21:59 UTC by Report Bug Copy Issue Report The property `default` does not exist on `object<Amarkal\UI\AbstractComponent>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /* * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
120			$this->final_instance[$c->name] = $c->default;
			0 ignored issues – show Documentation introduced 2017-04-05 13:47 UTC by Report Bug Copy Issue Report The property `name` does not exist on `object<Amarkal\UI\AbstractComponent>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text / class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Documentation introduced 2017-04-05 13:47 UTC by Report Bug Copy Issue Report The property `default` does not exist on `object<Amarkal\UI\AbstractComponent>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /* * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
121			}
122			return $this->final_instance;
123			}
124
125			/**
126			* Get the list of error messages for components that could not be validated.
127			* Structure: components_name => error_message
128			*
129			* @return string[] Array of error messages.
130			*/
131			public function get_errors()
132			{
133			return $this->errors;
134			}
135
136			/**
137			* Update the component's value with the new value.
138			* NOTE: this function also updates the $final_instance
139			* array.
140			*
141			* @param ValueComponentInterface $component The component to validate.
142			*/
143			private function update_component( ValueComponentInterface $component )
144			{
145			$component->value = $this->final_instance[$component->name];
			0 ignored issues – show Bug introduced 2017-04-05 13:47 UTC by Report Bug Copy Issue Report Accessing `value` on the interface `Amarkal\UI\ValueComponentInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history... Bug introduced 2017-04-05 13:47 UTC by Report Bug Copy Issue Report Accessing `name` on the interface `Amarkal\UI\ValueComponentInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
146
147			// Skip if this field is disabled
148			if( $this->is_disabled($component) )
			0 ignored issues – show Documentation introduced 2017-04-07 21:59 UTC by Report Bug Copy Issue Report `$component` is of type `object<Amarkal\UI\ValueComponentInterface>`, but the function expects a `object<Amarkal\UI\UI\AbstractComponent>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
149			{
150			return;
151			}
152
153			// Apply user-defined filter
154			$this->filter( $component );
			0 ignored issues – show Documentation introduced 2017-04-07 21:59 UTC by Report Bug Copy Issue Report `$component` is of type `object<Amarkal\UI\ValueComponentInterface>`, but the function expects a `object<Amarkal\UI\UI\AbstractComponent>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
155
156			// Validate value
157			$this->validate( $component );
			0 ignored issues – show Documentation introduced 2017-04-07 21:59 UTC by Report Bug Copy Issue Report `$component` is of type `object<Amarkal\UI\ValueComponentInterface>`, but the function expects a `object<Amarkal\UI\UI\AbstractComponent>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
158			}
159
160			/**
161			* Check if the given component is disabled.
162			*
163			* @param UI\AbstractComponent $component
164			* @return boolean
165			*/
166			private function is_disabled( $component )
167			{
168			return
169			$component instanceof DisableableComponentInterface &&
170			(
171			true === $component->disabled \|\|
172			true === $component->readonly
173			);
174			}
175
176			/**
177			* Filter the component's value using its filter function (if applicable)
178			*
179			* @param UI\AbstractComponent $component
180			*/
181			private function filter( $component )
182			{
183			if( $component instanceof FilterableComponentInterface )
184			{
185			$filter = $component->filter;
186
187			if( is_callable( $filter ) )
188			{
189			$component->value = $filter( $this->final_instance[$component->name] );
190			$this->final_instance[$component->name] = $component->value;
191			}
192			}
193			}
194
195			/**
196			* Validate the component's value using its validation function.
197			*
198			* If the value is invalid, the old value is used, and an error message is
199			* saved into the errors array as component_name => error_message.
200			*
201			* @param UI\AbstractComponent $component The component to validate.
202			*/
203			private function validate( $component )
204			{
205			if( !($component instanceof ValidatableComponentInterface) ) return;
206
207			$name = $component->name;
208			$validate = $component->validation;
209			$valid = true;
			0 ignored issues – show Unused Code introduced 2017-04-05 13:47 UTC by Report Bug Copy Issue Report `$valid` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
210
211			$component->validity = $component::VALID;
212
213			if(is_callable($validate))
214			{
215			$valid = $validate($this->new_instance[$name]);
216
217			// Invalid input, use old instance or default value
218			if ( true !== $valid )
219			{
220			$this->errors[$name] = $valid;
221			$component->value = $this->old_instance[$name];
222			$component->validity = $component::INVALID;
223			$this->final_instance[$name] = $this->old_instance[$name];
224			}
225			}
226			}
227
228			/**
229			* Get the default values for all form components as an array of name => default_value
230			*
231			* @return array
232			*/
233			private function get_defaults()
234			{
235			$defaults = array();
236
237			foreach( $this->components as $component )
238			{
239			$defaults[$component->name] = $component->default;
			0 ignored issues – show Documentation introduced 2017-04-05 13:47 UTC by Report Bug Copy Issue Report The property `name` does not exist on `object<Amarkal\UI\AbstractComponent>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text / class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Documentation introduced 2017-04-05 13:47 UTC by Report Bug Copy Issue Report The property `default` does not exist on `object<Amarkal\UI\AbstractComponent>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /* * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
240			}
241
242			return $defaults;
243			}
244			}

amarkal / amarkal-ui

Push — master ( bcd23f...ead358 )

Form::is_disabled() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like