UnexpectedRuleException::__construct() - Code Metrics - yiisoft/validator - Measure and Improve Code Quality continuously with Scrutinizer

UnexpectedRuleException::__construct() A
last analyzed 2024-01-12 07:44 UTC

↳ Parent: UnexpectedRuleException

Complexity

Conditions	1
Paths	1

Size

Total Lines	26
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Exception;

use InvalidArgumentException;
use Throwable;

/**
 * An exception used by rule handlers to guarantee that passed rule have desired type. Every handler's validation code
 * must start with this check. An example for `MyRule` and `MyRuleHandler`:
 *
 * ```php
 * use Yiisoft\Validator\Exception\UnexpectedRuleException;
 * use Yiisoft\Validator\Result;
 * use Yiisoft\Validator\RuleHandlerInterface;
 * use Yiisoft\Validator\ValidationContext;
 *
 * final class MyRuleHandler implements RuleHandlerInterface
 * {
 *     public function validate(mixed $value, object $rule, ValidationContext $context): Result
 *     {
 *         if (!$rule instanceof MyRule) {
 *             throw new UnexpectedRuleException(MyRule::class, $rule);
 *         }
 *
 *         // ...
 *         $result = new Result();
 *         // ...
 *
 *         return $result;
 *     }
 * }
 * ```
 */
final class UnexpectedRuleException extends InvalidArgumentException
{
    public function __construct(
        /**
         * @var string Expected class name of a rule.
         */
        string $expectedClassName,
        /**
         * @var object An actual given object that's not an instance of `$expectedClassName`.
         */
        object $actualObject,
        /**
         * @var int The Exception code.
         */
        int $code = 0,
        /**
         * @var Throwable|null The previous throwable used for the exception chaining.
         */
        ?Throwable $previous = null,
    ) {
        parent::__construct(
            sprintf(
                'Expected "%s", but "%s" given.',
                $expectedClassName,
                $actualObject::class
            ),
            $code,
            $previous,
        );
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Validator\Exception;
6
7		use InvalidArgumentException;
8		use Throwable;
9
10		/**
11	20	* An exception used by rule handlers to guarantee that passed rule have desired type. Every handler's validation code
12		* must start with this check. An example for `MyRule` and `MyRuleHandler`:
13	20	*
14	20	* ```php
15		* use Yiisoft\Validator\Exception\UnexpectedRuleException;
16	20	* use Yiisoft\Validator\Result;
17		* use Yiisoft\Validator\RuleHandlerInterface;
18		* use Yiisoft\Validator\ValidationContext;
19		*
20		* final class MyRuleHandler implements RuleHandlerInterface
21		* {
22		* public function validate(mixed $value, object $rule, ValidationContext $context): Result
23		* {
24		* if (!$rule instanceof MyRule) {
25		* throw new UnexpectedRuleException(MyRule::class, $rule);
26		* }
27		*
28		* // ...
29		* $result = new Result();
30		* // ...
31		*
32		* return $result;
33		* }
34		* }
35		* ```
36		*/
37		final class UnexpectedRuleException extends InvalidArgumentException
38		{
39		public function __construct(
40		/**
41		* @var string Expected class name of a rule.
42		*/
43		string $expectedClassName,
44		/**
45		* @var object An actual given object that's not an instance of `$expectedClassName`.
46		*/
47		object $actualObject,
48		/**
49		* @var int The Exception code.
50		*/
51		int $code = 0,
52		/**
53		* @var Throwable\|null The previous throwable used for the exception chaining.
54		*/
55		?Throwable $previous = null,
56		) {
57		parent::__construct(
58		sprintf(
59		'Expected "%s", but "%s" given.',
60		$expectedClassName,
61		$actualObject::class
62		),
63		$code,
64		$previous,
65		);
66		}
67		}
68

yiisoft / validator

UnexpectedRuleException::__construct() A last analyzed 2024-01-12 07:44 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

UnexpectedRuleException::__construct() A
last analyzed 2024-01-12 07:44 UTC