Yiisoft\Validator\Exception\CallbackRuleException

Complexity

Total Complexity

4

Size/Duplication

Total Lines	21
Duplicated Lines	0 %

Test Coverage

Coverage

66.67%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getSolution()	0	3	1
A	getName()	0	3	1
A	__construct()	0	9	2

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Exception;

use Throwable;
use Yiisoft\FriendlyException\FriendlyExceptionInterface;
use Yiisoft\Validator\Result;

class CallbackRuleException extends \Exception implements FriendlyExceptionInterface
{
    public function __construct($result, $code = 0, Throwable $previous = null)
    {
        $message = sprintf(
            'Return value of callback must be an instance of %s, %s returned.',
            Result::class,
            is_object($result) ? get_class($result) : gettype($result)
        );

        parent::__construct($message, $code, $previous);
    }

    public function getName(): string
    {
        return 'Invalid callable return value';
    }

    public function getSolution(): ?string
    {
        return <<<SOLUTION
            The callback must return an instance of \\Yiisoft\\Validator\\Result. An example of a valid callback:
                static function (): \\Yiisoft\\Validator\\Result
                {
                    \$result = new \\Yiisoft\\Validator\\Result();

                    ...

                    return \$result;
                }
        SOLUTION;
    }
}