Yiisoft\Validator\Exception\UnexpectedRuleException

Complexity

Total Complexity

1

Size/Duplication

Total Lines	28
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	26	1

<?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,
        );
    }
}