GetFromDocBlocks::getQueryParametersFromDocBlock() - Code Metrics - Inspection of "First implementation of plugin architecture" - mpociot/laravel-apidoc-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#570)

unknown

created 2019-09-02 20:56 UTC

GetFromDocBlocks::getQueryParametersFromDocBlock() B

↳ Parent: GetFromDocBlocks

Complexity

Conditions	9
Paths	1

Size

Total Lines

Duplication

Lines	14
Ratio	38.89 %

Importance

Changes

Metric	Value
dl	14
loc	36
rs	8.0555
c	0
b	0
f	0
cc	9
nc	1
nop	1

<?php

namespace Mpociot\ApiDoc\Strategies\QueryParameters;

use ReflectionClass;
use ReflectionMethod;
use Illuminate\Routing\Route;
use Mpociot\Reflection\DocBlock;
use Mpociot\Reflection\DocBlock\Tag;
use Mpociot\ApiDoc\Strategies\Strategy;
use Mpociot\ApiDoc\Tools\RouteDocBlocker;
use Mpociot\ApiDoc\Tools\Traits\ParamHelpers;
use Dingo\Api\Http\FormRequest as DingoFormRequest;
use Illuminate\Foundation\Http\FormRequest as LaravelFormRequest;

class GetFromDocBlocks extends Strategy
{
    use ParamHelpers;

    public function __invoke(Route $route, ReflectionClass $controller, ReflectionMethod $method, array $routeRules, array $context = [])

    {
        foreach ($method->getParameters() as $param) {
            $paramType = $param->getType();
            if ($paramType === null) {
                continue;
            }

            $parameterClassName = version_compare(phpversion(), '7.1.0', '<')
                ? $paramType->__toString()
                : $paramType->getName();

            try {
                $parameterClass = new ReflectionClass($parameterClassName);
            } catch (\ReflectionException $e) {
                continue;
            }

            // If there's a FormRequest, we check there for @queryParam tags.
            if (class_exists(LaravelFormRequest::class) && $parameterClass->isSubclassOf(LaravelFormRequest::class)
                || class_exists(DingoFormRequest::class) && $parameterClass->isSubclassOf(DingoFormRequest::class)) {
                $formRequestDocBlock = new DocBlock($parameterClass->getDocComment());
                $queryParametersFromDocBlock = $this->getqueryParametersFromDocBlock($formRequestDocBlock->getTags());

                if (count($queryParametersFromDocBlock)) {
                    return $queryParametersFromDocBlock;
                }
            }
        }

        $methodDocBlock = RouteDocBlocker::getDocBlocksFromRoute($route)['method'];

        return $this->getqueryParametersFromDocBlock($methodDocBlock->getTags());
    }

    private function getQueryParametersFromDocBlock($tags)
    {
        $parameters = collect($tags)
            ->filter(function ($tag) {
                return $tag instanceof Tag && $tag->getName() === 'queryParam';
if ($x instanceof DoesNotExist) {
    // Do something.
}
            })
            ->mapWithKeys(function ($tag) {
                preg_match('/(.+?)\s+(required\s+)?(.*)/', $tag->getContent(), $content);
                $content = preg_replace('/\s?No-example.?/', '', $content);
                if (empty($content)) {

                    // this means only name was supplied
                    list($name) = preg_split('/\s+/', $tag->getContent());
                    $required = false;
                    $description = '';
                } else {
                    list($_, $name, $required, $description) = $content;
<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;
                    $description = trim($description);
                    if ($description == 'required' && empty(trim($required))) {
                        $required = $description;
                        $description = '';
                    }
                    $required = trim($required) == 'required' ? true : false;
                }

                list($description, $value) = $this->parseParamDescription($description, 'string');
                if (is_null($value) && ! $this->shouldExcludeExample($tag)) {
                    $value = str_contains($description, ['number', 'count', 'page'])
                        ? $this->generateDummyValue('integer')
                        : $this->generateDummyValue('string');
                }

                return [$name => compact('description', 'required', 'value')];
            })->toArray();

        return $parameters;
    }
}


1		<?php
2
3		namespace Mpociot\ApiDoc\Strategies\QueryParameters;
4
5		use ReflectionClass;
6		use ReflectionMethod;
7		use Illuminate\Routing\Route;
8		use Mpociot\Reflection\DocBlock;
9		use Mpociot\Reflection\DocBlock\Tag;
10		use Mpociot\ApiDoc\Strategies\Strategy;
11		use Mpociot\ApiDoc\Tools\RouteDocBlocker;
12		use Mpociot\ApiDoc\Tools\Traits\ParamHelpers;
13		use Dingo\Api\Http\FormRequest as DingoFormRequest;
14		use Illuminate\Foundation\Http\FormRequest as LaravelFormRequest;
15
16		class GetFromDocBlocks extends Strategy
17		{
18		use ParamHelpers;
19
20	View Code Duplication	public function __invoke(Route $route, ReflectionClass $controller, ReflectionMethod $method, array $routeRules, array $context = [])
		0 ignored issues – show Duplication introduced 2019-09-02 20:57 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
21		{
22		foreach ($method->getParameters() as $param) {
23		$paramType = $param->getType();
24		if ($paramType === null) {
25		continue;
26		}
27
28		$parameterClassName = version_compare(phpversion(), '7.1.0', '<')
29		? $paramType->__toString()
30		: $paramType->getName();
31
32		try {
33		$parameterClass = new ReflectionClass($parameterClassName);
34		} catch (\ReflectionException $e) {
35		continue;
36		}
37
38		// If there's a FormRequest, we check there for @queryParam tags.
39		if (class_exists(LaravelFormRequest::class) && $parameterClass->isSubclassOf(LaravelFormRequest::class)
40		\|\| class_exists(DingoFormRequest::class) && $parameterClass->isSubclassOf(DingoFormRequest::class)) {
41		$formRequestDocBlock = new DocBlock($parameterClass->getDocComment());
42		$queryParametersFromDocBlock = $this->getqueryParametersFromDocBlock($formRequestDocBlock->getTags());
43
44		if (count($queryParametersFromDocBlock)) {
45		return $queryParametersFromDocBlock;
46		}
47		}
48		}
49
50		$methodDocBlock = RouteDocBlocker::getDocBlocksFromRoute($route)['method'];
51
52		return $this->getqueryParametersFromDocBlock($methodDocBlock->getTags());
53		}
54
55		private function getQueryParametersFromDocBlock($tags)
56		{
57		$parameters = collect($tags)
58		->filter(function ($tag) {
59		return $tag instanceof Tag && $tag->getName() === 'queryParam';
		0 ignored issues – show Bug introduced 2019-08-25 21:49 UTC by Report Bug Copy Issue Report The class `Mpociot\Reflection\DocBlock\Tag` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
60		})
61		->mapWithKeys(function ($tag) {
62		preg_match('/(.+?)\s+(required\s+)?(.*)/', $tag->getContent(), $content);
63		$content = preg_replace('/\s?No-example.?/', '', $content);
64	View Code Duplication	if (empty($content)) {
		0 ignored issues – show Duplication introduced 2019-08-26 09:22 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
65		// this means only name was supplied
66		list($name) = preg_split('/\s+/', $tag->getContent());
67		$required = false;
68		$description = '';
69		} else {
70		list($_, $name, $required, $description) = $content;
		0 ignored issues – show Unused Code introduced 2018-10-20 23:20 UTC by Report Bug Copy Issue Report The assignment to `$_` is unused. Consider omitting it like so `list($first,,$third)`. This checks looks for assignemnts to variables using the `list(...)` function, where not all assigned variables are subsequently used. Consider the following code example. <?php function returnThreeValues() { return array('a', 'b', 'c'); } list($a, $b, $c) = returnThreeValues(); print $a . " - " . $c; Only the variables `$a` and `$c` are used. There was no need to assign `$b`. Instead, the list call could have been. list($a,, $c) = returnThreeValues(); Loading history...
71		$description = trim($description);
72		if ($description == 'required' && empty(trim($required))) {
73		$required = $description;
74		$description = '';
75		}
76		$required = trim($required) == 'required' ? true : false;
77		}
78
79		list($description, $value) = $this->parseParamDescription($description, 'string');
80		if (is_null($value) && ! $this->shouldExcludeExample($tag)) {
81		$value = str_contains($description, ['number', 'count', 'page'])
82		? $this->generateDummyValue('integer')
83		: $this->generateDummyValue('string');
84		}
85
86		return [$name => compact('description', 'required', 'value')];
87		})->toArray();
88
89		return $parameters;
90		}
91		}
92

mpociot / laravel-apidoc-generator

Pull Request — master (#570)

GetFromDocBlocks::getQueryParametersFromDocBlock() B

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like