MethodAssembler::createArgumentDescriptorForMagicMethod() - Code Metrics - Inspection of "Fixes conversion errors" - phpDocumentor/phpDocumentor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 9193e7...62056c )

by Jaap

created 2017-09-13 21:17 UTC

createArgumentDescriptorForMagicMethod() A

↳ Parent: MethodAssembler

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
cc	1
eloc	5
nc	1
nop	2
dl	0
loc	8
rs	9.4285
c	1
b	1
f	0

<?php
/**
 * phpDocumentor
 *
 * PHP Version 5.3
 *
 * @copyright 2010-2014 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());
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $descriptor->setMethodName($data->getMethodName());
        $descriptor->setStatic($data->isStatic());

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

        foreach ($data->getArguments() as $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;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Construct an argument descriptor given the array representing an argument with a Method Tag in the Reflection
     * component.
     *
     * @param string $name
     * @param Type $type
     * @return ArgumentDescriptor
     *
     */
    private function createArgumentDescriptorForMagicMethod($name, Type $type)
    {
        $argumentDescriptor = new ArgumentDescriptor();
        $argumentDescriptor->setTypes($type);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $argumentDescriptor->setName($name);

        return $argumentDescriptor;
    }
}


1			<?php
2			/**
3			* phpDocumentor
4			*
5			* PHP Version 5.3
6			*
7			* @copyright 2010-2014 Mike van Riel / Naenius (http://www.naenius.com)
8			* @license http://www.opensource.org/licenses/mit-license.php MIT
9			* @link http://phpdoc.org
10			*/
11
12			namespace phpDocumentor\Descriptor\Builder\Reflector\Tags;
13
14			use phpDocumentor\Descriptor\ArgumentDescriptor;
15			use phpDocumentor\Descriptor\Builder\Reflector\AssemblerAbstract;
16			use phpDocumentor\Descriptor\Tag\MethodDescriptor;
17			use phpDocumentor\Descriptor\Tag\ReturnDescriptor;
18			use phpDocumentor\Reflection\DocBlock\Tags\Method;
19			use phpDocumentor\Reflection\Type;
20
21			/**
22			* Constructs a new descriptor from the Reflector for an `@method` tag.
23			*
24			* This object will read the reflected information for the `@method` tag and create a {@see MethodDescriptor} object
25			* that can be used in the rest of the application and templates.
26			*/
27			class MethodAssembler extends AssemblerAbstract
28			{
29			/**
30			* Creates a new Descriptor from the given Reflector.
31			*
32			* @param Method $data
33			*
34			* @return MethodDescriptor
35			*/
36			public function create($data)
37			{
38			$descriptor = new MethodDescriptor($data->getName());
39			$descriptor->setDescription($data->getDescription());
			0 ignored issues – show Documentation introduced 2017-08-29 19:40 UTC by Report Bug Copy Issue Report `$data->getDescription()` is of type `object<phpDocumentor\Ref...Block\Description>\|null`, but the function expects a `string`. 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...
40			$descriptor->setMethodName($data->getMethodName());
41			$descriptor->setStatic($data->isStatic());
42
43			$response = new ReturnDescriptor('return');
44			$response->setTypes($data->getReturnType());
45			$descriptor->setResponse($response);
46
47			foreach ($data->getArguments() as $argument) {
48			$argumentDescriptor = $this->createArgumentDescriptorForMagicMethod($argument['name'], $argument['type']);
			0 ignored issues – show Documentation introduced 2017-08-29 19:40 UTC by Report Bug Copy Issue Report `$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...
49			$descriptor->getArguments()->set($argumentDescriptor->getName(), $argumentDescriptor);
50			}
51
52			return $descriptor;
			0 ignored issues – show Bug Best Practice introduced 2015-12-02 21:15 UTC by Report Bug Copy Issue Report The return type of `return $descriptor;` (`phpDocumentor\Descriptor\Tag\MethodDescriptor`) is incompatible with the return type declared by the interface `phpDocumentor\Descriptor...emblerInterface::create` of type `phpDocumentor\Descriptor...r\Descriptor\Collection`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
53			}
54
55			/**
56			* Construct an argument descriptor given the array representing an argument with a Method Tag in the Reflection
57			* component.
58			*
59			* @param string $name
60			* @param Type $type
61			* @return ArgumentDescriptor
62			*
63			*/
64			private function createArgumentDescriptorForMagicMethod($name, Type $type)
65			{
66			$argumentDescriptor = new ArgumentDescriptor();
67			$argumentDescriptor->setTypes($type);
			0 ignored issues – show Documentation introduced 2017-08-29 19:40 UTC by Report Bug Copy Issue Report `$type` is of type `object<phpDocumentor\Reflection\Type>`, but the function expects a `object<phpDocumentor\Descriptor\Collection>`. 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...
68			$argumentDescriptor->setName($name);
69
70			return $argumentDescriptor;
71			}
72			}
73

phpDocumentor / phpDocumentor

Push — develop ( 9193e7...62056c )

createArgumentDescriptorForMagicMethod() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like