App\Dto\ApiResponseData

Complexity

Total Complexity

9

Size/Duplication

Total Lines	91
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	toArray()	0	7	1
A	getErrorCode()	0	3	1
A	getStatus()	0	3	1
A	setErrorMessage()	0	4	1
A	getData()	0	3	1
A	setStatus()	0	4	1
A	setData()	0	4	1
A	getErrorMessage()	0	3	1
A	setErrorCode()	0	4	1

<?php

declare(strict_types=1);

namespace App\Dto;

use OpenApi\Annotations as OA;

/**
 * @OA\Schema(
 *      schema="Response",
 * )
 * @OA\Schema(
 *      schema="BadResponse",
 *      allOf={
 *          @OA\Schema(ref="#/components/schemas/Response"),
 *          @OA\Schema(
 *              @OA\Property(
 *                  property="status",
 *                  example="failed",
 *              ),
 *              @OA\Property(property="error_message", example="Error description message"),
 *              @OA\Property(property="error_code", nullable=true, example=400),
 *              @OA\Property(
 *                  property="data",
 *                  example=null
 *              ),
 *          )
 *      }
 * )
 */
final class ApiResponseData
{
    /**
     * @OA\Property(
     *      property="status",
     *      format="string",
     *      example="success",
     *      enum={"success", "failed"}
     * )
     */
    private string $status = '';

    /**
     * @OA\Property(
     *     property="error_message",
     *     format="string",
     *     example=""
     * )
     */
    private string $errorMessage = '';

    /**
     * @OA\Property(
     *     property="error_code",
     *     format="integer",
     *     nullable=true,
     *     example=null
     * )
     */
    private ?int $errorCode = null;

    /**
     * @OA\Property(
     *      property="data",
     *      type="object",
     *      nullable=true,
     * )
     */
    private ?array $data = null;

    public function getStatus(): string
    {
        return $this->status;
    }

    public function setStatus(string $status): self
    {
        $this->status = $status;
        return $this;
    }

    public function getErrorMessage(): string
    {
        return $this->errorMessage;
    }

    public function setErrorMessage(string $errorMessage): self
    {
        $this->errorMessage = $errorMessage;
        return $this;
    }

    public function getErrorCode(): ?int
    {
        return $this->errorCode;
    }

    public function setErrorCode(int $errorCode): self
    {
        $this->errorCode = $errorCode;
        return $this;
    }

    public function getData(): ?array
    {
        return $this->data;
    }

    public function setData(?array $data): self
    {
        $this->data = $data;
        return $this;
    }

    public function toArray(): array
    {
        return [
            'status' => $this->getStatus(),
            'error_message' => $this->getErrorMessage(),
            'error_code' => $this->getErrorCode(),
            'data' => $this->getData(),
        ];
    }
}