MedianetDev\LaravelAuthApi\Http\Helpers\ApiResponse

Complexity

Total Complexity

4

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	buildResponse()	0	8	1
A	__construct()	0	6	2
A	send()	0	3	1

<?php

namespace MedianetDev\LaravelAuthApi\Http\Helpers;

use Symfony\Component\HttpFoundation\Response as ResponseCode;

class ApiResponse
{
    /**
     * @var array
     */
    private $data;

    /**
     * @var bool
     */
    private $status;

    /**
     * @var int
     */
    private $responseCode;

    /**
     * @var string
     */
    private $message;

    private function __construct($data, $status, $responseCode, $message)
    {
        $this->data = $data;
        $this->status = $status;
        $this->responseCode = $responseCode;
        $this->message = $message ?: ResponseCode::$statusTexts[$responseCode];
    }

    /**
     * setup, build and return the response.
     *
     * @param array  $data         An array of returned data
     * @param int    $status       true or false for the operation status
     * @param int    $responseCode the Http response code
     * @param string $message      response message
     *
     * @return \Illuminate\Http\Response
     */
    public static function send($data, $status = true, $responseCode = ResponseCode::HTTP_OK, string $message = '')
    {
        return (new static($data, $status, $responseCode, $message))->buildResponse();
    }

    /**
     * build the response.
     *
     * @return \Illuminate\Http\Response
     */
    private function buildResponse()
    {
        return response()->json([

The expression return response()->json(array('base_url' => URL::to('/'), 'status' => (bool)$this->status, 'message' => $this->message, 'data' => $this->data), $this->responseCode) returns the type Illuminate\Http\JsonResponse which is incompatible with the documented return type Illuminate\Http\Response.

            'base_url' => \URL::to('/'),
            'status' => (bool) $this->status,
            'message' => $this->message,
            'data' => $this->data,
        ], $this->responseCode);
    }
}