Component_toggle::on_created() - Code Metrics - Inspection of "Throw an exception for invalid arguments" - amarkal/amarkal-ui - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e36017...b2a81d )

by Askupa

created 2017-10-21 19:27 UTC

Component_toggle::on_created() B

↳ Parent: Component_toggle

Complexity

Conditions	5
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	4
nc	2
nop	0
dl	0
loc	8
rs	8.8571
c	0
b	0
f	0

<?php

namespace Amarkal\UI;

/**
 * Implements a Toggle UI component.
 */
class Component_toggle
extends AbstractComponent

implements ValueComponentInterface,

           FilterableComponentInterface,

           DisableableComponentInterface

{
    public $component_type = 'toggle';
    
    protected function on_created() 
    {
        if($this->multi && !\is_array($this->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->multi && \is_array($this->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.");
        }
    }

}
        {
            throw new \RuntimeException("The default value must be an array if multi is set to true, and must be a string otherwise.");
        }
    }

    public function default_model() 
    {
        return array(
            'name'          => '',
            'id'            => '',
            'disabled'      => false,
            'required'      => false,
            'readonly'      => false,
            'multi'         => false,
            'data'          => array(),
            'default'       => array(),
            'filter'        => array( $this, 'filter' )
        );
    }
    
    public function required_arguments()
    {
        return array('name','data');
    }
    
    public function get_template_path() 
    {
        return __DIR__.'/template.phtml';
    }

    /**
     * This filter is needed when the form is submitted without $.amarkalUIForm, 
     * since the value of the toggle needs to be splitted into an array (when 'multi' is set to true). 
     * When using $.amarkalUIForm to submit the form, the component's getValue/setValue will
     * handle this.
     *
     * @param [string|array] $v

     * @return [string|array]

     */
    public function filter($v)
    {
        if($this->multi && !\is_array($v)) 
<?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 \explode(',', $v);
        }
        return $v;
    }

    protected function is_selected( $value )
    {
        if($this->multi) 
<?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 \in_array($value, $this->value);
<?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 $value === $this->value;
<?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.");
        }
    }

}
    }
}

1			<?php
2
3			namespace Amarkal\UI;
4
5			/**
6			* Implements a Toggle UI component.
7			*/
8			class Component_toggle
9			extends AbstractComponent
			0 ignored issues – show Coding Style introduced 2017-04-20 18:39 UTC by Report Bug Copy Issue Report The extends keyword must be on the same line as the class name Loading history...
10			implements ValueComponentInterface,
			0 ignored issues – show Coding Style introduced 2017-04-05 13:47 UTC by Report Bug Copy Issue Report The implements keyword must be on the same line as the class name Loading history... Coding Style introduced 2017-04-10 06:30 UTC by Report Bug Copy Issue Report The first item in a multi-line implements list must be on the line following the implements keyword Loading history...
11			FilterableComponentInterface,
			0 ignored issues – show Coding Style introduced 2017-04-10 06:30 UTC by Report Bug Copy Issue Report Expected 4 spaces before interface name; 11 found Loading history...
12			DisableableComponentInterface
			0 ignored issues – show Coding Style introduced 2017-07-31 20:58 UTC by Report Bug Copy Issue Report Expected 4 spaces before interface name; 11 found Loading history...
13			{
14			public $component_type = 'toggle';
15
16			protected function on_created()
17			{
18			if($this->multi && !\is_array($this->default)
			0 ignored issues – show Documentation introduced 2017-10-21 19:28 UTC by Report Bug Copy Issue Report The property `multi` does not exist on `object<Amarkal\UI\Component_toggle>`. 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-10-21 19:28 UTC by Report Bug Copy Issue Report The property `default` does not exist on `object<Amarkal\UI\Component_toggle>`. 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...
19			\|\| !$this->multi && \is_array($this->default))
			0 ignored issues – show Documentation introduced 2017-10-21 19:28 UTC by Report Bug Copy Issue Report The property `multi` does not exist on `object<Amarkal\UI\Component_toggle>`. 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-10-21 19:28 UTC by Report Bug Copy Issue Report The property `default` does not exist on `object<Amarkal\UI\Component_toggle>`. 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...
20			{
21			throw new \RuntimeException("The default value must be an array if multi is set to true, and must be a string otherwise.");
22			}
23			}
24
25			public function default_model()
26			{
27			return array(
28			'name' => '',
29			'id' => '',
30			'disabled' => false,
31			'required' => false,
32			'readonly' => false,
33			'multi' => false,
34			'data' => array(),
35			'default' => array(),
36			'filter' => array( $this, 'filter' )
37			);
38			}
39
40			public function required_arguments()
41			{
42			return array('name','data');
43			}
44
45			public function get_template_path()
46			{
47			return __DIR__.'/template.phtml';
48			}
49
50			/**
51			* This filter is needed when the form is submitted without $.amarkalUIForm,
52			* since the value of the toggle needs to be splitted into an array (when 'multi' is set to true).
53			* When using $.amarkalUIForm to submit the form, the component's getValue/setValue will
54			* handle this.
55			*
56			* @param [string\|array] $v
			0 ignored issues – show Documentation introduced 2017-07-31 20:58 UTC by Report Bug Copy Issue Report The doc-type `[string\|array]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
57			* @return [string\|array]
			0 ignored issues – show Documentation introduced 2017-07-31 20:58 UTC by Report Bug Copy Issue Report The doc-type `[string\|array]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
58			*/
59			public function filter($v)
60			{
61			if($this->multi && !\is_array($v))
			0 ignored issues – show Documentation introduced 2017-07-31 20:58 UTC by Report Bug Copy Issue Report The property `multi` does not exist on `object<Amarkal\UI\Component_toggle>`. 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...
62			{
63			return \explode(',', $v);
64			}
65			return $v;
66			}
67
68			protected function is_selected( $value )
69			{
70			if($this->multi)
			0 ignored issues – show Documentation introduced 2017-07-31 20:58 UTC by Report Bug Copy Issue Report The property `multi` does not exist on `object<Amarkal\UI\Component_toggle>`. 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...
71			{
72			return \in_array($value, $this->value);
			0 ignored issues – show Documentation introduced 2017-07-31 20:58 UTC by Report Bug Copy Issue Report The property `value` does not exist on `object<Amarkal\UI\Component_toggle>`. 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...
73			}
74			return $value === $this->value;
			0 ignored issues – show Documentation introduced 2017-07-31 20:58 UTC by Report Bug Copy Issue Report The property `value` does not exist on `object<Amarkal\UI\Component_toggle>`. 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...
75			}
76			}

amarkal / amarkal-ui

Push — master ( e36017...b2a81d )

Component_toggle::on_created() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like