Jasny\ValidationException

Complexity

Total Complexity

6

Size/Duplication

Total Lines	55
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	error()	0	5	1
A	getErrors()	0	3	1
A	getError()	0	3	1
A	__construct()	0	9	2
A	getValidationResult()	0	3	1

<?php

namespace Jasny;

use UnexpectedValueException;

/**
 * Validation exception
 */
class ValidationException extends \RuntimeException
{
    protected ValidationResult $validationResult;

    /**
     * ValidationException constructor.
     *
     * @throws UnexpectedValueException
     */
    public function __construct(ValidationResult $validation)
    {
        if (!$validation->failed()) {
            throw new UnexpectedValueException("Validation didn't fail, no exception should be thrown");
        }

        parent::__construct("Validation failed;\n * " . join("\n * ", $validation->getErrors()));

        $this->validationResult = $validation;
    }

    /**
     * Get the validation result with the validation errors.
     */
    public function getValidationResult(): ValidationResult
    {
        return $this->validationResult;
    }

    /**
     * Get the (first) validation error
     */
    public function getError(): string
    {
        return $this->validationResult->getError();

The expression return $this->validationResult->getError() could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * Get the validation errors
     *
     * @return string[]
     */
    public function getErrors(): array
    {
        return $this->validationResult->getErrors();
    }


    /**
     * Factory method for failed validation
     */
    public static function error(string $message, mixed ...$args): static
    {
        $error = ValidationResult::error($message, ...$args);

        return new static($error);
    }
}