Incoming\Hydrator\Exception\UnresolvableHydratorException

Complexity

Total Complexity

2

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	forModel()	0	13	2

<?php
/**
 * Incoming
 *
 * @author    Trevor Suarez (Rican7)
 * @copyright (c) Trevor Suarez
 * @link      https://github.com/Rican7/incoming
 * @license   MIT
 */

declare(strict_types=1);

namespace Incoming\Hydrator\Exception;

use Throwable;
use UnexpectedValueException;

/**
 * An exception to be thrown when a hydrator can't be resolved, whether by
 * automatic lookup or not, and usually for a given model.
 */
class UnresolvableHydratorException extends UnexpectedValueException
{

    /**
     * Constants
     */

    /**
     * The default exception message.
     *
     * @var string
     */
    const DEFAULT_MESSAGE = 'Unable to resolve a hydrator';

    /**
     * The exception code for when a model is used as the resolver argument.
     *
     * @var int
     */
    const CODE_FOR_MODEL = 1;

    /**
     * The message extension (appended to the default message) for when a model
     * is used as the hydrator resolver argument.
     *
     * @var string
     */
    const MESSAGE_EXTENSION_FOR_MODEL = ' for the given model';

    /**
     * The message extension format for providing type information.
     *
     * @var string
     */
    const MESSAGE_EXTENSION_TYPE_FORMAT = ' of type `%s`';


    /**
     * Properties
     */

    /**
     * The exception message.
     *
     * @var string
     */
    protected $message = self::DEFAULT_MESSAGE;


    /**
     * Methods
     */

    /**
     * Create an exception instance for a problem resolving a hydrator for a
     * given model.
     *
     * @param mixed $model The model to hydrate.
     * @param int $code The exception code.
     * @param Throwable|null $previous A previous exception used for chaining.
     * @return static The newly created exception.
     */
    public static function forModel(
        $model,
        int $code = self::CODE_FOR_MODEL,
        Throwable $previous = null
    ): self {
        $message = self::DEFAULT_MESSAGE . self::MESSAGE_EXTENSION_FOR_MODEL;

        $message .= sprintf(
            self::MESSAGE_EXTENSION_TYPE_FORMAT,
            is_object($model) ? get_class($model) : gettype($model)
        );

        return new static($message, $code, $previous);
    }
}