bSecure\Payments\Helpers\ApiResponseHandler

Complexity

Total Complexity

9

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	send()	0	9	1
A	exception()	0	7	1
A	authenticationError()	0	8	1
A	validationError()	0	18	3
A	success()	0	8	1
A	failure()	0	7	2

<?php

namespace bSecure\Payments\Helpers;

use Illuminate\Http\JsonResponse;

The type Illuminate\Http\JsonResponse was not found. Maybe you did not declare it correctly or list all dependencies?

class ApiResponseHandler
{

    /**
     * @param array $body
     * @param string $message
     * @return JsonResponse
     */
    public static function success($body = [], $message = "messages.general.success")
    {

        return self::send(
            Http::$Codes[Http::SUCCESS],
            [Language::getMessage($message)],
            (object)$body,
            null
        );
    }

    /**
     * @param $validationErrors (coudle be array of errors or validator object)

The doc comment (coudle at position 1 could not be parsed: Expected ')' at position 1, but found 'coudle'.

     * @param string $message
     * @return JsonResponse
     */
    public static function validationError($validationErrors, $message = "general.validation")

The parameter $message is not used and could be removed.

    {

        $errorMessages = [];

        if (is_array($validationErrors)) {
            $errorMessages = array_values($validationErrors);
        } else {
            foreach ($validationErrors->getMessages() as $key => $errors) {
                $errorMessages = array_merge($errorMessages, $errors);
            }
        }

        return self::send(
            Http::$Codes[Http::INPROCESSABLE],
            $errorMessages,
            (object)[],
            null
        );
    }

    /**
     * @return JsonResponse
     */
    public static function authenticationError()
    {

        return self::send(
            Http::$Codes[Http::UNAUTHORISED],
            [Language::getMessage("general.unauthenticated")],
            (object)[],
            null
        );
    }

    /**
     * @param string $message
     * @param null $exception

Are you sure the doc-type for parameter $exception is correct as it would always require null to be passed?

     * @param array $body
     * @return JsonResponse
     */
    public static function failure($message = 'general.error', $exception = null, $body = [])
    {
        return self::send(
            Http::$Codes[Http::BAD_REQUEST],
            (gettype($message) == "array") ? $message : [Language::getMessage($message)],
            (object)$body,
            $exception
        );
    }

    /**
     * @param $code
     * @param $message
     * @param $exception
     * @return JsonResponse
     */

    public static function exception($code, $message, $exception = null)
    {
        return self::send(
            $code,
            [$message],
            [],
            $exception
        );
    }

    /**
     * @param $status
     * @param $message
     * @param $body
     * @param $exception
     * @return JsonResponse
     */
    private static function send($status, $message, $body, $exception)
    {

        return response()->json([

The function response was not found. Maybe you did not declare it correctly or list all dependencies?

            'status' => $status,
            'message' => $message,
            'body' => $body,
            'exception' => $exception
        ], $status, [], JSON_UNESCAPED_UNICODE);
    }
}