App\Http\Controllers\Api\ApiController

Complexity

Total Complexity

12

Size/Duplication

Total Lines	159
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

<?php
class ApiController extends Controller
{

    /**
     * @var int Status Code.
     */
    protected $statusCode = 200;

    /**
     * Function to return an unauthorized response.
     *
     * @param string $message
     * @return mixed
     */
    public function respondUnauthorizedError($message = 'Unauthorized!')
    {
        return $this->setStatusCode(IlluminateResponse::HTTP_UNAUTHORIZED)->respondWithError($message);
    }

    /**
     * Function to return forbidden error response.
     * @param string $message
     * @return mixed
     */
    public function respondForbiddenError($message = 'Forbidden!')
    {
        return $this->setStatusCode(IlluminateResponse::HTTP_FORBIDDEN)->respondWithError($message);
    }

    /**
     * Function to return a Not Found response.
     *
     * @param string $message
     * @return mixed
     */
    public function respondNotFound($message = 'Not Found')
    {
        return $this->setStatusCode(IlluminateResponse::HTTP_NOT_FOUND)->respondWithError($message);
    }

    /**
     * Function to return an internal error response.
     *
     * @param string $message
     * @return mixed
     */
    public function respondInternalError($message = 'Internal Error!')
    {
        return $this->setStatusCode(IlluminateResponse::HTTP_INTERNAL_SERVER_ERROR)->respondWithError($message);
    }

    /**
     * Function to return a service unavailable response.
     *
     * @param string $message
     * @return mixed
     */
    public function respondServiceUnavailable($message = "Service Unavailable!")
    {
        return $this->setStatusCode(IlluminateResponse::HTTP_SERVICE_UNAVAILABLE)->respondWithError($message);
    }

    /**
     * Function to return a generic response.
     *
     * @param $data Data to be used in response.

The type App\Http\Controllers\Api\Data was not found. Maybe you did not declare it correctly or list all dependencies?

     * @param array $headers Headers to b used in response.
     * @return mixed Return the response.
     */
    public function respond($data, $headers = [])
    {
        return response()->json($data, $this->getStatusCode(), $headers);
    }

    /**
     * Getter method to return stored status code.
     *
     * @return mixed
     */
    public function getStatusCode()
    {
        return $this->statusCode;
    }

    /**
     * Setter method to set status code.
     * It is returning current object
     * for chaining purposes.
     *
     * @param mixed $statusCode
     * @return current object.

The type App\Http\Controllers\Api\current was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function setStatusCode($statusCode)
    {
        $this->statusCode = $statusCode;

        return $this;

The expression return $this returns the type App\Http\Controllers\Api\ApiController which is incompatible with the documented return type App\Http\Controllers\Api\current.

    }

    /**
     * Function to return an error response.
     *
     * @param $message
     * @return mixed
     */
    public function respondWithError($message)
    {
        return response()->json([
            'error' => [
                'message' => $message,
                'status_code' => $this->getStatusCode()
            ]
        ]);
    }


    /**
     * @param $message
     * @return mixed
     */
    protected function respondCreated($message)
    {
        return $this->setStatusCode(IlluminateResponse::HTTP_CREATED)
            ->respond([
                'message' => $message
            ]);
    }


    /**
     * @param $message
     * @return mixed
     */
    protected function respondUnprocessableEntity($message)
    {
        return $this->setStatusCode(IlluminateResponse::HTTP_UNPROCESSABLE_ENTITY)
            ->respond([
                'message' => $message
            ]);
    }

    /**
     * @param Paginator $tournaments
     * @param $data
     * @return mixed
     */
    protected function respondWithPagination(LengthAwarePaginator $tournaments, $data)
    {

        $data = array_merge($data, [
            'paginator' => [
                'total_count' => $tournaments->count(),
                'total_pages' => ceil($tournaments->count() / config('constants.PAGINATION')),
                'current_page' => 1, // TODO CHANGE
                'limit' => config('constants.PAGINATION')
            ]
        ]);

        return response()->json($data);
    }
}