ClassAssembler::create() - Code Metrics - 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

ClassAssembler::create() A

↳ Parent: ClassAssembler

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	19
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
nc	2
nop	1
dl	0
loc	28
rs	9.472
c	0
b	0
f	0
ccs	19
cts	19
cp	1
crap	3

<?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;

use phpDocumentor\Descriptor\ClassDescriptor;
use phpDocumentor\Descriptor\Collection;
use phpDocumentor\Descriptor\ConstantDescriptor;
use phpDocumentor\Descriptor\MethodDescriptor;
use phpDocumentor\Descriptor\PropertyDescriptor;
use phpDocumentor\Reflection\Php\Class_;
use phpDocumentor\Reflection\Php\Constant;
use phpDocumentor\Reflection\Php\Method;
use phpDocumentor\Reflection\Php\Property;

/**
 * Assembles an ClassDescriptor using an ClassReflector.
 */
class ClassAssembler extends AssemblerAbstract
{
    /**
     * Creates a Descriptor from the provided data.
     *
     * @param Class_ $data
     *
     * @return ClassDescriptor
     */
    public function create($data)
    {
        $classDescriptor = new ClassDescriptor();

        $classDescriptor->setFullyQualifiedStructuralElementName($data->getFqsen());
        $classDescriptor->setName($data->getName());
        $classDescriptor->setPackage(
            $this->extractPackageFromDocBlock($data->getDocBlock()) ?: $this->getBuilder()->getDefaultPackage()
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        );
        $classDescriptor->setLine($data->getLocation()->getLineNumber());
        $classDescriptor->setParent($data->getParent());
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $classDescriptor->setAbstract($data->isAbstract());
        $classDescriptor->setFinal($data->isFinal());
        $classDescriptor->setNamespace(substr((string) $data->getFqsen(), 0, -strlen($data->getName()) - 1));

        foreach ($data->getInterfaces() as $interfaceClassName) {
            $classDescriptor->getInterfaces()->set((string) $interfaceClassName, $interfaceClassName);
        }

        $this->assembleDocBlock($data->getDocBlock(), $classDescriptor);

        $this->addConstants($data->getConstants(), $classDescriptor);
        $this->addProperties($data->getProperties(), $classDescriptor);
        $this->addMethods($data->getMethods(), $classDescriptor);
        $this->addUses($data->getUsedTraits(), $classDescriptor);

        return $classDescriptor;
    }

    /**
     * Registers the child constants with the generated Class Descriptor.
     *
     * @param Constant[] $constants
     */
    protected function addConstants(array $constants, ClassDescriptor $classDescriptor): void
    {
        foreach ($constants as $constant) {
            $constantDescriptor = $this->getBuilder()->buildDescriptor($constant);
            if ($constantDescriptor instanceof ConstantDescriptor) {
                $constantDescriptor->setParent($classDescriptor);
                $classDescriptor->getConstants()->set($constantDescriptor->getName(), $constantDescriptor);
            }
        }
    }

    /**
     * Registers the child properties with the generated Class Descriptor.
     *
     * @param Property[] $properties
     */
    protected function addProperties(array $properties, ClassDescriptor $classDescriptor): void
    {
        foreach ($properties as $property) {
            $propertyDescriptor = $this->getBuilder()->buildDescriptor($property);
            if ($propertyDescriptor instanceof PropertyDescriptor) {
                $propertyDescriptor->setParent($classDescriptor);
                $classDescriptor->getProperties()->set($propertyDescriptor->getName(), $propertyDescriptor);
            }
        }
    }

    /**
     * Registers the child methods with the generated Class Descriptor.
     *
     * @param Method[] $methods
     */
    protected function addMethods(array $methods, ClassDescriptor $classDescriptor): void
    {
        foreach ($methods as $method) {
            $methodDescriptor = $this->getBuilder()->buildDescriptor($method);
            if ($methodDescriptor instanceof MethodDescriptor) {
                $methodDescriptor->setParent($classDescriptor);
                $classDescriptor->getMethods()->set($methodDescriptor->getName(), $methodDescriptor);
            }
        }
    }

    /**
     * Registers the used traits with the generated Class Descriptor.
     *
     * @param string[] $traits
     */
    protected function addUses(array $traits, ClassDescriptor $classDescriptor): void
    {
        $classDescriptor->setUsedTraits(new Collection($traits));
    }
}


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;
17
18		use phpDocumentor\Descriptor\ClassDescriptor;
19		use phpDocumentor\Descriptor\Collection;
20		use phpDocumentor\Descriptor\ConstantDescriptor;
21		use phpDocumentor\Descriptor\MethodDescriptor;
22		use phpDocumentor\Descriptor\PropertyDescriptor;
23		use phpDocumentor\Reflection\Php\Class_;
24		use phpDocumentor\Reflection\Php\Constant;
25		use phpDocumentor\Reflection\Php\Method;
26		use phpDocumentor\Reflection\Php\Property;
27
28		/**
29		* Assembles an ClassDescriptor using an ClassReflector.
30		*/
31		class ClassAssembler extends AssemblerAbstract
32		{
33		/**
34		* Creates a Descriptor from the provided data.
35		*
36		* @param Class_ $data
37		*
38		* @return ClassDescriptor
39		*/
40	1	public function create($data)
41		{
42	1	$classDescriptor = new ClassDescriptor();
43
44	1	$classDescriptor->setFullyQualifiedStructuralElementName($data->getFqsen());
45	1	$classDescriptor->setName($data->getName());
46	1	$classDescriptor->setPackage(
47	1	$this->extractPackageFromDocBlock($data->getDocBlock()) ?: $this->getBuilder()->getDefaultPackage()
		0 ignored issues – show Bug introduced 2017-12-26 19:20 UTC by Report Bug Copy Issue Report It seems like `$data->getDocBlock()` can be `null`; however, `extractPackageFromDocBlock()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
48		);
49	1	$classDescriptor->setLine($data->getLocation()->getLineNumber());
50	1	$classDescriptor->setParent($data->getParent());
		0 ignored issues – show Documentation introduced 2018-06-20 16:36 UTC by Report Bug Copy Issue Report `$data->getParent()` is of type `null\|object<phpDocumentor\Reflection\Fqsen>`, but the function expects a `object<phpDocumentor\Des...tor\DescriptorAbstract>`. 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...
51	1	$classDescriptor->setAbstract($data->isAbstract());
52	1	$classDescriptor->setFinal($data->isFinal());
53	1	$classDescriptor->setNamespace(substr((string) $data->getFqsen(), 0, -strlen($data->getName()) - 1));
54
55	1	foreach ($data->getInterfaces() as $interfaceClassName) {
56	1	$classDescriptor->getInterfaces()->set((string) $interfaceClassName, $interfaceClassName);
57		}
58
59	1	$this->assembleDocBlock($data->getDocBlock(), $classDescriptor);
60
61	1	$this->addConstants($data->getConstants(), $classDescriptor);
62	1	$this->addProperties($data->getProperties(), $classDescriptor);
63	1	$this->addMethods($data->getMethods(), $classDescriptor);
64	1	$this->addUses($data->getUsedTraits(), $classDescriptor);
65
66	1	return $classDescriptor;
67		}
68
69		/**
70		* Registers the child constants with the generated Class Descriptor.
71		*
72		* @param Constant[] $constants
73		*/
74	1	protected function addConstants(array $constants, ClassDescriptor $classDescriptor): void
75		{
76	1	foreach ($constants as $constant) {
77	1	$constantDescriptor = $this->getBuilder()->buildDescriptor($constant);
78	1	if ($constantDescriptor instanceof ConstantDescriptor) {
79		$constantDescriptor->setParent($classDescriptor);
80	1	$classDescriptor->getConstants()->set($constantDescriptor->getName(), $constantDescriptor);
81		}
82		}
83	1	}
84
85		/**
86		* Registers the child properties with the generated Class Descriptor.
87		*
88		* @param Property[] $properties
89		*/
90	1	protected function addProperties(array $properties, ClassDescriptor $classDescriptor): void
91		{
92	1	foreach ($properties as $property) {
93	1	$propertyDescriptor = $this->getBuilder()->buildDescriptor($property);
94	1	if ($propertyDescriptor instanceof PropertyDescriptor) {
95		$propertyDescriptor->setParent($classDescriptor);
96	1	$classDescriptor->getProperties()->set($propertyDescriptor->getName(), $propertyDescriptor);
97		}
98		}
99	1	}
100
101		/**
102		* Registers the child methods with the generated Class Descriptor.
103		*
104		* @param Method[] $methods
105		*/
106	1	protected function addMethods(array $methods, ClassDescriptor $classDescriptor): void
107		{
108	1	foreach ($methods as $method) {
109	1	$methodDescriptor = $this->getBuilder()->buildDescriptor($method);
110	1	if ($methodDescriptor instanceof MethodDescriptor) {
111		$methodDescriptor->setParent($classDescriptor);
112	1	$classDescriptor->getMethods()->set($methodDescriptor->getName(), $methodDescriptor);
113		}
114		}
115	1	}
116
117		/**
118		* Registers the used traits with the generated Class Descriptor.
119		*
120		* @param string[] $traits
121		*/
122	1	protected function addUses(array $traits, ClassDescriptor $classDescriptor): void
123		{
124	1	$classDescriptor->setUsedTraits(new Collection($traits));
125	1	}
126		}
127

phpDocumentor / phpDocumentor

Push — develop ( 8eb671...133594 )

ClassAssembler::create() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like