App\Http\ApiResponseData

Complexity

Total Complexity

9

Size/Duplication

Total Lines	98
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	0

9 Methods

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

<?php

declare(strict_types=1);

namespace App\Http;

use OpenApi\Attributes as OA;

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

    #[OA\Property(
        property: 'error_message',
        format: 'string',
        example: ''
    )]
    private string $errorMessage = '';

    #[OA\Property(
        property: 'error_code',
        format: 'integer',
        example: null,
        nullable: true
    )]
    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(),
        ];
    }
}