MarcinOrlowski / laravel-api-response-builder

src/lang/pl/builder.php

Indentation +48 added lines, -48 removed lines

@@ -10,54 +10,54 @@
  */
 return [
 
-    'ok'                       => 'OK',
-    'no_error_message'         => 'Błąd #:api_code',
+	'ok'                       => 'OK',
+	'no_error_message'         => 'Błąd #:api_code',
 
-    // Used by Exception Handler Helper (when used)
-    'uncaught_exception'       => 'Nieprzechwycony wyjątek: :message',
-    'http_exception'           => 'Wyjątek HTTP: :message',
+	// Used by Exception Handler Helper (when used)
+	'uncaught_exception'       => 'Nieprzechwycony wyjątek: :message',
+	'http_exception'           => 'Wyjątek HTTP: :message',
 
-    // HttpException handler (added in 6.4.0)
-    // Error messages for HttpException caught w/o custom messages
-    // https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
-    'http_400'                 => 'Bad Request',
-    'http_401'                 => 'Unauthorized',
-    'http_402'                 => 'Payment Required',
-    'http_403'                 => 'Forbidden',
-    'http_404'                 => 'Not Found',
-    'http_405'                 => 'Method Not Allowed',
-    'http_406'                 => 'Not Acceptable',
-    'http_407'                 => 'Proxy Authentication Required',
-    'http_408'                 => 'Request Timeout',
-    'http_409'                 => 'Conflict',
-    'http_410'                 => 'Gone',
-    'http_411'                 => 'Length Required',
-    'http_412'                 => 'Precondition Failed',
-    'http_413'                 => 'Payload Too Large',
-    'http_414'                 => 'URI Too Long',
-    'http_415'                 => 'Unsupported Media Type',
-    'http_416'                 => 'Range Not Satisfiable',
-    'http_417'                 => 'Expectation Failed',
-    'http_421'                 => 'Misdirected Request',
-    'http_422'                 => 'Unprocessable Entity',
-    'http_423'                 => 'Locked',
-    'http_424'                 => 'Failed Dependency',
-    'http_425'                 => 'Too Early',
-    'http_426'                 => 'Upgrade Required',
-    'http_428'                 => 'Precondition Required',
-    'http_429'                 => 'Too Many Requests',
-    'http_431'                 => 'Request Header Fields Too Large',
-    'http_451'                 => 'Unavailable For Legal Reasons',
-    'http_500'                 => 'Internal Server Error',
-    'http_501'                 => 'Not Implemented',
-    'http_502'                 => 'Bad Gateway',
-    'http_503'                 => 'Service Unavailable',
-    'http_504'                 => 'Gateway Timeout',
-    'http_505'                 => 'HTTP Version Not Supported',
-    'http_506'                 => 'Variant Also Negotiates',
-    'http_507'                 => 'Insufficient Storage',
-    'http_508'                 => 'Loop Detected',
-    'http_509'                 => 'Unassigned',
-    'http_510'                 => 'Not Extended',
-    'http_511'                 => 'Network Authentication Required',
+	// HttpException handler (added in 6.4.0)
+	// Error messages for HttpException caught w/o custom messages
+	// https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
+	'http_400'                 => 'Bad Request',
+	'http_401'                 => 'Unauthorized',
+	'http_402'                 => 'Payment Required',
+	'http_403'                 => 'Forbidden',
+	'http_404'                 => 'Not Found',
+	'http_405'                 => 'Method Not Allowed',
+	'http_406'                 => 'Not Acceptable',
+	'http_407'                 => 'Proxy Authentication Required',
+	'http_408'                 => 'Request Timeout',
+	'http_409'                 => 'Conflict',
+	'http_410'                 => 'Gone',
+	'http_411'                 => 'Length Required',
+	'http_412'                 => 'Precondition Failed',
+	'http_413'                 => 'Payload Too Large',
+	'http_414'                 => 'URI Too Long',
+	'http_415'                 => 'Unsupported Media Type',
+	'http_416'                 => 'Range Not Satisfiable',
+	'http_417'                 => 'Expectation Failed',
+	'http_421'                 => 'Misdirected Request',
+	'http_422'                 => 'Unprocessable Entity',
+	'http_423'                 => 'Locked',
+	'http_424'                 => 'Failed Dependency',
+	'http_425'                 => 'Too Early',
+	'http_426'                 => 'Upgrade Required',
+	'http_428'                 => 'Precondition Required',
+	'http_429'                 => 'Too Many Requests',
+	'http_431'                 => 'Request Header Fields Too Large',
+	'http_451'                 => 'Unavailable For Legal Reasons',
+	'http_500'                 => 'Internal Server Error',
+	'http_501'                 => 'Not Implemented',
+	'http_502'                 => 'Bad Gateway',
+	'http_503'                 => 'Service Unavailable',
+	'http_504'                 => 'Gateway Timeout',
+	'http_505'                 => 'HTTP Version Not Supported',
+	'http_506'                 => 'Variant Also Negotiates',
+	'http_507'                 => 'Insufficient Storage',
+	'http_508'                 => 'Loop Detected',
+	'http_509'                 => 'Unassigned',
+	'http_510'                 => 'Not Extended',
+	'http_511'                 => 'Network Authentication Required',
 ];

src/lang/en/builder.php

Indentation +48 added lines, -48 removed lines

@@ -10,55 +10,55 @@
  */
 return [
 
-    'ok'                       => 'OK',
-    'no_error_message'         => 'Error #:api_code',
+	'ok'                       => 'OK',
+	'no_error_message'         => 'Error #:api_code',
 
-    // Used by Exception Handler Helper (when used)
-    'uncaught_exception'       => 'Uncaught exception: :message',
-    'http_exception'           => 'HTTP exception: :message',
+	// Used by Exception Handler Helper (when used)
+	'uncaught_exception'       => 'Uncaught exception: :message',
+	'http_exception'           => 'HTTP exception: :message',
 
-    // HttpException handler (added in 6.4.0)
-    // Error messages for HttpException caught w/o custom messages
-    // https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
-    'http_400'                 => 'Bad Request',
-    'http_401'                 => 'Unauthorized',
-    'http_402'                 => 'Payment Required',
-    'http_403'                 => 'Forbidden',
-    'http_404'                 => 'Not Found',
-    'http_405'                 => 'Method Not Allowed',
-    'http_406'                 => 'Not Acceptable',
-    'http_407'                 => 'Proxy Authentication Required',
-    'http_408'                 => 'Request Timeout',
-    'http_409'                 => 'Conflict',
-    'http_410'                 => 'Gone',
-    'http_411'                 => 'Length Required',
-    'http_412'                 => 'Precondition Failed',
-    'http_413'                 => 'Payload Too Large',
-    'http_414'                 => 'URI Too Long',
-    'http_415'                 => 'Unsupported Media Type',
-    'http_416'                 => 'Range Not Satisfiable',
-    'http_417'                 => 'Expectation Failed',
-    'http_421'                 => 'Misdirected Request',
-    'http_422'                 => 'Unprocessable Entity',
-    'http_423'                 => 'Locked',
-    'http_424'                 => 'Failed Dependency',
-    'http_425'                 => 'Too Early',
-    'http_426'                 => 'Upgrade Required',
-    'http_428'                 => 'Precondition Required',
-    'http_429'                 => 'Too Many Requests',
-    'http_431'                 => 'Request Header Fields Too Large',
-    'http_451'                 => 'Unavailable For Legal Reasons',
-    'http_500'                 => 'Internal Server Error',
-    'http_501'                 => 'Not Implemented',
-    'http_502'                 => 'Bad Gateway',
-    'http_503'                 => 'Service Unavailable',
-    'http_504'                 => 'Gateway Timeout',
-    'http_505'                 => 'HTTP Version Not Supported',
-    'http_506'                 => 'Variant Also Negotiates',
-    'http_507'                 => 'Insufficient Storage',
-    'http_508'                 => 'Loop Detected',
-    'http_509'                 => 'Unassigned',
-    'http_510'                 => 'Not Extended',
-    'http_511'                 => 'Network Authentication Required',
+	// HttpException handler (added in 6.4.0)
+	// Error messages for HttpException caught w/o custom messages
+	// https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
+	'http_400'                 => 'Bad Request',
+	'http_401'                 => 'Unauthorized',
+	'http_402'                 => 'Payment Required',
+	'http_403'                 => 'Forbidden',
+	'http_404'                 => 'Not Found',
+	'http_405'                 => 'Method Not Allowed',
+	'http_406'                 => 'Not Acceptable',
+	'http_407'                 => 'Proxy Authentication Required',
+	'http_408'                 => 'Request Timeout',
+	'http_409'                 => 'Conflict',
+	'http_410'                 => 'Gone',
+	'http_411'                 => 'Length Required',
+	'http_412'                 => 'Precondition Failed',
+	'http_413'                 => 'Payload Too Large',
+	'http_414'                 => 'URI Too Long',
+	'http_415'                 => 'Unsupported Media Type',
+	'http_416'                 => 'Range Not Satisfiable',
+	'http_417'                 => 'Expectation Failed',
+	'http_421'                 => 'Misdirected Request',
+	'http_422'                 => 'Unprocessable Entity',
+	'http_423'                 => 'Locked',
+	'http_424'                 => 'Failed Dependency',
+	'http_425'                 => 'Too Early',
+	'http_426'                 => 'Upgrade Required',
+	'http_428'                 => 'Precondition Required',
+	'http_429'                 => 'Too Many Requests',
+	'http_431'                 => 'Request Header Fields Too Large',
+	'http_451'                 => 'Unavailable For Legal Reasons',
+	'http_500'                 => 'Internal Server Error',
+	'http_501'                 => 'Not Implemented',
+	'http_502'                 => 'Bad Gateway',
+	'http_503'                 => 'Service Unavailable',
+	'http_504'                 => 'Gateway Timeout',
+	'http_505'                 => 'HTTP Version Not Supported',
+	'http_506'                 => 'Variant Also Negotiates',
+	'http_507'                 => 'Insufficient Storage',
+	'http_508'                 => 'Loop Detected',
+	'http_509'                 => 'Unassigned',
+	'http_510'                 => 'Not Extended',
+	'http_511'                 => 'Network Authentication Required',
 ];
 

src/lang/fa/builder.php

Indentation +49 added lines, -49 removed lines

@@ -10,56 +10,56 @@
  */
 return [
 
-    'ok'                       => 'موفق',
-    'no_error_message'         => 'خطای شماره :api_code',
+	'ok'                       => 'موفق',
+	'no_error_message'         => 'خطای شماره :api_code',
 
-    // can be used by Exception Handler (if enabled)
-    'uncaught_exception'       => 'استثناء مدیریت نشده :message',
-    // we talking API call here, hence we have http_not_found
-    'http_exception'           => 'استثناء HTTP :message',
+	// can be used by Exception Handler (if enabled)
+	'uncaught_exception'       => 'استثناء مدیریت نشده :message',
+	// we talking API call here, hence we have http_not_found
+	'http_exception'           => 'استثناء HTTP :message',
 
-    // HttpException handler (added in 6.4.0)
-    // Error messages for HttpException caught w/o custom messages
-    // https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
-    'http_400'                 => 'Bad Request',
-    'http_401'                 => 'اجازه دسترسی ندارید',
-    'http_402'                 => 'Payment Required',
-    'http_403'                 => 'Forbidden',
-    'http_404'                 => 'Not Found',
-    'http_405'                 => 'Method Not Allowed',
-    'http_406'                 => 'Not Acceptable',
-    'http_407'                 => 'Proxy Authentication Required',
-    'http_408'                 => 'Request Timeout',
-    'http_409'                 => 'Conflict',
-    'http_410'                 => 'Gone',
-    'http_411'                 => 'Length Required',
-    'http_412'                 => 'Precondition Failed',
-    'http_413'                 => 'Payload Too Large',
-    'http_414'                 => 'URI Too Long',
-    'http_415'                 => 'Unsupported Media Type',
-    'http_416'                 => 'Range Not Satisfiable',
-    'http_417'                 => 'Expectation Failed',
-    'http_421'                 => 'Misdirected Request',
-    'http_422'                 => 'داده معتبر نیست',
-    'http_423'                 => 'Locked',
-    'http_424'                 => 'Failed Dependency',
-    'http_425'                 => 'Too Early',
-    'http_426'                 => 'Upgrade Required',
-    'http_428'                 => 'Precondition Required',
-    'http_429'                 => 'Too Many Requests',
-    'http_431'                 => 'Request Header Fields Too Large',
-    'http_451'                 => 'Unavailable For Legal Reasons',
-    'http_500'                 => 'Internal Server Error',
-    'http_501'                 => 'Not Implemented',
-    'http_502'                 => 'Bad Gateway',
-    'http_503'                 => 'Service Unavailable',
-    'http_504'                 => 'Gateway Timeout',
-    'http_505'                 => 'HTTP Version Not Supported',
-    'http_506'                 => 'Variant Also Negotiates',
-    'http_507'                 => 'Insufficient Storage',
-    'http_508'                 => 'Loop Detected',
-    'http_509'                 => 'Unassigned',
-    'http_510'                 => 'Not Extended',
-    'http_511'                 => 'Network Authentication Required',
+	// HttpException handler (added in 6.4.0)
+	// Error messages for HttpException caught w/o custom messages
+	// https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
+	'http_400'                 => 'Bad Request',
+	'http_401'                 => 'اجازه دسترسی ندارید',
+	'http_402'                 => 'Payment Required',
+	'http_403'                 => 'Forbidden',
+	'http_404'                 => 'Not Found',
+	'http_405'                 => 'Method Not Allowed',
+	'http_406'                 => 'Not Acceptable',
+	'http_407'                 => 'Proxy Authentication Required',
+	'http_408'                 => 'Request Timeout',
+	'http_409'                 => 'Conflict',
+	'http_410'                 => 'Gone',
+	'http_411'                 => 'Length Required',
+	'http_412'                 => 'Precondition Failed',
+	'http_413'                 => 'Payload Too Large',
+	'http_414'                 => 'URI Too Long',
+	'http_415'                 => 'Unsupported Media Type',
+	'http_416'                 => 'Range Not Satisfiable',
+	'http_417'                 => 'Expectation Failed',
+	'http_421'                 => 'Misdirected Request',
+	'http_422'                 => 'داده معتبر نیست',
+	'http_423'                 => 'Locked',
+	'http_424'                 => 'Failed Dependency',
+	'http_425'                 => 'Too Early',
+	'http_426'                 => 'Upgrade Required',
+	'http_428'                 => 'Precondition Required',
+	'http_429'                 => 'Too Many Requests',
+	'http_431'                 => 'Request Header Fields Too Large',
+	'http_451'                 => 'Unavailable For Legal Reasons',
+	'http_500'                 => 'Internal Server Error',
+	'http_501'                 => 'Not Implemented',
+	'http_502'                 => 'Bad Gateway',
+	'http_503'                 => 'Service Unavailable',
+	'http_504'                 => 'Gateway Timeout',
+	'http_505'                 => 'HTTP Version Not Supported',
+	'http_506'                 => 'Variant Also Negotiates',
+	'http_507'                 => 'Insufficient Storage',
+	'http_508'                 => 'Loop Detected',
+	'http_509'                 => 'Unassigned',
+	'http_510'                 => 'Not Extended',
+	'http_511'                 => 'Network Authentication Required',
 ];
 

src/Contracts/ConverterContract.php

Indentation +10 added lines, -10 removed lines

@@ -15,14 +15,14 @@
  */
 interface ConverterContract
 {
-    /**
-     * Returns array representation of the object.
-     *
-     * @param object $obj    Object to be converted
-     * @param array  $config Converter config array to be used for this object (based on exact class
-     *                       name match or inheritance).
-     *
-     * @return array
-     */
-    public function convert($obj, array $config): array;
+	/**
+	 * Returns array representation of the object.
+	 *
+	 * @param object $obj    Object to be converted
+	 * @param array  $config Converter config array to be used for this object (based on exact class
+	 *                       name match or inheritance).
+	 *
+	 * @return array
+	 */
+	public function convert($obj, array $config): array;
 }

src/BaseApiCodes.php

Indentation +189 added lines, -189 removed lines

@@ -21,194 +21,194 @@
  */
 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);
-    }
+	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);
+	}
 
 }

src/ResponseBuilderLegacy.php

Indentation +259 added lines, -259 removed lines

@@ -24,274 +24,274 @@
  */
 class ResponseBuilderLegacy extends ResponseBuilderBase
 {
-    /**
-     * Returns success
-     *
-     * @param object|array|null $data          Array of primitives and supported objects to be returned in 'data' node
-     *                                         of the JSON response, single supported object or @null if there's no
-     *                                         to be returned.
-     * @param integer|null      $api_code      API code to be returned or @null to use value of BaseApiCodes::OK().
-     * @param array|null        $placeholders  Placeholders passed to Lang::get() for message placeholders
-     *                                         substitution or @null if none.
-     * @param integer|null      $http_code     HTTP code to be used for HttpResponse sent or @null
-     *                                         for default DEFAULT_HTTP_CODE_OK.
-     * @param integer|null      $json_opts     See http://php.net/manual/en/function.json-encode.php for supported
-     *                                         options or pass @null to use value from your config (or defaults).
-     *
-     * @return HttpResponse
-     */
-    public static function success($data = null, $api_code = null, array $placeholders = null,
-                                   int $http_code = null, int $json_opts = null): HttpResponse
-    {
-        return ResponseBuilder::asSuccess($api_code)
-            ->withData($data)
-            ->withPlaceholders($placeholders)
-            ->withHttpCode($http_code)
-            ->withJsonOptions($json_opts)
-            ->build();
-    }
+	/**
+	 * Returns success
+	 *
+	 * @param object|array|null $data          Array of primitives and supported objects to be returned in 'data' node
+	 *                                         of the JSON response, single supported object or @null if there's no
+	 *                                         to be returned.
+	 * @param integer|null      $api_code      API code to be returned or @null to use value of BaseApiCodes::OK().
+	 * @param array|null        $placeholders  Placeholders passed to Lang::get() for message placeholders
+	 *                                         substitution or @null if none.
+	 * @param integer|null      $http_code     HTTP code to be used for HttpResponse sent or @null
+	 *                                         for default DEFAULT_HTTP_CODE_OK.
+	 * @param integer|null      $json_opts     See http://php.net/manual/en/function.json-encode.php for supported
+	 *                                         options or pass @null to use value from your config (or defaults).
+	 *
+	 * @return HttpResponse
+	 */
+	public static function success($data = null, $api_code = null, array $placeholders = null,
+								   int $http_code = null, int $json_opts = null): HttpResponse
+	{
+		return ResponseBuilder::asSuccess($api_code)
+			->withData($data)
+			->withPlaceholders($placeholders)
+			->withHttpCode($http_code)
+			->withJsonOptions($json_opts)
+			->build();
+	}
 
-    /**
-     * Returns success
-     *
-     * @param integer|null $api_code      API code to be returned or @null to use value of BaseApiCodes::OK().
-     * @param array|null   $placeholders  Placeholders passed to Lang::get() for message placeholders
-     *                                    substitution or @null if none.
-     * @param integer|null $http_code     HTTP code to be used for HttpResponse sent or @null
-     *                                    for default DEFAULT_HTTP_CODE_OK.
-     *
-     * @return HttpResponse
-     *
-     * @deprecated Please use Builder class.
-     */
-    public static function successWithCode(int $api_code = null, array $placeholders = null,
-                                           int $http_code = null): HttpResponse
-    {
-        return ResponseBuilder::asSuccess($api_code)
-            ->withPlaceholders($placeholders)
-            ->withHttpCode($http_code)
-            ->build();
-    }
+	/**
+	 * Returns success
+	 *
+	 * @param integer|null $api_code      API code to be returned or @null to use value of BaseApiCodes::OK().
+	 * @param array|null   $placeholders  Placeholders passed to Lang::get() for message placeholders
+	 *                                    substitution or @null if none.
+	 * @param integer|null $http_code     HTTP code to be used for HttpResponse sent or @null
+	 *                                    for default DEFAULT_HTTP_CODE_OK.
+	 *
+	 * @return HttpResponse
+	 *
+	 * @deprecated Please use Builder class.
+	 */
+	public static function successWithCode(int $api_code = null, array $placeholders = null,
+										   int $http_code = null): HttpResponse
+	{
+		return ResponseBuilder::asSuccess($api_code)
+			->withPlaceholders($placeholders)
+			->withHttpCode($http_code)
+			->build();
+	}
 
-    /**
-     * @param string            $message       Custom message to be returned as part of the response.
-     * @param object|array|null $data          Array of primitives and supported objects to be returned in 'data' node
-     *                                         of the JSON response, single supported object or @null if there's no
-     *                                         to be returned.
-     * @param integer|null      $http_code     HTTP code to be used for HttpResponse sent or @null
-     *                                         for default DEFAULT_HTTP_CODE_OK.
-     *
-     * @return HttpResponse
-     *
-     * @deprecated Please use Builder class.
-     */
-    public static function successWithMessage(string $message, $data = null, int $api_code = null,
-                                              int $http_code = null): HttpResponse
-    {
-        return ResponseBuilder::asSuccess($api_code)
-            ->withMessage($message)
-            ->withData($data)
-            ->withHttpCode($http_code)
-            ->build();
-    }
+	/**
+	 * @param string            $message       Custom message to be returned as part of the response.
+	 * @param object|array|null $data          Array of primitives and supported objects to be returned in 'data' node
+	 *                                         of the JSON response, single supported object or @null if there's no
+	 *                                         to be returned.
+	 * @param integer|null      $http_code     HTTP code to be used for HttpResponse sent or @null
+	 *                                         for default DEFAULT_HTTP_CODE_OK.
+	 *
+	 * @return HttpResponse
+	 *
+	 * @deprecated Please use Builder class.
+	 */
+	public static function successWithMessage(string $message, $data = null, int $api_code = null,
+											  int $http_code = null): HttpResponse
+	{
+		return ResponseBuilder::asSuccess($api_code)
+			->withMessage($message)
+			->withData($data)
+			->withHttpCode($http_code)
+			->build();
+	}
 
-    /**
-     * @param object|array|null $data          Array of primitives and supported objects to be returned in 'data' node.
-     *                                         of the JSON response, single supported object or @null if there's no
-     *                                         to be returned.
-     * @param integer|null      $api_code      API code to be returned or @null to use value of BaseApiCodes::OK().
-     * @param array|null        $placeholders  Placeholders passed to Lang::get() for message placeholders
-     *                                         substitution or @null if none.
-     * @param integer|null      $http_code     HTTP code to be used for HttpResponse sent or @null
-     *                                         for default DEFAULT_HTTP_CODE_OK.
-     * @param integer|null      $json_opts     See http://php.net/manual/en/function.json-encode.php for supported
-     *                                         options or pass @null to use value from your config (or defaults).
-     *
-     * @return HttpResponse
-     *
-     * @deprecated Please use Builder class.
-     */
-    public static function successWithHttpCode(int $http_code = null): HttpResponse
-    {
-        return ResponseBuilder::asSuccess()
-            ->withHttpCode($http_code)
-            ->build();
-    }
+	/**
+	 * @param object|array|null $data          Array of primitives and supported objects to be returned in 'data' node.
+	 *                                         of the JSON response, single supported object or @null if there's no
+	 *                                         to be returned.
+	 * @param integer|null      $api_code      API code to be returned or @null to use value of BaseApiCodes::OK().
+	 * @param array|null        $placeholders  Placeholders passed to Lang::get() for message placeholders
+	 *                                         substitution or @null if none.
+	 * @param integer|null      $http_code     HTTP code to be used for HttpResponse sent or @null
+	 *                                         for default DEFAULT_HTTP_CODE_OK.
+	 * @param integer|null      $json_opts     See http://php.net/manual/en/function.json-encode.php for supported
+	 *                                         options or pass @null to use value from your config (or defaults).
+	 *
+	 * @return HttpResponse
+	 *
+	 * @deprecated Please use Builder class.
+	 */
+	public static function successWithHttpCode(int $http_code = null): HttpResponse
+	{
+		return ResponseBuilder::asSuccess()
+			->withHttpCode($http_code)
+			->build();
+	}
 
-    /**
-     * Builds error Response object. Supports optional arguments passed to Lang::get() if associated error
-     * message uses placeholders as well as return data payload
-     *
-     * @param integer           $api_code      Your API code to be returned with the response object.
-     * @param array|null        $placeholders  Placeholders passed to Lang::get() for message placeholders
-     *                                         substitution or @null if none.
-     * @param object|array|null $data          Array of primitives and supported objects to be returned in 'data' node
-     *                                         of the JSON response, single supported object or @null if there's no
-     *                                         to be returned.
-     * @param integer|null      $http_code     HTTP code to be used for HttpResponse sent or @null
-     *                                         for default DEFAULT_HTTP_CODE_ERROR.
-     * @param integer|null      $json_opts     See http://php.net/manual/en/function.json-encode.php for supported
-     *                                         options or pass @null to use value from your config (or defaults).
-     *
-     * @return HttpResponse
-     */
-    public static function error(int $api_code, array $placeholders = null, $data = null, int $http_code = null,
-                                 int $json_opts = null): HttpResponse
-    {
-        return ResponseBuilder::asError($api_code)
-            ->withPlaceholders($placeholders)
-            ->withData($data)
-            ->withHttpCode($http_code)
-            ->withJsonOptions($json_opts)
-            ->build();
-    }
+	/**
+	 * Builds error Response object. Supports optional arguments passed to Lang::get() if associated error
+	 * message uses placeholders as well as return data payload
+	 *
+	 * @param integer           $api_code      Your API code to be returned with the response object.
+	 * @param array|null        $placeholders  Placeholders passed to Lang::get() for message placeholders
+	 *                                         substitution or @null if none.
+	 * @param object|array|null $data          Array of primitives and supported objects to be returned in 'data' node
+	 *                                         of the JSON response, single supported object or @null if there's no
+	 *                                         to be returned.
+	 * @param integer|null      $http_code     HTTP code to be used for HttpResponse sent or @null
+	 *                                         for default DEFAULT_HTTP_CODE_ERROR.
+	 * @param integer|null      $json_opts     See http://php.net/manual/en/function.json-encode.php for supported
+	 *                                         options or pass @null to use value from your config (or defaults).
+	 *
+	 * @return HttpResponse
+	 */
+	public static function error(int $api_code, array $placeholders = null, $data = null, int $http_code = null,
+								 int $json_opts = null): HttpResponse
+	{
+		return ResponseBuilder::asError($api_code)
+			->withPlaceholders($placeholders)
+			->withData($data)
+			->withHttpCode($http_code)
+			->withJsonOptions($json_opts)
+			->build();
+	}
 
-    /**
-     * @param integer           $api_code      Your API code to be returned with the response object.
-     * @param object|array|null $data          Array of primitives and supported objects to be returned in 'data' node
-     *                                         of the JSON response, single supported object or @null if there's no
-     *                                         to be returned.
-     * @param array|null        $placeholders  Placeholders passed to Lang::get() for message placeholders
-     *                                         substitution or @null if none.
-     * @param integer|null      $json_opts     See http://php.net/manual/en/function.json-encode.php for supported
-     *                                         options or pass @null to use value from your config (or defaults).
-     *
-     * @return HttpResponse
-     *
-     * @deprecated Please use Builder class.
-     */
-    public static function errorWithData(int $api_code, $data, array $placeholders = null,
-                                         int $json_opts = null): HttpResponse
-    {
-        return ResponseBuilder::asError($api_code)
-            ->withData($data)
-            ->withPlaceholders($placeholders)
-            ->withJsonOptions($json_opts)
-            ->build();
-    }
+	/**
+	 * @param integer           $api_code      Your API code to be returned with the response object.
+	 * @param object|array|null $data          Array of primitives and supported objects to be returned in 'data' node
+	 *                                         of the JSON response, single supported object or @null if there's no
+	 *                                         to be returned.
+	 * @param array|null        $placeholders  Placeholders passed to Lang::get() for message placeholders
+	 *                                         substitution or @null if none.
+	 * @param integer|null      $json_opts     See http://php.net/manual/en/function.json-encode.php for supported
+	 *                                         options or pass @null to use value from your config (or defaults).
+	 *
+	 * @return HttpResponse
+	 *
+	 * @deprecated Please use Builder class.
+	 */
+	public static function errorWithData(int $api_code, $data, array $placeholders = null,
+										 int $json_opts = null): HttpResponse
+	{
+		return ResponseBuilder::asError($api_code)
+			->withData($data)
+			->withPlaceholders($placeholders)
+			->withJsonOptions($json_opts)
+			->build();
+	}
 
-    /**
-     * @param integer           $api_code      Your API code to be returned with the response object.
-     * @param object|array|null $data          Array of primitives and supported objects to be returned in 'data' node
-     *                                         of the JSON response, single supported object or @null if there's no
-     *                                         to be returned.
-     * @param integer           $http_code     HTTP code to be used for HttpResponse sent.
-     * @param array|null        $placeholders  Placeholders passed to Lang::get() for message placeholders
-     *                                         substitution or @null if none.
-     * @param integer|null      $json_opts     See http://php.net/manual/en/function.json-encode.php for supported
-     *                                         options or pass @null to use value from your config (or defaults).
-     *
-     * @return HttpResponse
-     *
-     * @throws \InvalidArgumentException if http_code is @null
-     *
-     * @deprecated Please use Builder class.
-     */
-    public static function errorWithDataAndHttpCode(int $api_code, $data, int $http_code, array $placeholders = null,
-                                                    int $json_opts = null): HttpResponse
-    {
-        return ResponseBuilder::asError($api_code)
-            ->withData($data)
-            ->withHttpCode($http_code)
-            ->withPlaceholders($placeholders)
-            ->withJsonOptions($json_opts)
-            ->build();
-    }
+	/**
+	 * @param integer           $api_code      Your API code to be returned with the response object.
+	 * @param object|array|null $data          Array of primitives and supported objects to be returned in 'data' node
+	 *                                         of the JSON response, single supported object or @null if there's no
+	 *                                         to be returned.
+	 * @param integer           $http_code     HTTP code to be used for HttpResponse sent.
+	 * @param array|null        $placeholders  Placeholders passed to Lang::get() for message placeholders
+	 *                                         substitution or @null if none.
+	 * @param integer|null      $json_opts     See http://php.net/manual/en/function.json-encode.php for supported
+	 *                                         options or pass @null to use value from your config (or defaults).
+	 *
+	 * @return HttpResponse
+	 *
+	 * @throws \InvalidArgumentException if http_code is @null
+	 *
+	 * @deprecated Please use Builder class.
+	 */
+	public static function errorWithDataAndHttpCode(int $api_code, $data, int $http_code, array $placeholders = null,
+													int $json_opts = null): HttpResponse
+	{
+		return ResponseBuilder::asError($api_code)
+			->withData($data)
+			->withHttpCode($http_code)
+			->withPlaceholders($placeholders)
+			->withJsonOptions($json_opts)
+			->build();
+	}
 
-    /**
-     * @param integer    $api_code     Your API code to be returned with the response object.
-     * @param integer    $http_code    HTTP code to be used for HttpResponse sent or @null
-     *                                 for default DEFAULT_HTTP_CODE_ERROR.
-     * @param array|null $placeholders Placeholders passed to Lang::get() for message placeholders
-     *                                 substitution or @null if none.
-     *
-     * @return HttpResponse
-     *
-     * @throws \InvalidArgumentException if http_code is @null
-     *
-     * @deprecated Please use Builder class.
-     */
-    public static function errorWithHttpCode(int $api_code, int $http_code, array $placeholders = null): HttpResponse
-    {
-        return ResponseBuilder::asError($api_code)
-            ->withHttpCode($http_code)
-            ->withPlaceholders($placeholders)
-            ->build();
-    }
+	/**
+	 * @param integer    $api_code     Your API code to be returned with the response object.
+	 * @param integer    $http_code    HTTP code to be used for HttpResponse sent or @null
+	 *                                 for default DEFAULT_HTTP_CODE_ERROR.
+	 * @param array|null $placeholders Placeholders passed to Lang::get() for message placeholders
+	 *                                 substitution or @null if none.
+	 *
+	 * @return HttpResponse
+	 *
+	 * @throws \InvalidArgumentException if http_code is @null
+	 *
+	 * @deprecated Please use Builder class.
+	 */
+	public static function errorWithHttpCode(int $api_code, int $http_code, array $placeholders = null): HttpResponse
+	{
+		return ResponseBuilder::asError($api_code)
+			->withHttpCode($http_code)
+			->withPlaceholders($placeholders)
+			->build();
+	}
 
-    /**
-     * @param integer           $api_code  Your API code to be returned with the response object.
-     * @param string            $message   Custom message to be returned as part of error response
-     * @param object|array|null $data      Array of primitives and supported objects to be returned in 'data' node
-     *                                     of the JSON response, single supported object or @null if there's no
-     *                                     to be returned.
-     * @param integer|null      $http_code Optional HTTP status code to be used for HttpResponse sent
-     *                                     or @null for DEFAULT_HTTP_CODE_ERROR
-     * @param integer|null      $json_opts See http://php.net/manual/en/function.json-encode.php for supported
-     *                                     options or pass @null to use value from your config (or defaults).
-     *
-     * @return HttpResponse
-     *
-     * @deprecated Please use Builder class.
-     */
-    public static function errorWithMessageAndData(int $api_code, string $message, $data,
-                                                   int $http_code = null, int $json_opts = null): HttpResponse
-    {
-        return ResponseBuilder::asError($api_code)
-            ->withMessage($message)
-            ->withData($data)
-            ->withHttpCode($http_code)
-            ->withJsonOptions($json_opts)
-            ->build();
-    }
+	/**
+	 * @param integer           $api_code  Your API code to be returned with the response object.
+	 * @param string            $message   Custom message to be returned as part of error response
+	 * @param object|array|null $data      Array of primitives and supported objects to be returned in 'data' node
+	 *                                     of the JSON response, single supported object or @null if there's no
+	 *                                     to be returned.
+	 * @param integer|null      $http_code Optional HTTP status code to be used for HttpResponse sent
+	 *                                     or @null for DEFAULT_HTTP_CODE_ERROR
+	 * @param integer|null      $json_opts See http://php.net/manual/en/function.json-encode.php for supported
+	 *                                     options or pass @null to use value from your config (or defaults).
+	 *
+	 * @return HttpResponse
+	 *
+	 * @deprecated Please use Builder class.
+	 */
+	public static function errorWithMessageAndData(int $api_code, string $message, $data,
+												   int $http_code = null, int $json_opts = null): HttpResponse
+	{
+		return ResponseBuilder::asError($api_code)
+			->withMessage($message)
+			->withData($data)
+			->withHttpCode($http_code)
+			->withJsonOptions($json_opts)
+			->build();
+	}
 
-    /**
-     * @param integer           $api_code   Your API code to be returned with the response object.
-     * @param string            $message    custom message to be returned as part of error response
-     * @param object|array|null $data       Array of primitives and supported objects to be returned in 'data' node
-     *                                      of the JSON response, single supported object or @null if there's no
-     *                                      to be returned.
-     * @param integer|null      $http_code  HTTP code to be used for HttpResponse sent or @null
-     *                                      for default DEFAULT_HTTP_CODE_ERROR.
-     * @param integer|null      $json_opts  See http://php.net/manual/en/function.json-encode.php for supported
-     *                                      options or pass @null to use value from your config (or defaults).
-     * @param array|null        $debug_data optional debug data array to be added to returned JSON.
-     *
-     * @return HttpResponse
-     *
-     * @deprecated Please use Builder class.
-     *
-     * @noinspection PhpTooManyParametersInspection
-     */
-    public static function errorWithMessageAndDataAndDebug(int $api_code, string $message, $data,
-                                                           int $http_code = null, int $json_opts = null,
-                                                           array $debug_data = null): HttpResponse
-    {
-        return ResponseBuilder::asError($api_code)
-            ->withMessage($message)
-            ->withData($data)
-            ->withHttpCode($http_code)
-            ->withJsonOptions($json_opts)
-            ->withDebugData($debug_data)
-            ->build();
-    }
+	/**
+	 * @param integer           $api_code   Your API code to be returned with the response object.
+	 * @param string            $message    custom message to be returned as part of error response
+	 * @param object|array|null $data       Array of primitives and supported objects to be returned in 'data' node
+	 *                                      of the JSON response, single supported object or @null if there's no
+	 *                                      to be returned.
+	 * @param integer|null      $http_code  HTTP code to be used for HttpResponse sent or @null
+	 *                                      for default DEFAULT_HTTP_CODE_ERROR.
+	 * @param integer|null      $json_opts  See http://php.net/manual/en/function.json-encode.php for supported
+	 *                                      options or pass @null to use value from your config (or defaults).
+	 * @param array|null        $debug_data optional debug data array to be added to returned JSON.
+	 *
+	 * @return HttpResponse
+	 *
+	 * @deprecated Please use Builder class.
+	 *
+	 * @noinspection PhpTooManyParametersInspection
+	 */
+	public static function errorWithMessageAndDataAndDebug(int $api_code, string $message, $data,
+														   int $http_code = null, int $json_opts = null,
+														   array $debug_data = null): HttpResponse
+	{
+		return ResponseBuilder::asError($api_code)
+			->withMessage($message)
+			->withData($data)
+			->withHttpCode($http_code)
+			->withJsonOptions($json_opts)
+			->withDebugData($debug_data)
+			->build();
+	}
 
-    /**
-     * @param integer      $api_code  Your API code to be returned with the response object.
-     * @param string       $message   Custom message to be returned as part of error response
-     * @param integer|null $http_code HTTP code to be used with final response sent or @null
-     *                                for default DEFAULT_HTTP_CODE_ERROR.
-     *
-     * @return HttpResponse
-     *
-     * @deprecated Please use Builder class.
-     */
-    public static function errorWithMessage(int $api_code, string $message, int $http_code = null): HttpResponse
-    {
-        return ResponseBuilder::asError($api_code)
-            ->withMessage($message)
-            ->withHttpCode($http_code)
-            ->build();
-    }
+	/**
+	 * @param integer      $api_code  Your API code to be returned with the response object.
+	 * @param string       $message   Custom message to be returned as part of error response
+	 * @param integer|null $http_code HTTP code to be used with final response sent or @null
+	 *                                for default DEFAULT_HTTP_CODE_ERROR.
+	 *
+	 * @return HttpResponse
+	 *
+	 * @deprecated Please use Builder class.
+	 */
+	public static function errorWithMessage(int $api_code, string $message, int $http_code = null): HttpResponse
+	{
+		return ResponseBuilder::asError($api_code)
+			->withMessage($message)
+			->withHttpCode($http_code)
+			->build();
+	}
 
 }

src/Validator.php

Indentation +179 added lines, -179 removed lines

@@ -15,183 +15,183 @@
  */
 class Validator
 {
-    /** @var string */
-    public const TYPE_STRING = 'string';
-
-    /** @var string */
-    public const TYPE_INTEGER = 'integer';
-
-    /** @var string */
-    public const TYPE_BOOL = 'boolean';
-
-    /** @var string */
-    public const TYPE_ARRAY = 'array';
-
-    /** @var string */
-    public const TYPE_OBJECT = 'object';
-
-    /** @var string */
-    public const TYPE_NULL = 'NULL';
-
-    /**
-     * Checks if given $val is of type boolean
-     *
-     * @param string $key Name of the key to be used if exception is thrown.
-     * @param mixed  $var Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsBool(string $key, $var): void
-    {
-        self::assertIsType($key, $var, [self::TYPE_BOOL]);
-    }
-
-    /**
-     * Checks if given $val is of type integer
-     *
-     * @param string $key Name of the key to be used if exception is thrown.
-     * @param mixed  $var Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsInt(string $key, $var): void
-    {
-        self::assertIsType($key, $var, [self::TYPE_INTEGER]);
-    }
-
-    /**
-     * Checks if given $val is of type array
-     *
-     * @param string $key Name of the key to be used if exception is thrown.
-     * @param mixed  $var Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsArray(string $key, $var): void
-    {
-        self::assertIsType($key, $var, [self::TYPE_ARRAY]);
-    }
-
-    /**
-     * Checks if given $val is an object
-     *
-     * @param string $key Name of the key to be used if exception is thrown.
-     * @param mixed  $var Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsObject(string $key, $var): void
-    {
-        self::assertIsType($key, $var, [self::TYPE_OBJECT]);
-    }
-
-    /**
-     * Checks if given $val is of type string
-     *
-     * @param string $name Label or name of the variable to be used in exception message (if thrown).
-     * @param mixed  $var  Variable to be asserted.
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsString(string $name, $var): void
-    {
-        self::assertIsType($name, $var, [self::TYPE_STRING]);
-    }
-
-    /**
-     * @param string $name Label or name of the variable to be used in exception message (if thrown).
-     * @param mixed  $var  Variable to be asserted.
-     * @param int    $min  Min allowed value (inclusive)
-     * @param int    $max  Max allowed value (inclusive)
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     * @throws \RuntimeException
-     */
-    public static function assertIsIntRange(string $name, $var, int $min, int $max): void
-    {
-        self::assertIsInt($name, $var);
-
-        if ($min > $max) {
-            throw new \RuntimeException(
-                \sprintf('%s: Invalid range for "%s". Ensure bound values are not swapped.', __FUNCTION__, $name));
-        }
-
-        if (($min > $var) || ($var > $max)) {
-            throw new \InvalidArgumentException(
-                \sprintf('Invalid value of "%s" (%d). Must be between %d-%d inclusive.', $name, $var, $min, $max));
-        }
-    }
-
-    /**
-     * Checks if $item (of name $key) is of type that is include in $allowed_types.
-     *
-     * @param string $name          Label or name of the variable to be used in exception message (if thrown).
-     * @param mixed  $var           Variable to be asserted.
-     * @param array  $allowed_types Array of allowed types for $var, i.e. [Validator::TYPE_INTEGER]
-     *
-     * @return void
-     *
-     * @throws \InvalidArgumentException
-     */
-    public static function assertIsType(string $name, $var, array $allowed_types): void
-    {
-        $type = \gettype($var);
-        if (!\in_array($type, $allowed_types)) {
-            throw new \InvalidArgumentException(
-                \sprintf('"%s" must be one of allowed types: %s (%s given)',
-                    $name, implode(', ', $allowed_types), gettype($var))
-            );
-        }
-    }
-
-    /**
-     * Ensures given $http_code is valid code for error response.
-     *
-     * @param int $http_code
-     */
-    public static function assertErrorHttpCode(int $http_code): void
-    {
-        self::assertIsInt('http_code', $http_code);
-        self::assertIsIntRange('http_code', $http_code,
-            ResponseBuilder::ERROR_HTTP_CODE_MIN, ResponseBuilder::ERROR_HTTP_CODE_MAX);
-    }
-
-    /**
-     * Ensures given $http_code is valid for response indicating sucessful operation.
-     *
-     * @param int $http_code
-     */
-    public static function assertOkHttpCode(int $http_code): void
-    {
-        self::assertIsInt('http_code', $http_code);
-        self::assertIsIntRange('http_code', $http_code, 200, 299);
-    }
-
-    /**
-     * Ensures $obj is instance of $cls.
-     *
-     * @param string $name
-     * @param object $obj
-     * @param string $cls
-     */
-    public static function assertInstanceOf(string $name, object $obj, string $cls): void
-    {
-        if (!($obj instanceof $cls)) {
-            throw new \InvalidArgumentException(
-                \sprintf('"%s" must be instance of "%s".', $name, $cls)
-            );
-        }
-    }
+	/** @var string */
+	public const TYPE_STRING = 'string';
+
+	/** @var string */
+	public const TYPE_INTEGER = 'integer';
+
+	/** @var string */
+	public const TYPE_BOOL = 'boolean';
+
+	/** @var string */
+	public const TYPE_ARRAY = 'array';
+
+	/** @var string */
+	public const TYPE_OBJECT = 'object';
+
+	/** @var string */
+	public const TYPE_NULL = 'NULL';
+
+	/**
+	 * Checks if given $val is of type boolean
+	 *
+	 * @param string $key Name of the key to be used if exception is thrown.
+	 * @param mixed  $var Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsBool(string $key, $var): void
+	{
+		self::assertIsType($key, $var, [self::TYPE_BOOL]);
+	}
+
+	/**
+	 * Checks if given $val is of type integer
+	 *
+	 * @param string $key Name of the key to be used if exception is thrown.
+	 * @param mixed  $var Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsInt(string $key, $var): void
+	{
+		self::assertIsType($key, $var, [self::TYPE_INTEGER]);
+	}
+
+	/**
+	 * Checks if given $val is of type array
+	 *
+	 * @param string $key Name of the key to be used if exception is thrown.
+	 * @param mixed  $var Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsArray(string $key, $var): void
+	{
+		self::assertIsType($key, $var, [self::TYPE_ARRAY]);
+	}
+
+	/**
+	 * Checks if given $val is an object
+	 *
+	 * @param string $key Name of the key to be used if exception is thrown.
+	 * @param mixed  $var Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsObject(string $key, $var): void
+	{
+		self::assertIsType($key, $var, [self::TYPE_OBJECT]);
+	}
+
+	/**
+	 * Checks if given $val is of type string
+	 *
+	 * @param string $name Label or name of the variable to be used in exception message (if thrown).
+	 * @param mixed  $var  Variable to be asserted.
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsString(string $name, $var): void
+	{
+		self::assertIsType($name, $var, [self::TYPE_STRING]);
+	}
+
+	/**
+	 * @param string $name Label or name of the variable to be used in exception message (if thrown).
+	 * @param mixed  $var  Variable to be asserted.
+	 * @param int    $min  Min allowed value (inclusive)
+	 * @param int    $max  Max allowed value (inclusive)
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 * @throws \RuntimeException
+	 */
+	public static function assertIsIntRange(string $name, $var, int $min, int $max): void
+	{
+		self::assertIsInt($name, $var);
+
+		if ($min > $max) {
+			throw new \RuntimeException(
+				\sprintf('%s: Invalid range for "%s". Ensure bound values are not swapped.', __FUNCTION__, $name));
+		}
+
+		if (($min > $var) || ($var > $max)) {
+			throw new \InvalidArgumentException(
+				\sprintf('Invalid value of "%s" (%d). Must be between %d-%d inclusive.', $name, $var, $min, $max));
+		}
+	}
+
+	/**
+	 * Checks if $item (of name $key) is of type that is include in $allowed_types.
+	 *
+	 * @param string $name          Label or name of the variable to be used in exception message (if thrown).
+	 * @param mixed  $var           Variable to be asserted.
+	 * @param array  $allowed_types Array of allowed types for $var, i.e. [Validator::TYPE_INTEGER]
+	 *
+	 * @return void
+	 *
+	 * @throws \InvalidArgumentException
+	 */
+	public static function assertIsType(string $name, $var, array $allowed_types): void
+	{
+		$type = \gettype($var);
+		if (!\in_array($type, $allowed_types)) {
+			throw new \InvalidArgumentException(
+				\sprintf('"%s" must be one of allowed types: %s (%s given)',
+					$name, implode(', ', $allowed_types), gettype($var))
+			);
+		}
+	}
+
+	/**
+	 * Ensures given $http_code is valid code for error response.
+	 *
+	 * @param int $http_code
+	 */
+	public static function assertErrorHttpCode(int $http_code): void
+	{
+		self::assertIsInt('http_code', $http_code);
+		self::assertIsIntRange('http_code', $http_code,
+			ResponseBuilder::ERROR_HTTP_CODE_MIN, ResponseBuilder::ERROR_HTTP_CODE_MAX);
+	}
+
+	/**
+	 * Ensures given $http_code is valid for response indicating sucessful operation.
+	 *
+	 * @param int $http_code
+	 */
+	public static function assertOkHttpCode(int $http_code): void
+	{
+		self::assertIsInt('http_code', $http_code);
+		self::assertIsIntRange('http_code', $http_code, 200, 299);
+	}
+
+	/**
+	 * Ensures $obj is instance of $cls.
+	 *
+	 * @param string $name
+	 * @param object $obj
+	 * @param string $cls
+	 */
+	public static function assertInstanceOf(string $name, object $obj, string $cls): void
+	{
+		if (!($obj instanceof $cls)) {
+			throw new \InvalidArgumentException(
+				\sprintf('"%s" must be instance of "%s".', $name, $cls)
+			);
+		}
+	}
 }

src/ResponseBuilder.php

Indentation +12 added lines, -12 removed lines

@@ -84,7 +84,7 @@ 
 	 * @return HttpResponse
 	 */
 	public static function success($data = null, $api_code = null, array $placeholders = null,
-	                               int $http_code = null, int $json_opts = null): HttpResponse
+								   int $http_code = null, int $json_opts = null): HttpResponse
 	{
 		return ResponseBuilder::asSuccess($api_code)
 			->withData($data)
@@ -112,7 +112,7 @@ 
 	 * @return HttpResponse
 	 */
 	public static function error(int $api_code, array $placeholders = null, $data = null, int $http_code = null,
-	                             int $json_opts = null): HttpResponse
+								 int $json_opts = null): HttpResponse
 	{
 		return ResponseBuilder::asError($api_code)
 			->withPlaceholders($placeholders)
@@ -161,7 +161,7 @@ 
 	public function withHttpCode(int $http_code = null): self
 	{
 		Validator::assertIsType('http_code', $http_code, [Validator::TYPE_INTEGER,
-		                                                  Validator::TYPE_NULL]);
+														  Validator::TYPE_NULL]);
 		$this->http_code = $http_code;
 
 		return $this;
@@ -175,8 +175,8 @@ 
 	public function withData($data = null): self
 	{
 		Validator::assertIsType('data', $data, [Validator::TYPE_ARRAY,
-		                                        Validator::TYPE_OBJECT,
-		                                        Validator::TYPE_NULL]);
+												Validator::TYPE_OBJECT,
+												Validator::TYPE_NULL]);
 		$this->data = $data;
 
 		return $this;
@@ -190,7 +190,7 @@ 
 	public function withJsonOptions(int $json_opts = null): self
 	{
 		Validator::assertIsType('json_opts', $json_opts, [Validator::TYPE_INTEGER,
-		                                                  Validator::TYPE_NULL]);
+														  Validator::TYPE_NULL]);
 		$this->json_opts = $json_opts;
 
 		return $this;
@@ -204,7 +204,7 @@ 
 	public function withDebugData(array $debug_data = null): self
 	{
 		Validator::assertIsType('$debug_data', $debug_data, [Validator::TYPE_ARRAY,
-		                                                     Validator::TYPE_NULL]);
+															 Validator::TYPE_NULL]);
 		$this->debug_data = $debug_data;
 
 		return $this;
@@ -218,7 +218,7 @@ 
 	public function withMessage(string $msg = null): self
 	{
 		Validator::assertIsType('message', $msg, [Validator::TYPE_STRING,
-		                                          Validator::TYPE_NULL]);
+												  Validator::TYPE_NULL]);
 		$this->message = $msg;
 
 		return $this;
@@ -305,8 +305,8 @@ 
 	 * @noinspection PhpTooManyParametersInspection
 	 */
 	protected function make(bool $success, int $api_code, $msg_or_api_code, $data = null,
-	                        int $http_code = null, array $placeholders = null, array $http_headers = null,
-	                        int $json_opts = null, array $debug_data = null): HttpResponse
+							int $http_code = null, array $placeholders = null, array $http_headers = null,
+							int $json_opts = null, array $debug_data = null): HttpResponse
 	{
 		$http_headers = $http_headers ?? [];
 		$http_code = $http_code ?? ($success ? ResponseBuilder::DEFAULT_HTTP_CODE_OK : ResponseBuilder::DEFAULT_HTTP_CODE_ERROR);
@@ -345,8 +345,8 @@ 
 	 * @noinspection PhpTooManyParametersInspection
 	 */
 	protected function buildResponse(bool $success, int $api_code,
-	                                 $msg_or_api_code, array $placeholders = null,
-	                                 $data = null, array $debug_data = null): array
+									 $msg_or_api_code, array $placeholders = null,
+									 $data = null, array $debug_data = null): array
 	{
 		// ensure $data is either @null, array or object of class with configured mapping.
 		$data = (new Converter())->convert($data);

src/ResponseBuilderServiceProvider.php

Indentation +44 added lines, -44 removed lines

@@ -25,56 +25,56 @@
 
 class ResponseBuilderServiceProvider extends ServiceProvider
 {
-    protected $config_files = [
-        'response_builder.php',
-    ];
+	protected $config_files = [
+		'response_builder.php',
+	];
 
-    /**
-     * Register bindings in the container.
-     *
-     * @return void
-     */
-    public function register()
-    {
-        foreach ($this->config_files as $file) {
-            $this->mergeConfigFrom(__DIR__ . "/../config/{$file}", ResponseBuilder::CONF_CONFIG);
-        }
-    }
+	/**
+	 * Register bindings in the container.
+	 *
+	 * @return void
+	 */
+	public function register()
+	{
+		foreach ($this->config_files as $file) {
+			$this->mergeConfigFrom(__DIR__ . "/../config/{$file}", ResponseBuilder::CONF_CONFIG);
+		}
+	}
 
-    /**
-     * Sets up package resources
-     *
-     * @return void
-     */
-    public function boot()
-    {
-        $this->loadTranslationsFrom(__DIR__ . '/lang', 'response-builder');
+	/**
+	 * Sets up package resources
+	 *
+	 * @return void
+	 */
+	public function boot()
+	{
+		$this->loadTranslationsFrom(__DIR__ . '/lang', 'response-builder');
 
-        foreach ($this->config_files as $file) {
-            $this->publishes([__DIR__ . "/../config/{$file}" => config_path($file)]);
-        }
-    }
+		foreach ($this->config_files as $file) {
+			$this->publishes([__DIR__ . "/../config/{$file}" => config_path($file)]);
+		}
+	}
 
-    /**
-     * Merge the given configuration with the existing configuration.
-     *
-     * @param string $path
-     * @param string $key
-     *
-     * @return void
-     */
-    protected function mergeConfigFrom($path, $key)
-    {
-        $defaults = require $path;
-        $config = $this->app['config']->get($key, []);
+	/**
+	 * Merge the given configuration with the existing configuration.
+	 *
+	 * @param string $path
+	 * @param string $key
+	 *
+	 * @return void
+	 */
+	protected function mergeConfigFrom($path, $key)
+	{
+		$defaults = require $path;
+		$config = $this->app['config']->get($key, []);
 
-        $merged_config = Util::mergeConfig($defaults, $config);
+		$merged_config = Util::mergeConfig($defaults, $config);
 
-        if (\array_key_exists('converter', $merged_config)) {
-            Util::sortArrayByPri($merged_config['converter']);
-        }
+		if (\array_key_exists('converter', $merged_config)) {
+			Util::sortArrayByPri($merged_config['converter']);
+		}
 
-        $this->app['config']->set($key, $merged_config);
-    }
+		$this->app['config']->set($key, $merged_config);
+	}
 
 }