Flugg\Responder\Http\ResponseBuilder

Complexity

Total Complexity

13

Size/Duplication

Total Lines	182
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	respond()	0	12	2
A	setStatus()	0	6	1
	isSuccessResponse()	0	1	?
A	setIncludeSuccessFlag()	0	6	1
A	setIncludeStatusCode()	0	6	1
A	toCollection()	0	4	1
A	toJson()	0	4	1
A	jsonSerialize()	0	4	1
	toArray()	0	1	?
A	includeSuccessFlag()	0	8	2
A	includeStatusCode()	0	8	2

<?php

namespace Flugg\Responder\Http;

use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Jsonable;
use Illuminate\Http\JsonResponse;
use Illuminate\Support\Collection;
use JsonSerializable;

/**
 * This class is an abstract response builder and hold common functionality the success-
 * and error response buuilder classes.
 *
 * @package flugger/laravel-responder
 * @author  Alexander Tømmerås <flugged@gmail.com>
 * @license The MIT License
 */
abstract class ResponseBuilder implements Arrayable, Jsonable, JsonSerializable
{

    /**
     * Flag indicating if success flag should be added to the serialized data.
     *
     * @var bool
     */
    protected $includeSuccessFlag;

    /**
     * Flag indicating if status code should be added to the serialized data.
     *
     * @var bool
     */
    protected $includeStatusCode;

    /**
     * The success flag property
     *
     * @var bool
     */
    protected $successFlag;

    /**
     * The HTTP status code for the response.
     *
     * @var int
     */
    protected $statusCode;

    /**
     * Response factory used to generate JSON responses.
     *
     * @var \Illuminate\Contracts\Routing\ResponseFactory|\Laravel\Lumen\Http\ResponseFactory $responseFactory
     */
    protected $responseFactory;

    /**
     * Constructor.
     *
     * @param \Illuminate\Contracts\Routing\ResponseFactory|\Laravel\Lumen\Http\ResponseFactory $responseFactory
     */
    public function __construct($responseFactory)
    {
        $this->responseFactory = $responseFactory;
    }

    /**
     * Serialize the data and wrap it in a JSON response object.
     *
     * @param  int|null $statusCode
     * @param  array    $headers
     * @return \Illuminate\Http\JsonResponse
     */
    public function respond(int $statusCode = null, array $headers = []):JsonResponse
    {
        if (! is_null($statusCode)) {
            $this->setStatus($statusCode);
        }

        $data = $this->toArray();
        $data = $this->includeStatusCode($data);
        $data = $this->includeSuccessFlag($data);

        return $this->responseFactory->json($data, $this->statusCode, $headers);
    }

    /**
     * Set the HTTP status code for the response.
     *
     * @param  int $statusCode
     * @return self
     */
    public function setStatus(int $statusCode):ResponseBuilder
    {
        $this->statusCode = $statusCode;

        return $this;
    }

    /**
     * Return response success flag
     *
     * @return bool
     */
    abstract public function isSuccessResponse():bool;

    /**
     * Set a flag indicating if success should be added to the response.
     *
     * @param  bool $includeSuccessFlag
     * @return self
     */
    public function setIncludeSuccessFlag(bool $includeSuccessFlag):ResponseBuilder
    {
        $this->includeSuccessFlag = $includeSuccessFlag;

        return $this;
    }

    /**
     * Set a flag indicating if status code should be added to the response.
     *
     * @param  bool $includeStatusCode
     * @return self
     */
    public function setIncludeStatusCode(bool $includeStatusCode):ResponseBuilder
    {
        $this->includeStatusCode = $includeStatusCode;

        return $this;
    }

    /**
     * Convert the response to an Illuminate collection.
     *
     * @return \Illuminate\Support\Collection
     */
    public function toCollection():Collection
    {
        return new Collection($this->toArray());
    }

    /**
     * Convert the response to JSON.
     *
     * @param  int $options
     * @return string
     */
    public function toJson($options = 0)
    {
        return json_encode($this->jsonSerialize(), $options);
    }

    /**
     * Convert the object into something JSON serializable.
     *
     * @return array
     */
    public function jsonSerialize()
    {
        return $this->toArray();
    }

    /**
     * Convert the response to an array.
     *
     * @return array
     */
    abstract public function toArray():array;

    /**
     * Include a status code to the serialized data if enabled.
     *
     * @param  array $data
     * @return array
     */
    protected function includeSuccessFlag(array $data):array
    {
        if (! $this->includeSuccessFlag) {
            return $data;
        }

        return array_merge(['success' => $this->isSuccessResponse()], $data);
    }

    /**
     * Include a status code to the serialized data if enabled.
     *
     * @param  array $data
     * @return array
     */
    protected function includeStatusCode(array $data):array
    {
        if (! $this->includeStatusCode) {
            return $data;
        }

        return array_merge(['status' => $this->statusCode], $data);
    }
}