ApiTrait::renderJson() - Code Metrics - ronanchilvers/deploy - Measure and Improve Code Quality continuously with Scrutinizer

ApiTrait::renderJson() A
last analyzed 2024-09-12 07:34 UTC

↳ Parent: ApiTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	4
c	1
b	0
f	0
dl	0
loc	11
ccs	0
cts	3
cp	0
rs	10
cc	1
nc	1
nop	3
crap	2

<?php

namespace App\Controller\Traits;

use Psr\Http\Message\ResponseInterface;

/**
 * Utility trait for API controllers
 *
 * @author Ronan Chilvers <[email protected]>
 */
trait ApiTrait
{
    /**
     * Render an API response
     *
     * @param ResponseInterface $response
     * @param array $data
     * @return ResponseInterface
     * @author Ronan Chilvers <[email protected]>
     */
    protected function apiResponse(
        ResponseInterface $response,
        array $data
    ): ResponseInterface {
        return $this->renderJson(
            $response,
            'ok',
            $data
        );
    }

    /**
     * Render an API error response
     *
     * @param ResponseInterface $response
     * @param string $message
     * @param integer $code The HTTP response code to use
     * @return ResponseInterface
     * @author Ronan Chilvers <[email protected]>
     */
    protected function apiError(
        ResponseInterface $response,
        string $message,
        int $code = null
    ): ResponseInterface {
        if (is_null($code) || 0 == $code) {
            $code = 400;
        }
        $data = ['message' => $message];
        return $this->renderJson(
            $response,
            'error',
            $data
        )->withStatus($code);
    }

    /**
     * Render a json response
     *
     * @param ResponseInterface $response
     * @param array $data
     * @return ResponseInterface
     * @author Ronan Chilvers <[email protected]>
     */
    protected function renderJson(
        ResponseInterface $response,
        string $status,
        array $data
    ): ResponseInterface {
        $data = [
            'status' => $status,
            'data' => $data,
        ];

        return $response->withJson($data);
        return $response->/** @scrutinizer ignore-call */ withJson($data);
    }
}


ronanchilvers / deploy

ApiTrait::renderJson() A last analyzed 2024-09-12 07:34 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ApiTrait::renderJson() A
last analyzed 2024-09-12 07:34 UTC