Issues in MethodAssembler.php - All Issues - Inspection of "Delete Scrybe" - phpDocumentor/phpDocumentor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 8eb671...133594 )

by Mike

created 2019-06-14 08:00 UTC

Builder/Reflector/Tags/MethodAssembler.php (1 issue)

Showing only issues like (Show All)

mismatching argument types.

Documentation Minor

Jaapio 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
declare(strict_types=1);

/**
 * This file is part of phpDocumentor.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author    Mike van Riel <[email protected]>
 * @copyright 2010-2018 Mike van Riel / Naenius (http://www.naenius.com)
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */

namespace phpDocumentor\Descriptor\Builder\Reflector\Tags;

use phpDocumentor\Descriptor\ArgumentDescriptor;
use phpDocumentor\Descriptor\Builder\Reflector\AssemblerAbstract;
use phpDocumentor\Descriptor\Tag\MethodDescriptor;
use phpDocumentor\Descriptor\Tag\ReturnDescriptor;
use phpDocumentor\Reflection\DocBlock\Tags\Method;
use phpDocumentor\Reflection\Type;

/**
 * Constructs a new descriptor from the Reflector for an `@method` tag.
 *
 * This object will read the reflected information for the `@method` tag and create a {@see MethodDescriptor} object
 * that can be used in the rest of the application and templates.
 */
class MethodAssembler extends AssemblerAbstract
{
    /**
     * Creates a new Descriptor from the given Reflector.
     *
     * @param Method $data
     *
     * @return MethodDescriptor
     */
    public function create($data)
    {
        $descriptor = new MethodDescriptor($data->getName());
        $descriptor->setDescription($data->getDescription());
        $descriptor->setMethodName($data->getMethodName());
        $descriptor->setStatic($data->isStatic());

        $response = new ReturnDescriptor('return');
        $response->setType($data->getReturnType());
        $descriptor->setResponse($response);

        foreach ($data->getArguments() as $argument) {
            if (array_key_exists('name', $argument) && array_key_exists('type', $argument)) {
                $argumentDescriptor = $this->createArgumentDescriptorForMagicMethod(
                    $argument['name'],
                    $argument['type']
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                );
                $descriptor->getArguments()->set($argumentDescriptor->getName(), $argumentDescriptor);
            }
        }

        return $descriptor;
    }

    /**
     * Construct an argument descriptor given the array representing an argument with a Method Tag in the Reflection
     * component.
     */
    private function createArgumentDescriptorForMagicMethod(string $name, Type $type): ArgumentDescriptor
    {
        $argumentDescriptor = new ArgumentDescriptor();
        $argumentDescriptor->setType(AssemblerAbstract::deduplicateTypes($type));
        $argumentDescriptor->setName($name);

        return $argumentDescriptor;
    }
}


1		<?php
2		declare(strict_types=1);
3
4		/**
5		* This file is part of phpDocumentor.
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*
10		* @author Mike van Riel <[email protected]>
11		* @copyright 2010-2018 Mike van Riel / Naenius (http://www.naenius.com)
12		* @license http://www.opensource.org/licenses/mit-license.php MIT
13		* @link http://phpdoc.org
14		*/
15
16		namespace phpDocumentor\Descriptor\Builder\Reflector\Tags;
17
18		use phpDocumentor\Descriptor\ArgumentDescriptor;
19		use phpDocumentor\Descriptor\Builder\Reflector\AssemblerAbstract;
20		use phpDocumentor\Descriptor\Tag\MethodDescriptor;
21		use phpDocumentor\Descriptor\Tag\ReturnDescriptor;
22		use phpDocumentor\Reflection\DocBlock\Tags\Method;
23		use phpDocumentor\Reflection\Type;
24
25		/**
26		* Constructs a new descriptor from the Reflector for an `@method` tag.
27		*
28		* This object will read the reflected information for the `@method` tag and create a {@see MethodDescriptor} object
29		* that can be used in the rest of the application and templates.
30		*/
31		class MethodAssembler extends AssemblerAbstract
32		{
33		/**
34		* Creates a new Descriptor from the given Reflector.
35		*
36		* @param Method $data
37		*
38		* @return MethodDescriptor
39		*/
40	6	public function create($data)
41		{
42	6	$descriptor = new MethodDescriptor($data->getName());
43	6	$descriptor->setDescription($data->getDescription());
44	6	$descriptor->setMethodName($data->getMethodName());
45	6	$descriptor->setStatic($data->isStatic());
46
47	6	$response = new ReturnDescriptor('return');
48	6	$response->setType($data->getReturnType());
49	6	$descriptor->setResponse($response);
50
51	6	foreach ($data->getArguments() as $argument) {
52	5	if (array_key_exists('name', $argument) && array_key_exists('type', $argument)) {
53	5	$argumentDescriptor = $this->createArgumentDescriptorForMagicMethod(
54		$argument['name'],
55		$argument['type']
		0 ignored issues – show Documentation introduced 2019-03-14 17:21 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$argument['type']` is of type `string`, but the function expects a `object<phpDocumentor\Reflection\Type>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
56	6	);
57		$descriptor->getArguments()->set($argumentDescriptor->getName(), $argumentDescriptor);
58		}
59		}
60
61		return $descriptor;
62		}
63	5
64		/**
65	5	* Construct an argument descriptor given the array representing an argument with a Method Tag in the Reflection
66	5	* component.
67	5	*/
68		private function createArgumentDescriptorForMagicMethod(string $name, Type $type): ArgumentDescriptor
69	5	{
70		$argumentDescriptor = new ArgumentDescriptor();
71		$argumentDescriptor->setType(AssemblerAbstract::deduplicateTypes($type));
72		$argumentDescriptor->setName($name);
73
74		return $argumentDescriptor;
75		}
76		}
77

phpDocumentor / phpDocumentor

Push — develop ( 8eb671...133594 )

Builder/Reflector/Tags/MethodAssembler.php (1 issue)

Showing only issues like (Show All)

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like