App\Controller\Traits\ApiTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	renderJson()	0	11	1
A	apiResponse()	0	8	1
A	apiError()	0	14	3

<?php

namespace App\Controller\Traits;

use Psr\Http\Message\ResponseInterface;

/**
 * Utility trait for API controllers
 *
 * @author Ronan Chilvers <ronan@d3r.com>
 */
trait ApiTrait
{
    /**
     * Render an API response
     *
     * @param ResponseInterface $response
     * @param array $data
     * @return ResponseInterface
     * @author Ronan Chilvers <ronan@d3r.com>
     */
    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 <ronan@d3r.com>
     */
    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 <ronan@d3r.com>
     */
    protected function renderJson(
        ResponseInterface $response,
        string $status,
        array $data
    ): ResponseInterface {
        $data = [
            'status' => $status,
            'data' => $data,
        ];

        return $response->withJson($data);

The method withJson() does not exist on Psr\Http\Message\ResponseInterface. It seems like you code against a sub-type of Psr\Http\Message\ResponseInterface such as Slim\Http\Response.

    }
}