BelowOrEqualRule::getMaximum() - Code Metrics - jclaveau/php-logical-filter - Measure and Improve Code Quality continuously with Scrutinizer

BelowOrEqualRule::getMaximum() A
last analyzed 2019-08-15 22:31 UTC

↳ Parent: BelowOrEqualRule

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	4
Ratio	100 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	4
loc	4
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php
namespace JClaveau\LogicalFilter\Rule;

/**
 * a <= x
 */
class BelowOrEqualRule extends OrRule

{
    use Trait_RuleWithField;

    /** @var string operator */
    const operator = '<=';

    /** @var mixed maximum */
    protected $maximum;

    /**
     * @param string $field The field to apply the rule on.
     * @param array  $value The value the field can below to.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function __construct($field, $maximum, array $options=[])
    {
        if ( ! empty($options)) {
            $this->setOptions($options);
        }

        $this->field   = $field;
        $this->maximum = $maximum;
    }

    /**
     * @return mixed The maximum for the field of this rule
     */
    public function getMaximum()
    {
        return $this->maximum;
    }

    /**
     * Defines the maximum of the current rule
     *
     * @param  mixed $maximum
     * @return BelowOrEqualRule $this
     */
    public function setMaximum($maximum)
    {
        if (null === $maximum) {
            throw new \InvalidArgumentException(
                "The maximum of a below or equal rule cannot be null"
            );
        }

        if ($this->maximum == $maximum) {
            return $this;
        }

        $this->maximum = $maximum;
        $this->flushCache();

        return $this;
    }

    /**
     * @return bool
     */
    public function isNormalizationAllowed(array $contextual_options=[])
    {
        return $this->getOption('below_or_equal.normalization', $contextual_options);
    }

    /**
     * @return array $operands
     */
    public function getOperands()
    {
        if ( ! empty($this->cache['operands'])) {
            return $this->cache['operands'];
        }

        $operands = [
            new BelowRule($this->field, $this->maximum),
            new EqualRule($this->field, $this->maximum),
        ];

        return $this->cache['operands'] = $operands;
    }

    /**
     * Set the maximum and the field of the current instance by giving
     * an array of opereands as parameter.
     *
     * @param  array            $operands
     * @return BelowOrEqualRule $this
     */
    public function setOperands(array $operands)
    {
        foreach ($operands as $operand) {
            if ($operand instanceof EqualRule) {
                $equalRuleField = $operand->getField();
                $equalRuleValue = $operand->getValue();
            }
            elseif ($operand instanceof BelowRule) {
                $belowRuleField = $operand->getField();
                $belowRuleValue = $operand->getUpperLimit();
            }
        }

        if (   2 != count($operands)
            || ! isset($equalRuleValue)
            || ! isset($belowRuleValue)
            || $belowRuleValue != $equalRuleValue
            || $belowRuleField != $equalRuleField
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        ) {
            throw new \InvalidArgumentException(
                "Operands must be an array of two rules like (field < maximum || field = maximum) instead of:\n"
                .var_export($operands, true)
            );
        }

        $this->setMaximum($belowRuleValue);
        $this->setField($belowRuleField);

        return $this;
    }

    /**
     * @return array
     */
    public function getValues()
    {
        return $this->getMaximum();
    }

    /**
     * @param array $options + show_instance=false Display the operator of the rule or its instance id
     *
     * @return array
     */
    public function toArray(array $options=[])
    {
        $default_options = [
            'show_instance' => false,
        ];
        foreach ($default_options as $default_option => &$default_value) {
            if ( ! isset($options[ $default_option ])) {
                $options[ $default_option ] = $default_value;
            }
        }

        try {
            // TODO replace this rule by a simple OrRule?
            return [
                $this->getField(),
                $options['show_instance'] ? $this->getInstanceId() : self::operator,
                $this->getValues(),
            ];
        }
        catch (\RuntimeException $e) {
            return parent::toArray();
        }
    }

    /**
     */
    public function toString(array $options=[])
    {
        if (isset($this->cache['string'])) {
            return $this->cache['string'];
        }

        $operator = self::operator;

        return $this->cache['string'] = "['{$this->getField()}', '$operator', " . var_export($this->getValues(), true). "]";
    }

    /**/
}


1			<?php
2			namespace JClaveau\LogicalFilter\Rule;
3
4			/**
5			* a <= x
6			*/
7		View Code Duplication	class BelowOrEqualRule extends OrRule
			0 ignored issues – show Duplication introduced 2018-12-30 16:52 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
8			{
9			use Trait_RuleWithField;
10
11			/** @var string operator */
12			const operator = '<=';
13
14			/** @var mixed maximum */
15			protected $maximum;
16
17			/**
18			* @param string $field The field to apply the rule on.
19			* @param array $value The value the field can below to.
			0 ignored issues – show Bug introduced 2018-12-30 16:52 UTC by Report Bug Copy Issue Report There is no parameter named `$value`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
20			*/
21	33		public function __construct($field, $maximum, array $options=[])
22			{
23	33		if ( ! empty($options)) {
24	16		$this->setOptions($options);
25	16		}
26
27	33		$this->field = $field;
28	33		$this->maximum = $maximum;
29	33		}
30
31			/**
32			* @return mixed The maximum for the field of this rule
33			*/
34	33		public function getMaximum()
35			{
36	33		return $this->maximum;
37			}
38
39			/**
40			* Defines the maximum of the current rule
41			*
42			* @param mixed $maximum
43			* @return BelowOrEqualRule $this
44			*/
45	2		public function setMaximum($maximum)
46			{
47	2		if (null === $maximum) {
48			throw new \InvalidArgumentException(
49			"The maximum of a below or equal rule cannot be null"
50			);
51			}
52
53	2		if ($this->maximum == $maximum) {
54	2		return $this;
55			}
56
57			$this->maximum = $maximum;
58			$this->flushCache();
59
60			return $this;
61			}
62
63			/**
64			* @return bool
65			*/
66	15		public function isNormalizationAllowed(array $contextual_options=[])
67			{
68	15		return $this->getOption('below_or_equal.normalization', $contextual_options);
69			}
70
71			/**
72			* @return array $operands
73			*/
74	15		public function getOperands()
75			{
76	15		if ( ! empty($this->cache['operands'])) {
77	14		return $this->cache['operands'];
78			}
79
80			$operands = [
81	15		new BelowRule($this->field, $this->maximum),
82	15		new EqualRule($this->field, $this->maximum),
83	15		];
84
85	15		return $this->cache['operands'] = $operands;
86			}
87
88			/**
89			* Set the maximum and the field of the current instance by giving
90			* an array of opereands as parameter.
91			*
92			* @param array $operands
93			* @return BelowOrEqualRule $this
94			*/
95	3		public function setOperands(array $operands)
96			{
97	3		foreach ($operands as $operand) {
98	3		if ($operand instanceof EqualRule) {
99	3		$equalRuleField = $operand->getField();
100	3		$equalRuleValue = $operand->getValue();
101	3		}
102	3		elseif ($operand instanceof BelowRule) {
103	3		$belowRuleField = $operand->getField();
104	3		$belowRuleValue = $operand->getUpperLimit();
105	3		}
106	3		}
107
108	3		if ( 2 != count($operands)
109	3		\|\| ! isset($equalRuleValue)
110	3		\|\| ! isset($belowRuleValue)
111	3		\|\| $belowRuleValue != $equalRuleValue
112	3		\|\| $belowRuleField != $equalRuleField
			0 ignored issues – show Bug introduced 2018-12-30 16:52 UTC by Report Bug Copy Issue Report The variable `$belowRuleField` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history... Bug introduced 2018-12-30 16:52 UTC by Report Bug Copy Issue Report The variable `$equalRuleField` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
113	3		) {
114	1		throw new \InvalidArgumentException(
115			"Operands must be an array of two rules like (field < maximum \|\| field = maximum) instead of:\n"
116	1		.var_export($operands, true)
117	1		);
118			}
119
120	2		$this->setMaximum($belowRuleValue);
121	2		$this->setField($belowRuleField);
122
123	2		return $this;
124			}
125
126			/**
127			* @return array
128			*/
129	33		public function getValues()
130			{
131	33		return $this->getMaximum();
132			}
133
134			/**
135			* @param array $options + show_instance=false Display the operator of the rule or its instance id
136			*
137			* @return array
138			*/
139	33		public function toArray(array $options=[])
140			{
141			$default_options = [
142	33		'show_instance' => false,
143	33		];
144	33		foreach ($default_options as $default_option => &$default_value) {
145	33		if ( ! isset($options[ $default_option ])) {
146	33		$options[ $default_option ] = $default_value;
147	33		}
148	33		}
149
150			try {
151			// TODO replace this rule by a simple OrRule?
152			return [
153	33		$this->getField(),
154	33		$options['show_instance'] ? $this->getInstanceId() : self::operator,
155	33		$this->getValues(),
156	33		];
157			}
158			catch (\RuntimeException $e) {
159			return parent::toArray();
160			}
161			}
162
163			/**
164			*/
165	1		public function toString(array $options=[])
166			{
167	1		if (isset($this->cache['string'])) {
168	1		return $this->cache['string'];
169			}
170
171	1		$operator = self::operator;
172
173	1		return $this->cache['string'] = "['{$this->getField()}', '$operator', " . var_export($this->getValues(), true). "]";
174			}
175
176			/**/
177			}
178

jclaveau / php-logical-filter

BelowOrEqualRule::getMaximum() A last analyzed 2019-08-15 22:31 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

BelowOrEqualRule::getMaximum() A
last analyzed 2019-08-15 22:31 UTC