Stratadox\Json\InputStringIsInvalid

Complexity

Total Complexity

1

Size/Duplication

Total Lines	18
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	detected()	0	8	1

<?php
declare(strict_types=1);

namespace Stratadox\Json;

use InvalidArgumentException as InvalidArgument;

/**
 * Exception to notify that the input data cannot be decoded from json format.
 *
 * @author Stratadox
 */
final class InputStringIsInvalid extends InvalidArgument implements InvalidJson
{
    /**
     * Produces an `Invalid Json` type exception, to throw when decoding the
     * input caused an error.
     *
     * @param string $error       The error message that was detected.
     * @param string $invalidJson The (invalid) json input that was provided.
     * @return InvalidJson        The Json context-specific exception to throw.
     */
    public static function detected(
        string $error,
        string $invalidJson
    ): InvalidJson {
        return new self(sprintf(
            'Decoding the input `%s` caused an error: %s.',
            $invalidJson,
            $error
        ));
    }
}