ResponseFileStrategy::getFileResponse() - Code Metrics - Inspection of "Uses a file payload as response" - mpociot/laravel-apidoc-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#410)

unknown

created 2018-11-26 21:59 UTC

ResponseFileStrategy::getFileResponse() A

↳ Parent: ResponseFileStrategy

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.7998
c	0
b	0
f	0
cc	3
nc	2
nop	1

<?php

namespace Mpociot\ApiDoc\Tools\ResponseStrategies;

use Illuminate\Routing\Route;
use Mpociot\Reflection\DocBlock\Tag;

/**
 * Get a response from from a file in the docblock ( @responseFile ).
 */
class ResponseFileStrategy
{
    public function __invoke(Route $route, array $tags, array $routeProps)
    {
        return $this->getFileResponse($tags);
    }

    /**
     * Get the response from the file if available.
     *
     * @param array $tags
     *
     * @return mixed
     */
    protected function getFileResponse(array $tags)
    {
        $responseTags = array_filter($tags, function ($tag) {
            return $tag instanceof Tag && strtolower($tag->getName()) == 'responsefile';
        });
        if (empty($responseTags)) {
            return;
        }
        $responseTag = array_first($responseTags);

        $json = json_decode(file_get_contents(storage_path($responseTag->getContent()), true), true);

        return response()->json($json);
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.
}
    }
}


1			<?php
2
3			namespace Mpociot\ApiDoc\Tools\ResponseStrategies;
4
5			use Illuminate\Routing\Route;
6			use Mpociot\Reflection\DocBlock\Tag;
7
8			/**
9			* Get a response from from a file in the docblock ( @responseFile ).
10			*/
11			class ResponseFileStrategy
12			{
13			public function __invoke(Route $route, array $tags, array $routeProps)
14			{
15			return $this->getFileResponse($tags);
16			}
17
18			/**
19			* Get the response from the file if available.
20			*
21			* @param array $tags
22			*
23			* @return mixed
24			*/
25			protected function getFileResponse(array $tags)
26			{
27			$responseTags = array_filter($tags, function ($tag) {
28			return $tag instanceof Tag && strtolower($tag->getName()) == 'responsefile';
29			});
30			if (empty($responseTags)) {
31			return;
32			}
33			$responseTag = array_first($responseTags);
34
35			$json = json_decode(file_get_contents(storage_path($responseTag->getContent()), true), true);
36
37			return response()->json($json);
			0 ignored issues – show Bug introduced 2018-11-26 21:58 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...
38			}
39			}
40

mpociot / laravel-apidoc-generator

Pull Request — master (#410)

ResponseFileStrategy::getFileResponse() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like