BodyAnnotHandler::handle() - Code Metrics - Inspection of "Retrofit 3" - tebru/retrofit-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#72)

by Nate

created 2017-09-12 22:31 UTC

BodyAnnotHandler::handle() A

↳ Parent: BodyAnnotHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0
cc	1
eloc	8
nc	1
nop	4

<?php
/*
 * Copyright (c) Nate Brunette.
 * Distributed under the MIT License (http://opensource.org/licenses/MIT)
 */

declare(strict_types=1);

namespace Tebru\Retrofit\Internal\AnnotationHandler;

use Tebru\AnnotationReader\AbstractAnnotation;
use Tebru\Retrofit\AnnotationHandler;
use Tebru\Retrofit\Converter;
use Tebru\Retrofit\Internal\ParameterHandler\BodyParamHandler;
use Tebru\Retrofit\RequestBodyConverter;
use Tebru\Retrofit\ServiceMethodBuilder;

/**
 * Class BodyAnnotHandler
 *
 * @author Nate Brunette <[email protected]>
 */
final class BodyAnnotHandler implements AnnotationHandler
{
    /**
     * Sets the request method as 'json' and adds a parameter handler for body json data
     *
     * @param AbstractAnnotation $annotation The annotation to handle
     * @param ServiceMethodBuilder $serviceMethodBuilder Used to construct a [@see ServiceMethod]
     * @param Converter|RequestBodyConverter $converter Converter used to convert types before sending to service method
     * @param int|null $index The position of the parameter or null if annotation does not reference parameter
     * @return void
     */
    public function handle(
        AbstractAnnotation $annotation,
        ServiceMethodBuilder $serviceMethodBuilder,
        ?Converter $converter,
        ?int $index
    ): void {
        $serviceMethodBuilder->setIsJson();
        $serviceMethodBuilder->addParameterHandler($index, new BodyParamHandler($converter));

    }
}


1			<?php
2			/*
3			* Copyright (c) Nate Brunette.
4			* Distributed under the MIT License (http://opensource.org/licenses/MIT)
5			*/
6
7			declare(strict_types=1);
8
9			namespace Tebru\Retrofit\Internal\AnnotationHandler;
10
11			use Tebru\AnnotationReader\AbstractAnnotation;
12			use Tebru\Retrofit\AnnotationHandler;
13			use Tebru\Retrofit\Converter;
14			use Tebru\Retrofit\Internal\ParameterHandler\BodyParamHandler;
15			use Tebru\Retrofit\RequestBodyConverter;
16			use Tebru\Retrofit\ServiceMethodBuilder;
17
18			/**
19			* Class BodyAnnotHandler
20			*
21			* @author Nate Brunette <[email protected]>
22			*/
23			final class BodyAnnotHandler implements AnnotationHandler
24			{
25			/**
26			* Sets the request method as 'json' and adds a parameter handler for body json data
27			*
28			* @param AbstractAnnotation $annotation The annotation to handle
29			* @param ServiceMethodBuilder $serviceMethodBuilder Used to construct a [@see ServiceMethod]
30			* @param Converter\|RequestBodyConverter $converter Converter used to convert types before sending to service method
31			* @param int\|null $index The position of the parameter or null if annotation does not reference parameter
32			* @return void
33			*/
34			public function handle(
35			AbstractAnnotation $annotation,
36			ServiceMethodBuilder $serviceMethodBuilder,
37			?Converter $converter,
38			?int $index
39			): void {
40			$serviceMethodBuilder->setIsJson();
41			$serviceMethodBuilder->addParameterHandler($index, new BodyParamHandler($converter));
			0 ignored issues – show Compatibility introduced 2017-09-12 22:35 UTC by Report Bug Copy Issue Report `$converter` of type `object<Tebru\Retrofit\Converter>` is not a sub-type of `object<Tebru\Retrofit\RequestBodyConverter>`. It seems like you assume a child interface of the interface `Tebru\Retrofit\Converter` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
42			}
43			}
44

tebru / retrofit-php

Pull Request — master (#72)

BodyAnnotHandler::handle() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like