MelquesPaiva\RestResponse\HttpResponse\Success

Complexity

Total Complexity

3

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	success()	0	7	1
A	noContent()	0	9	1
A	toArray()	0	5	1

<?php

/**
 * Rest Response
 *
 * @link        https://github.com/MelquesPaiva/rest-response for the canonical source repository
 * @copyright   Copyright (c) MelquesPaiva
 */

namespace MelquesPaiva\RestResponse\HttpResponse;

/**
 * Class Success
 * @package MelquesPaiva\RestResponse\HttpResponse
 */
class Success extends HttpResponse
{
    /**
     * The request has succeeded
     * 
     * @param string $message
     * @param array|null $data
     * @return Success
     */
    public function success(string $message, ?array $data = null): Success
    {
        $this->statusCode = 200;
        $this->message = $message;
        $this->data = $data;

        return $this;
    }

    /**
     * The server does not need to return an entity body
     *
     * @return Success
     */
    public function noContent(): Success
    {
        $this->statusCode = 204;
        $this->message = "";
        $this->data = [];
        $this->type = "";
        $this->parameter = "";

        return $this;
    }

    /**
     * @param string $nameDataParam
     * @return array
     */
    public function toArray(string $nameDataParam = "data"): array
    {
        return [
            "message" => $this->message,
            $nameDataParam => $this->data,
        ];
    }
}