Sunrise\Http\Router\Exception\ExceptionFactory

Complexity

Total Complexity

6

Size/Duplication

Total Lines	109
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	routeNotFoundByUri()	0	7	1
A	middlewareAlreadyExists()	0	7	1
A	methodNotAllowed()	0	8	1
A	routeAlreadyExists()	0	7	1
A	routeNotFoundByName()	0	7	1
A	invalidLoaderFileResource()	0	7	1

<?php declare(strict_types=1);

/**
 * It's free open-source software released under the MIT License.
 *
 * @author Anatoly Fenric <anatoly@fenric.ru>
 * @copyright Copyright (c) 2018, Anatoly Fenric
 * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE
 * @link https://github.com/sunrise-php/http-router
 */

namespace Sunrise\Http\Router\Exception;

/**
 * Import functions
 */
use function sprintf;

/**
 * ExceptionFactory
 */
class ExceptionFactory
{

    /**
     * Used by a routes loader when the given resource wasn't found as a file
     *
     * @param mixed $resource
     * @param array $context
     *
     * @return InvalidLoaderResourceException
     */
    public function invalidLoaderFileResource($resource, array $context = []) : InvalidLoaderResourceException
    {
        $message = sprintf('The resource "%s" is not found.', $resource);

        $context['resource'] = $resource;

        return new InvalidLoaderResourceException($message, $context);
    }

    /**
     * Used when the given method isn't allowed
     *
     * @param string $method
     * @param array $allowed
     * @param array $context
     *
     * @return MethodNotAllowedException
     */
    public function methodNotAllowed(string $method, array $allowed, array $context = []) : MethodNotAllowedException
    {
        $message = sprintf('The method "%s" is not allowed.', $method);

        $context['method'] = $method;
        $context['allowed'] = $allowed;

        return new MethodNotAllowedException($message, $context);
    }

    /**
     * Used when a middleware with the given hash already exists in a stack
     *
     * It is recommended to add a middleware instance to the context.
     *
     * @param string $hash
     * @param array $context
     *
     * @return MiddlewareAlreadyExistsException
     */
    public function middlewareAlreadyExists(string $hash, array $context = []) : MiddlewareAlreadyExistsException
    {
        $message = sprintf('A middleware with the hash "%s" already exists.', $hash);

        $context['hash'] = $hash;

        return new MiddlewareAlreadyExistsException($message, $context);
    }

    /**
     * Used when a route with the given name already exists in a stack
     *
     * It is recommended to add a route instance to the context.
     *
     * @param string $name
     * @param array $context
     *
     * @return RouteAlreadyExistsException
     */
    public function routeAlreadyExists(string $name, array $context = []) : RouteAlreadyExistsException
    {
        $message = sprintf('A route with the name "%s" already exists.', $name);

        $context['name'] = $name;

        return new RouteAlreadyExistsException($message, $context);
    }

    /**
     * Used when trying to find a route by the given name
     *
     * @param string $name
     * @param array $context
     *
     * @return RouteNotFoundException
     */
    public function routeNotFoundByName(string $name, array $context = []) : RouteNotFoundException
    {
        $message = sprintf('No route found for the name "%s".', $name);

        $context['name'] = $name;

        return new RouteNotFoundException($message, $context);
    }

    /**
     * Used when trying to find a route by the given URI
     *
     * @param string $uri
     * @param array $context
     *
     * @return RouteNotFoundException
     */
    public function routeNotFoundByUri(string $uri, array $context = []) : RouteNotFoundException
    {
        $message = sprintf('No route found for the URI "%s".', $uri);

        $context['uri'] = $uri;

        return new RouteNotFoundException($message, $context);
    }
}