InvalidConfigurationException::forConfigOption() - Code Metrics - thephpleague/config - Measure and Improve Code Quality continuously with Scrutinizer

InvalidConfigurationException::forConfigOption() A
last analyzed 2024-05-20 13:34 UTC

↳ Parent: InvalidConfigurationException

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

/*
 * This file is part of the league/config package.
 *
 * (c) Colin O'Dell <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace League\Config\Exception;

class InvalidConfigurationException extends \UnexpectedValueException implements ConfigurationExceptionInterface
{
    /**
     * @param string  $option      Name/path of the option
     * @param mixed   $valueGiven  The invalid option that was provided
     * @param ?string $description Additional text describing the issue (optional)
     */
    public static function forConfigOption(string $option, $valueGiven, ?string $description = null): self
    {
        $message = \sprintf('Invalid config option for "%s": %s', $option, self::getDebugValue($valueGiven));
        if ($description !== null) {
            $message .= \sprintf(' (%s)', $description);
        }

        return new self($message);
    }

    /**
     * @param mixed $value
     *
     * @psalm-pure
     */
    private static function getDebugValue($value): string
    {
        if (\is_object($value)) {
            return \get_class($value);
        }

        // @phpstan-ignore possiblyImpure.functionCall
        return \print_r($value, true);

    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		/*
6		* This file is part of the league/config package.
7		*
8		* (c) Colin O'Dell <[email protected]>
9		*
10		* For the full copyright and license information, please view the LICENSE
11		* file that was distributed with this source code.
12		*/
13
14		namespace League\Config\Exception;
15
16		class InvalidConfigurationException extends \UnexpectedValueException implements ConfigurationExceptionInterface
17		{
18		/**
19		* @param string $option Name/path of the option
20		* @param mixed $valueGiven The invalid option that was provided
21		* @param ?string $description Additional text describing the issue (optional)
22		*/
23	9	public static function forConfigOption(string $option, $valueGiven, ?string $description = null): self
24		{
25	9	$message = \sprintf('Invalid config option for "%s": %s', $option, self::getDebugValue($valueGiven));
26	9	if ($description !== null) {
27	3	$message .= \sprintf(' (%s)', $description);
28		}
29
30	9	return new self($message);
31		}
32
33		/**
34		* @param mixed $value
35		*
36		* @psalm-pure
37		*/
38	9	private static function getDebugValue($value): string
39		{
40	9	if (\is_object($value)) {
41	3	return \get_class($value);
42		}
43
44		// @phpstan-ignore possiblyImpure.functionCall
45	6	return \print_r($value, true);
		0 ignored issues – show Bug Best Practice introduced 2024-05-20 13:32 UTC by Report Bug Copy Issue Report The expression `return print_r($value, true)` could return the type `true` which is incompatible with the type-hinted return `string`. Consider adding an additional type-check to rule them out. Loading history...
46		}
47		}
48

thephpleague / config

InvalidConfigurationException::forConfigOption() A last analyzed 2024-05-20 13:34 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

InvalidConfigurationException::forConfigOption() A
last analyzed 2024-05-20 13:34 UTC