kalanis\Restful\Application\Exceptions\BadRequestException

Complexity

Total Complexity

8

Size/Duplication

Total Lines	76
Duplicated Lines	0 %

Test Coverage

Coverage

27.27%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	forbidden()	0	3	1
A	methodNotSupported()	0	3	1
A	tooManyRequests()	0	3	1
A	gone()	0	3	1
A	unauthorized()	0	3	1
A	unsupportedMediaType()	0	3	1
A	unprocessableEntity()	0	5	1
A	notFound()	0	3	1

<?php

namespace kalanis\Restful\Application\Exceptions;


use kalanis\Restful\Validation\Error;
use Nette;
use Throwable;


/**
 * BadRequestException
 * @package kalanis\Restful\Application
 */
class BadRequestException extends Nette\Application\BadRequestException
{

    /** @var Error[] Some other errors appear in request */
    public array $errors = [];

    /****************** Simple factories ******************/

    /**
     * Is thrown when trying to reach secured resource without authentication
     */
    public static function unauthorized(string $message = '', ?Throwable $previous = null): self
    {
        return new self($message, 401, $previous);
    }

    /**
     * Is thrown when access to this resource is forbidden
     */
    public static function forbidden(string $message = '', ?Throwable $previous = null): self
    {
        return new self($message, 403, $previous);
    }

    /**
     * Is thrown when resource's not found
     */
    public static function notFound(string $message = '', ?Throwable $previous = null): self
    {
        return new self($message, 404, $previous);
    }

    /**
     * Is thrown when request method (e.g. POST or PUT) is not allowed for this resource
     */
    public static function methodNotSupported(string $message = '', ?Throwable $previous = null): self
    {
        return new self($message, 405, $previous);
    }

    /**
     * Is thrown when this resource is not no longer available (e.g. with new API version)
     */
    public static function gone(string $message = '', ?Throwable $previous = null): self
    {
        return new self($message, 410, $previous);
    }

    /**
     * Is thrown when incorrect (or unknown) Content-Type was provided in request
     */
    public static function unsupportedMediaType(string $message = '', ?Throwable $previous = null): self
    {
        return new self($message, 415, $previous);
    }

    /**
     * Is thrown when validation problem appears
     * @param Error[] $errors during validation
     * @param string $message
     * @param Throwable|null $previous
     * @return self
     */
    public static function unprocessableEntity(array $errors, string $message = '', ?Throwable $previous = null): self
    {
        $e = new self($message, 422, $previous);
        $e->errors = $errors;
        return $e;
    }

    /**
     * Is thrown to reject request due to rate limiting
     */
    public static function tooManyRequests(string $message = '', ?Throwable $previous = null): self
    {
        return new self($message, 429, $previous);
    }
}