RequiredParameterAmountIncreased::compare() - Code Metrics - Inspection of "Verify method, function, property, constant and in..." - Roave/BackwardCompatibilityCheck - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#38)

by Marco

created 2018-04-22 12:47 UTC

RequiredParameterAmountIncreased::compare() A

↳ Parent: RequiredParameterAmountIncreased

Complexity

Conditions	2
Paths	2

Size

Total Lines	18
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	18
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	12
nc	2
nop	2

<?php

declare(strict_types=1);

namespace Roave\ApiCompare\Comparator\BackwardsCompatibility\FunctionBased;

use Roave\ApiCompare\Change;
use Roave\ApiCompare\Changes;
use Roave\ApiCompare\Formatter\ReflectionFunctionAbstractName;
use Roave\BetterReflection\Reflection\ReflectionFunctionAbstract;
use function sprintf;

/**
 * When new parameters are added, they must be optional, or else the callers will provide an insufficient
 * amount of parameters to the function.
 */
final class RequiredParameterAmountIncreased implements FunctionBased
{
    /** @var ReflectionFunctionAbstractName */
    private $formatFunction;

    public function __construct()
    {
        $this->formatFunction = new ReflectionFunctionAbstractName();
    }

    public function compare(ReflectionFunctionAbstract $fromFunction, ReflectionFunctionAbstract $toFunction) : Changes
    {
        $fromRequiredParameters = $fromFunction->getNumberOfRequiredParameters();
        $toRequiredParameters   = $toFunction->getNumberOfRequiredParameters();

        if ($fromRequiredParameters >= $toRequiredParameters) {
            return Changes::new();
        }

        return Changes::fromArray([
            Change::changed(
                sprintf(
                    'The number of required arguments for %s increased from %d to %d',
                    $this->formatFunction->__invoke($fromFunction),
                    $fromRequiredParameters,
                    $toRequiredParameters
                ),
                true
            ),
        ]);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Roave\ApiCompare\Comparator\BackwardsCompatibility\FunctionBased;
6
7			use Roave\ApiCompare\Change;
8			use Roave\ApiCompare\Changes;
9			use Roave\ApiCompare\Formatter\ReflectionFunctionAbstractName;
10			use Roave\BetterReflection\Reflection\ReflectionFunctionAbstract;
11			use function sprintf;
12
13			/**
14			* When new parameters are added, they must be optional, or else the callers will provide an insufficient
15			* amount of parameters to the function.
16			*/
17			final class RequiredParameterAmountIncreased implements FunctionBased
18			{
19			/** @var ReflectionFunctionAbstractName */
20			private $formatFunction;
21
22			public function __construct()
23			{
24			$this->formatFunction = new ReflectionFunctionAbstractName();
25			}
26
27			public function compare(ReflectionFunctionAbstract $fromFunction, ReflectionFunctionAbstract $toFunction) : Changes
28			{
29			$fromRequiredParameters = $fromFunction->getNumberOfRequiredParameters();
30			$toRequiredParameters = $toFunction->getNumberOfRequiredParameters();
31
32			if ($fromRequiredParameters >= $toRequiredParameters) {
33			return Changes::new();
34			}
35
36			return Changes::fromArray([
37			Change::changed(
38			sprintf(
39			'The number of required arguments for %s increased from %d to %d',
40			$this->formatFunction->__invoke($fromFunction),
41			$fromRequiredParameters,
42			$toRequiredParameters
43			),
44			true
45			),
46			]);
47			}
48			}
49

Roave / BackwardCompatibilityCheck

Pull Request — master (#38)

RequiredParameterAmountIncreased::compare() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like