ApiException::detail() - Code Metrics - Inspection of "Merge pull request #22 from okdewit/patch-2" - sarala-io/sarala-laravel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 870cb1...1f9632 )

by Milroy

created 2021-01-13 14:27 UTC

ApiException::detail() A

↳ Parent: ApiException

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?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()
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->json($this->getResponseData(), $this->status());
    }

    public function render(Request $request)

    {
        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;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Sarala\Exceptions;
6
7			use Exception;
8			use Illuminate\Http\JsonResponse;
9			use Illuminate\Http\Request;
10
11			abstract class ApiException extends Exception implements JsonApiExceptionContract
12			{
13			/**
14			* Get unique identifier for this particular occurrence
15			* of the problem.
16			*/
17			public function id(): string
18			{
19			return '';
20			}
21
22			/**
23			* Get application-specific error code.
24			*/
25			public function code(): string
26			{
27			return '';
28			}
29
30			/**
31			* Get human-readable explanation specific to this
32			* occurrence of the problem.
33			*/
34			public function detail(): string
35			{
36			return '';
37			}
38
39			/**
40			* Get the URI that yield further details about this
41			* particular occurrence of the problem.
42			*/
43			public function href(): string
44			{
45			return '';
46			}
47
48			/**
49			* Get associated resources, which can be dereferenced
50			* from the request document.
51			*/
52			public function links(): array
53			{
54			return [];
55			}
56
57			/**
58			* Get relative path to the relevant attribute within
59			* the associated resource(s).
60			*/
61			public function path(): string
62			{
63			return '';
64			}
65
66			/**
67			* Get non-standard meta-information about the error.
68			*/
69			public function meta(): array
70			{
71			return [];
72			}
73
74			protected function getResponseData(): array
75			{
76			$error = array_merge([
77			'status' => (string) $this->status(),
78			'title' => (string) $this->title(),
79			], $this->getAvailableData());
80
81			return [
82			'errors' => [$error],
83			];
84			}
85
86			protected function getApiResponse(): JsonResponse
87			{
88			return response()
			0 ignored issues – show Bug introduced 2019-02-05 04:54 UTC by Report Bug Copy Issue Report The method `json` does only exist in `Illuminate\Contracts\Routing\ResponseFactory`, but not in `Illuminate\Http\Response`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
89			->json($this->getResponseData(), $this->status());
90			}
91
92			public function render(Request $request)
			0 ignored issues – show Unused Code introduced 2019-02-05 04:54 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
93			{
94			return $this->getApiResponse();
95			}
96
97			private function getAvailableData(): array
98			{
99			$data = [];
100
101			collect(['links', 'meta', 'id', 'href', 'code', 'detail', 'path'])->each(function ($key) use (&$data) {
102			if (! empty($this->{$key}())) {
103			$data[$key] = $this->{$key}();
104			}
105			});
106
107			return $data;
108			}
109			}
110

sarala-io / sarala-laravel

Push — master ( 870cb1...1f9632 )

ApiException::detail() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like