Sarala\Exceptions\ApiException

Complexity

Total Complexity

12

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	meta()	0	4	1
A	getResponseData()	0	11	1
A	getApiResponse()	0	5	1
A	id()	0	4	1
A	code()	0	4	1
A	detail()	0	4	1
A	href()	0	4	1
A	links()	0	4	1
A	path()	0	4	1
A	render()	0	4	1
A	getAvailableData()	0	12	2

<?php

declare(strict_types=1);

namespace Sarala\Exceptions;

use Exception;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;

abstract class ApiException extends Exception implements JsonApiExceptionContract
{
    /**
     * Get unique identifier for this particular occurrence
     * of the problem.
     */
    public function id(): string
    {
        return '';
    }

    /**
     * Get application-specific error code.
     */
    public function code(): string
    {
        return '';
    }

    /**
     * Get human-readable explanation specific to this
     * occurrence of the problem.
     */
    public function detail(): string
    {
        return '';
    }

    /**
     * Get the URI that yield further details about this
     * particular occurrence of the problem.
     */
    public function href(): string
    {
        return '';
    }

    /**
     * Get associated resources, which can be dereferenced
     * from the request document.
     */
    public function links(): array
    {
        return [];
    }

    /**
     * Get relative path to the relevant attribute within
     * the associated resource(s).
     */
    public function path(): string
    {
        return '';
    }

    /**
     * Get non-standard meta-information about the error.
     */
    public function meta(): array
    {
        return [];
    }

    protected function getResponseData(): array
    {
        $error = array_merge([
            'status' => (string) $this->status(),
            'title' => (string) $this->title(),
        ], $this->getAvailableData());

        return [
            'errors' => [$error],
        ];
    }

    protected function getApiResponse(): JsonResponse
    {
        return response()

The method json does only exist in Illuminate\Contracts\Routing\ResponseFactory, but not in Illuminate\Http\Response.

            ->json($this->getResponseData(), $this->status());
    }

    public function render(Request $request)

The parameter $request is not used and could be removed.

    {
        return $this->getApiResponse();
    }

    private function getAvailableData(): array
    {
        $data = [];

        collect(['links', 'meta', 'id', 'href', 'code', 'detail', 'path'])->each(function ($key) use (&$data) {
            if (! empty($this->{$key}())) {
                $data[$key] = $this->{$key}();
            }
        });

        return $data;
    }
}