MarcinOrlowski\ResponseBuilder\BaseApiCodes

Complexity

Total Complexity

9

Size/Duplication

Total Lines	190
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	6
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	EX_UNCAUGHT_EXCEPTION()	0	3	1
A	NO_ERROR_MESSAGE()	0	3	1
A	EX_HTTP_EXCEPTION()	0	3	1
A	OK()	0	3	1
A	EX_AUTHENTICATION_EXCEPTION()	0	3	1
A	EX_HTTP_SERVICE_UNAVAILABLE()	0	3	1
A	EX_HTTP_NOT_FOUND()	0	3	1
A	getBaseMap()	0	21	1
A	EX_VALIDATION_EXCEPTION()	0	3	1

<?php
declare(strict_types=1);

namespace MarcinOrlowski\ResponseBuilder;

/**
 * Laravel API Response Builder
 *
 * @package   MarcinOrlowski\ResponseBuilder
 *
 * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
 * @copyright 2016-2019 Marcin Orlowski
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
 */

use Symfony\Component\HttpFoundation\Response as HttpResponse;

/**
 * BaseApiCodes handling class
 */
class BaseApiCodes
{
    use ApiCodesHelpers;

    /**
     * protected code range - lowest code for reserved range.
     *
     * @var int
     */
    public const RESERVED_MIN_API_CODE_OFFSET = 0;

    /**
     * protected code range - highest code for reserved range
     *
     * @var int
     */
    public const RESERVED_MAX_API_CODE_OFFSET = 19;

    /**
     * built-in codes: OK
     *
     * @var int
     */
    protected const OK_OFFSET = 0;
    /**
     * built-in code for fallback message mapping
     *
     * @var int
     */
    protected const NO_ERROR_MESSAGE_OFFSET = 1;
    /**
     * built-in error code for HTTP_NOT_FOUND exception
     *
     * @var int
     */
    protected const EX_HTTP_NOT_FOUND_OFFSET = 10;
    /**
     * built-in error code for HTTP_SERVICE_UNAVAILABLE exception
     *
     * @var int
     */
    protected const EX_HTTP_SERVICE_UNAVAILABLE_OFFSET = 11;
    /**
     * built-in error code for HTTP_EXCEPTION
     *
     * @var int
     */
    protected const EX_HTTP_EXCEPTION_OFFSET = 12;
    /**
     * built-in error code for UNCAUGHT_EXCEPTION
     *
     * @var int
     */
    protected const EX_UNCAUGHT_EXCEPTION_OFFSET = 13;

    /**
     * built-in error code for \Illuminate\Auth\AuthenticationException
     *
     * @var int
     */
    protected const EX_AUTHENTICATION_EXCEPTION_OFFSET = 14;

    /**
     * built-in error code for \Illuminate\Auth\AuthenticationException
     *
     * @var int
     */
    protected const EX_VALIDATION_EXCEPTION_OFFSET = 15;

    /**
     * Returns base code mapping array
     *
     * @return array
     */
    protected static function getBaseMap(): array
    {
        $tpl = 'response-builder::builder.http_%d';

        return [
            /** @scrutinizer ignore-deprecated */
            self::OK()                          => 'response-builder::builder.ok',
            /** @scrutinizer ignore-deprecated */
            self::NO_ERROR_MESSAGE()            => 'response-builder::builder.no_error_message',
            /** @scrutinizer ignore-deprecated */
            self::EX_HTTP_EXCEPTION()           => 'response-builder::builder.http_exception',
            /** @scrutinizer ignore-deprecated */
            self::EX_UNCAUGHT_EXCEPTION()       => 'response-builder::builder.uncaught_exception',
            /** @scrutinizer ignore-deprecated */
            self::EX_HTTP_NOT_FOUND()           => sprintf($tpl, HttpResponse::HTTP_NOT_FOUND),
            /** @scrutinizer ignore-deprecated */
            self::EX_HTTP_SERVICE_UNAVAILABLE() => sprintf($tpl, HttpResponse::HTTP_SERVICE_UNAVAILABLE),
            /** @scrutinizer ignore-deprecated */
            self::EX_AUTHENTICATION_EXCEPTION() => sprintf($tpl, HttpResponse::HTTP_UNAUTHORIZED),
            /** @scrutinizer ignore-deprecated */
            self::EX_VALIDATION_EXCEPTION()     => sprintf($tpl, HttpResponse::HTTP_UNPROCESSABLE_ENTITY),
        ];
    }

    /**
     * Returns API code for internal code OK
     *
     * @return int valid API code in current range
     *
     * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
     */
    public static function OK(): int
    {
        return static::getCodeForInternalOffset(static::OK_OFFSET);
    }

    /**
     * Returns API code for internal code NO_ERROR_MESSAGE
     *
     * @return int valid API code in current range
     */
    public static function NO_ERROR_MESSAGE(): int
    {
        return static::getCodeForInternalOffset(static::NO_ERROR_MESSAGE_OFFSET);
    }

    /**
     * Returns API code for internal code EX_HTTP_NOT_FOUND
     *
     * @return int valid API code in current range
     *
     * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
     */
    public static function EX_HTTP_NOT_FOUND(): int
    {
        return static::getCodeForInternalOffset(static::EX_HTTP_NOT_FOUND_OFFSET);
    }

    /**
     * Returns API code for internal code EX_HTTP_EXCEPTION
     *
     * @return int valid API code in current range
     *
     * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
     */
    public static function EX_HTTP_EXCEPTION(): int
    {
        return static::getCodeForInternalOffset(static::EX_HTTP_EXCEPTION_OFFSET);
    }

    /**
     * Returns API code for internal code EX_UNCAUGHT_EXCEPTION
     *
     * @return int valid API code in current range
     *
     * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
     */
    public static function EX_UNCAUGHT_EXCEPTION(): int
    {
        return static::getCodeForInternalOffset(static::EX_UNCAUGHT_EXCEPTION_OFFSET);
    }

    /**
     * Returns API code for internal code EX_AUTHENTICATION_EXCEPTION
     *
     * @return int valid API code in current range
     *
     * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
     */
    public static function EX_AUTHENTICATION_EXCEPTION(): int
    {
        return static::getCodeForInternalOffset(static::EX_AUTHENTICATION_EXCEPTION_OFFSET);
    }

    /**
     * Returns API code for internal code EX_VALIDATION_EXCEPTION
     *
     * @return int valid API code in current range
     *
     * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
     */
    public static function EX_VALIDATION_EXCEPTION(): int
    {
        return static::getCodeForInternalOffset(static::EX_VALIDATION_EXCEPTION_OFFSET);
    }

    /**
     * Returns API code for internal code EX_HTTP_SERVICE_UNAVAILABLE
     *
     * @return int valid API code in current range
     *
     * @deprecated Configure Exception Handler to use your own API code. This method will be removed in v8.
     */
    public static function EX_HTTP_SERVICE_UNAVAILABLE(): int
    {
        return static::getCodeForInternalOffset(static::EX_HTTP_SERVICE_UNAVAILABLE_OFFSET);
    }

}