RecursiveTypeMapper::getClassTree() - Code Metrics - Inspection of "Adding interfaces to generated objects" - thecodingmachine/graphql-controllers - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#45)

by David

created 2018-11-27 16:46 UTC

RecursiveTypeMapper::getClassTree() A

↳ Parent: RecursiveTypeMapper

Complexity

Conditions	3
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	5
dl	0
loc	9
c	0
b	0
f	0
rs	10
cc	3
nc	2
nop	0

<?php


namespace TheCodingMachine\GraphQL\Controllers\Mappers;


use function array_flip;
use function get_parent_class;
use GraphQL\Type\Definition\InputType;
use GraphQL\Type\Definition\InterfaceType;
use GraphQL\Type\Definition\OutputType;
use GraphQL\Type\Definition\Type;
use TheCodingMachine\GraphQL\Controllers\Types\InterfaceFromObjectType;

/**
 * This class wraps a TypeMapperInterface into a RecursiveTypeMapperInterface.
 * While the wrapped class does only tests one given class, the recursive type mapper
 * tests the class and all its parents.
 */
class RecursiveTypeMapper implements RecursiveTypeMapperInterface
{
    /**
     * @var TypeMapperInterface
     */
    private $typeMapper;

    /**
     * An array mapping a class name to the MappedClass instance (useful to know if the class has children)
     *
     * @var array<string,MappedClass>|null
     */
    private $mappedClasses;

    /**
     * An array of interfaces OR object types if no interface matching.
     *
     * @var array<string,OutputType&Type>
     */
    private $interfaces = [];

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

    /**
     * Returns true if this type mapper can map the $className FQCN to a GraphQL type.
     *
     * @param string $className The class name to look for (this function looks into parent classes if the class does not match a type).
     * @return bool
     */
    public function canMapClassToType(string $className): bool
    {
        return $this->findClosestMatchingParent($className) !== null;
    }

    /**
     * Maps a PHP fully qualified class name to a GraphQL type.
     *
     * @param string $className The class name to look for (this function looks into parent classes if the class does not match a type).
     * @return OutputType&Type
     * @throws CannotMapTypeException
     */
    public function mapClassToType(string $className): OutputType
    {
        $closestClassName = $this->findClosestMatchingParent($className);
        if ($closestClassName === null) {
            throw CannotMapTypeException::createForType($className);
        }
        return $this->typeMapper->mapClassToType($closestClassName);
    }

    /**
     * Returns the closest parent that can be mapped, or null if nothing can be matched.
     *
     * @param string $className
     * @return string|null
     */
    private function findClosestMatchingParent(string $className): ?string
    {
        do {
            if ($this->typeMapper->canMapClassToType($className)) {
                return $className;
            }
        } while ($className = get_parent_class($className));
        return null;
    }

    /**
     * Maps a PHP fully qualified class name to a GraphQL interface (or returns null if no interface is found).
     *
     * @param string $className The exact class name to look for (this function does not look into parent classes).
     * @return OutputType&Type
     * @throws CannotMapTypeException
     */
    public function mapClassToInterfaceOrType(string $className): OutputType
    {
        $closestClassName = $this->findClosestMatchingParent($className);
        if ($closestClassName === null) {
            throw CannotMapTypeException::createForType($className);
        }
        if (!isset($this->interfaces[$closestClassName])) {
            $objectType = $this->typeMapper->mapClassToType($closestClassName);

            $supportedClasses = $this->getClassTree();
            if (!empty($supportedClasses[$closestClassName]->getChildren())) {
                // Cast as an interface
                $this->interfaces[$closestClassName] = new InterfaceFromObjectType($objectType, $this);
            } else {
                $this->interfaces[$closestClassName] = $objectType;
            }
        }
        return $this->interfaces[$closestClassName];
    }

    /**
     * Finds the list of interfaces returned by $className.
     *
     * @param string $className
     * @return InterfaceType[]
     */
    public function findInterfaces(string $className): array
    {
        $interfaces = [];
        while ($className = $this->findClosestMatchingParent($className)) {
            $type = $this->mapClassToInterfaceOrType($className);
            if ($type instanceof InterfaceType) {
                $interfaces[] = $type;
            }
            $className = get_parent_class($className);
            if ($className === false) {
                break;
            }
        }
        return $interfaces;
    }

    /**
     * @return array<string,MappedClass>
     */
    private function getClassTree(): array
    {
        if ($this->mappedClasses === null) {
            $supportedClasses = array_flip($this->typeMapper->getSupportedClasses());
            foreach ($supportedClasses as $supportedClass => $foo) {
                $this->getMappedClass($supportedClass, $supportedClasses);
            }
        }
        return $this->mappedClasses;

    }

    /**
     * @param string $className
     * @param array<string,int> $supportedClasses
     * @return MappedClass
     */
    private function getMappedClass(string $className, array $supportedClasses): MappedClass
    {
        if (!isset($this->mappedClasses[$className])) {
            $mappedClass = new MappedClass(/*$className*/);
            $this->mappedClasses[$className] = $mappedClass;
            $parentClassName = $className;
            while ($parentClassName = get_parent_class($parentClassName)) {
                if (isset($supportedClasses[$parentClassName])) {
                    $parentMappedClass = $this->getMappedClass($parentClassName, $supportedClasses);
                    //$mappedClass->setParent($parentMappedClass);
                    $parentMappedClass->addChild($mappedClass);
                    break;
                }
            }
        }
        return $this->mappedClasses[$className];
    }

    /**
     * Returns true if this type mapper can map the $className FQCN to a GraphQL input type.
     *
     * @param string $className
     * @return bool
     */
    public function canMapClassToInputType(string $className): bool
    {
        return $this->typeMapper->canMapClassToInputType($className);
    }

    /**
     * Maps a PHP fully qualified class name to a GraphQL input type.
     *
     * @param string $className
     * @return InputType&Type
     * @throws CannotMapTypeException
     */
    public function mapClassToInputType(string $className): InputType
    {
        return $this->typeMapper->mapClassToInputType($className);
    }
}


1			<?php
2
3
4			namespace TheCodingMachine\GraphQL\Controllers\Mappers;
5
6
7			use function array_flip;
8			use function get_parent_class;
9			use GraphQL\Type\Definition\InputType;
10			use GraphQL\Type\Definition\InterfaceType;
11			use GraphQL\Type\Definition\OutputType;
12			use GraphQL\Type\Definition\Type;
13			use TheCodingMachine\GraphQL\Controllers\Types\InterfaceFromObjectType;
14
15			/**
16			* This class wraps a TypeMapperInterface into a RecursiveTypeMapperInterface.
17			* While the wrapped class does only tests one given class, the recursive type mapper
18			* tests the class and all its parents.
19			*/
20			class RecursiveTypeMapper implements RecursiveTypeMapperInterface
21			{
22			/**
23			* @var TypeMapperInterface
24			*/
25			private $typeMapper;
26
27			/**
28			* An array mapping a class name to the MappedClass instance (useful to know if the class has children)
29			*
30			* @var array<string,MappedClass>\|null
31			*/
32			private $mappedClasses;
33
34			/**
35			* An array of interfaces OR object types if no interface matching.
36			*
37			* @var array<string,OutputType&Type>
38			*/
39			private $interfaces = [];
40
41			public function __construct(TypeMapperInterface $typeMapper)
42			{
43			$this->typeMapper = $typeMapper;
44			}
45
46			/**
47			* Returns true if this type mapper can map the $className FQCN to a GraphQL type.
48			*
49			* @param string $className The class name to look for (this function looks into parent classes if the class does not match a type).
50			* @return bool
51			*/
52			public function canMapClassToType(string $className): bool
53			{
54			return $this->findClosestMatchingParent($className) !== null;
55			}
56
57			/**
58			* Maps a PHP fully qualified class name to a GraphQL type.
59			*
60			* @param string $className The class name to look for (this function looks into parent classes if the class does not match a type).
61			* @return OutputType&Type
62			* @throws CannotMapTypeException
63			*/
64			public function mapClassToType(string $className): OutputType
65			{
66			$closestClassName = $this->findClosestMatchingParent($className);
67			if ($closestClassName === null) {
68			throw CannotMapTypeException::createForType($className);
69			}
70			return $this->typeMapper->mapClassToType($closestClassName);
71			}
72
73			/**
74			* Returns the closest parent that can be mapped, or null if nothing can be matched.
75			*
76			* @param string $className
77			* @return string\|null
78			*/
79			private function findClosestMatchingParent(string $className): ?string
80			{
81			do {
82			if ($this->typeMapper->canMapClassToType($className)) {
83			return $className;
84			}
85			} while ($className = get_parent_class($className));
86			return null;
87			}
88
89			/**
90			* Maps a PHP fully qualified class name to a GraphQL interface (or returns null if no interface is found).
91			*
92			* @param string $className The exact class name to look for (this function does not look into parent classes).
93			* @return OutputType&Type
94			* @throws CannotMapTypeException
95			*/
96			public function mapClassToInterfaceOrType(string $className): OutputType
97			{
98			$closestClassName = $this->findClosestMatchingParent($className);
99			if ($closestClassName === null) {
100			throw CannotMapTypeException::createForType($className);
101			}
102			if (!isset($this->interfaces[$closestClassName])) {
103			$objectType = $this->typeMapper->mapClassToType($closestClassName);
104
105			$supportedClasses = $this->getClassTree();
106			if (!empty($supportedClasses[$closestClassName]->getChildren())) {
107			// Cast as an interface
108			$this->interfaces[$closestClassName] = new InterfaceFromObjectType($objectType, $this);
109			} else {
110			$this->interfaces[$closestClassName] = $objectType;
111			}
112			}
113			return $this->interfaces[$closestClassName];
114			}
115
116			/**
117			* Finds the list of interfaces returned by $className.
118			*
119			* @param string $className
120			* @return InterfaceType[]
121			*/
122			public function findInterfaces(string $className): array
123			{
124			$interfaces = [];
125			while ($className = $this->findClosestMatchingParent($className)) {
126			$type = $this->mapClassToInterfaceOrType($className);
127			if ($type instanceof InterfaceType) {
128			$interfaces[] = $type;
129			}
130			$className = get_parent_class($className);
131			if ($className === false) {
132			break;
133			}
134			}
135			return $interfaces;
136			}
137
138			/**
139			* @return array<string,MappedClass>
140			*/
141			private function getClassTree(): array
142			{
143			if ($this->mappedClasses === null) {
144			$supportedClasses = array_flip($this->typeMapper->getSupportedClasses());
145			foreach ($supportedClasses as $supportedClass => $foo) {
146			$this->getMappedClass($supportedClass, $supportedClasses);
147			}
148			}
149			return $this->mappedClasses;
			0 ignored issues – show Bug Best Practice introduced 2018-11-27 10:08 UTC by Report Bug Copy Issue Report The expression `return $this->mappedClasses` could return the type `null` which is incompatible with the type-hinted return `array`. Consider adding an additional type-check to rule them out. Loading history...
150			}
151
152			/**
153			* @param string $className
154			* @param array<string,int> $supportedClasses
155			* @return MappedClass
156			*/
157			private function getMappedClass(string $className, array $supportedClasses): MappedClass
158			{
159			if (!isset($this->mappedClasses[$className])) {
160			$mappedClass = new MappedClass(/$className/);
161			$this->mappedClasses[$className] = $mappedClass;
162			$parentClassName = $className;
163			while ($parentClassName = get_parent_class($parentClassName)) {
164			if (isset($supportedClasses[$parentClassName])) {
165			$parentMappedClass = $this->getMappedClass($parentClassName, $supportedClasses);
166			//$mappedClass->setParent($parentMappedClass);
167			$parentMappedClass->addChild($mappedClass);
168			break;
169			}
170			}
171			}
172			return $this->mappedClasses[$className];
173			}
174
175			/**
176			* Returns true if this type mapper can map the $className FQCN to a GraphQL input type.
177			*
178			* @param string $className
179			* @return bool
180			*/
181			public function canMapClassToInputType(string $className): bool
182			{
183			return $this->typeMapper->canMapClassToInputType($className);
184			}
185
186			/**
187			* Maps a PHP fully qualified class name to a GraphQL input type.
188			*
189			* @param string $className
190			* @return InputType&Type
191			* @throws CannotMapTypeException
192			*/
193			public function mapClassToInputType(string $className): InputType
194			{
195			return $this->typeMapper->mapClassToInputType($className);
196			}
197			}
198

thecodingmachine / graphql-controllers

Pull Request — master (#45)

RecursiveTypeMapper::getClassTree() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like