Bytesfield\KeyManager\Traits\ApiResponse

Complexity

Total Complexity

13

Size/Duplication

Total Lines	157
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	notFound()	0	4	1
A	badRequest()	0	4	1
A	failedValidation()	0	4	1
A	unauthorized()	0	4	1
A	methodNotAllowed()	0	4	1
A	failedDataCreation()	0	4	1
A	success()	0	4	1
A	actionSuccess()	0	4	1
A	error()	0	4	1
A	serverError()	0	4	1
A	forbidden()	0	4	1
A	buildResponse()	0	19	2

<?php

namespace Bytesfield\KeyManager\Traits;

use Bytesfield\KeyManager\Classes\Errors;
use Illuminate\Http\JsonResponse;

trait ApiResponse
{
    /**
     * Generates a not found response for a request.
     *
     * @param string $message
     * @return \Illuminate\Http\JsonResponse
     */
    public function notFound(string $message): JsonResponse
    {
        return $this->buildResponse($message, false, Errors::CODE['NOT_FOUND']);
    }

    /**
     * Generates a bad request response for a request.
     *
     * @param string $message
     * @return \Illuminate\Http\JsonResponse
     */
    public function badRequest(string $message): JsonResponse
    {
        return $this->buildResponse($message, false, Errors::CODE['BAD_REQUEST']);
    }

    /**
     * Generates a not found response for a request.
     *
     * @param string $message
     * @param array $errors
     * @return \Illuminate\Http\JsonResponse
     */
    public function failedValidation(string $message, array $errors = []): JsonResponse
    {
        return $this->buildResponse($message, false, Errors::CODE['VALIDATION_ERROR'], $errors);
    }

    /**
     * Generates an unauthorized response for a request.
     *
     * @param string $message.

There is no parameter named $message.. Did you maybe mean $message?

     * @return \Illuminate\Http\JsonResponse
     */
    public function unauthorized(string $message): JsonResponse
    {
        return $this->buildResponse($message, false, Errors::CODE['UNAUTHORIZED']);
    }

    /**
     * Generates a method not found response for a request.
     *
     * @param string $message
     * @return \Illuminate\Http\JsonResponse
     */
    public function methodNotAllowed(string $message): JsonResponse
    {
        return $this->buildResponse($message, false, Errors::CODE['METHOD_NOT_FOUND']);
    }

    /**
     * Generates a failed Data Creation response for a request.
     *
     * @param string $message
     * @return \Illuminate\Http\JsonResponse
     */
    public function failedDataCreation(string $message): JsonResponse
    {
        return $this->buildResponse($message, false, Errors::CODE['BAD_REQUEST']);
    }

    /**
     * Generates a success response for a request.
     *
     * @param string $message
     * @param array $data
     * @return \Illuminate\Http\JsonResponse
     */
    public function success(string $message, array $data = []): JsonResponse
    {
        return $this->buildResponse($message, true, Errors::CODE['OK'], $data);
    }

    /**
     * Generates a success response for a request.
     *
     * @param string $message
     * @param array $data
     * @return \Illuminate\Http\JsonResponse
     */
    public function actionSuccess(string $message, array $data = []): JsonResponse
    {
        return $this->buildResponse($message, true, Errors::CODE['OK'], $data);
    }

    /**
     * Generates an error response for a request.
     *
     * @param string $message
     * @return \Illuminate\Http\JsonResponse
     */
    public function error(string $message): JsonResponse
    {
        return $this->buildResponse($message, false, Errors::CODE['CONFLICT']);
    }

    /**
     * Generates a server error response for a request.
     *
     * @param string $message
     * @return \Illuminate\Http\JsonResponse
     */
    public function serverError(string $message): JsonResponse
    {
        return $this->buildResponse($message, false, Errors::CODE['SERVER_ERROR']);
    }

    /**
     * Generates a forbidden response for a request.
     *
     * @param string $message
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function forbidden(string $message): JsonResponse
    {
        return $this->buildResponse($message, false, Errors::CODE['FORBIDDEN']);
    }

    /**
     * Built a response for a request.
     *
     * @param string $message
     * @param bool $status
     * @param int $statusCode
     * @param array $data
     * @param array $headers
     * @return \Illuminate\Http\JsonResponse
     */
    private function buildResponse(
        string $message,
        bool $status,
        int $statusCode,
        array $data = [],
        array $headers = []

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

    ) {
        $responseData = [
            'status' => $status,
            'statusCode' => $statusCode,
            'message' => $message,
        ];

        if (! empty($data)) {
            $responseData['data'] = $data;
        }

        return new JsonResponse($responseData, $statusCode);
    }
}