Schema::getGroup() - Code Metrics - Inspection of "Merge pull request #54 from Toilal/php-support" - goetas-webservices/xsd-reader - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5235c9...9b3e12 )

by Asmir

created 2020-08-24 12:22 UTC

Schema::getGroup() A

↳ Parent: Schema

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2.0625

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	3
c	1
b	0
f	0
dl	0
loc	7
ccs	3
cts	4
cp	0.75
rs	10
cc	2
nc	2
nop	1
crap	2.0625

<?php

declare(strict_types=1);

namespace GoetasWebservices\XML\XSDReader\Schema;

use GoetasWebservices\XML\XSDReader\Schema\Attribute\AttributeDef;
use GoetasWebservices\XML\XSDReader\Schema\Attribute\AttributeItem;
use GoetasWebservices\XML\XSDReader\Schema\Attribute\Group as AttributeGroup;
use GoetasWebservices\XML\XSDReader\Schema\Element\ElementDef;
use GoetasWebservices\XML\XSDReader\Schema\Element\ElementItem;
use GoetasWebservices\XML\XSDReader\Schema\Element\Group;
use GoetasWebservices\XML\XSDReader\Schema\Exception\SchemaException;
use GoetasWebservices\XML\XSDReader\Schema\Exception\TypeNotFoundException;
use GoetasWebservices\XML\XSDReader\Schema\Type\Type;

class Schema
{
    /**
     * @param bool[] $calling
     */
    protected function findSomethingNoThrow(
        string $getter,
        string $name,
        string $namespace = null,
        array &$calling = []
    ): ? SchemaItem {
        $calling[spl_object_hash($this)] = true;
        $cid = "$getter, $name, $namespace";

        if (isset($this->typeCache[$cid])) {
            return $this->typeCache[$cid];
        } elseif (
            $this->getTargetNamespace() === $namespace
        ) {
            /**
             * @var SchemaItem|null
             */
            $item = $this->$getter($name);

            if ($item instanceof SchemaItem) {
                return $this->typeCache[$cid] = $item;
            }
        }

        return $this->findSomethingNoThrowSchemas(
            $this->getSchemas(),
            $cid,
            $getter,
            $name,
            $namespace,
            $calling
        );
    }

    /**
     * @param Schema[] $schemas
     * @param bool[]   $calling
     */
    protected function findSomethingNoThrowSchemas(
        array $schemas,
        string $cid,
        string $getter,
        string $name,
        string $namespace = null,
        array &$calling = []
    ): ? SchemaItem {
        foreach ($schemas as $childSchema) {
            if (!isset($calling[spl_object_hash($childSchema)])) {
                /**
                 * @var SchemaItem|null
                 */
                $in = $childSchema->findSomethingNoThrow($getter, $name, $namespace, $calling);

                if ($in instanceof SchemaItem) {
                    return $this->typeCache[$cid] = $in;
                }
            }
        }

        return null;
    }

    /**
     * @param array<mixed> $calling
     *
     * @throws TypeNotFoundException
     */
    protected function findSomething(string $getter, string $name, string $namespace = null, array &$calling = []): SchemaItem
    {
        $in = $this->findSomethingNoThrow(
            $getter,
            $name,
            $namespace,
            $calling
        );

        if ($in instanceof SchemaItem) {
            return $in;
        }

        throw new TypeNotFoundException(sprintf("Can't find the %s named {%s}#%s.", substr($getter, 3), $namespace, $name));
    }

    /**
     * @var bool
     */
    protected $elementsQualification = false;

    /**
     * @var bool
     */
    protected $attributesQualification = false;

    /**
     * @var string|null
     */
    protected $targetNamespace;

    /**
     * @var Schema[]
     */
    protected $schemas = [];

    /**
     * @var Type[]
     */
    protected $types = [];

    /**
     * @var ElementDef[]
     */
    protected $elements = [];

    /**
     * @var Group[]
     */
    protected $groups = [];

    /**
     * @var AttributeGroup[]
     */
    protected $attributeGroups = [];

    /**
     * @var AttributeDef[]
     */
    protected $attributes = [];

    /**
     * @var string|null
     */
    protected $doc;

    /**
     * @var \GoetasWebservices\XML\XSDReader\Schema\SchemaItem[]
     */
    protected $typeCache = [];

    public function getElementsQualification(): bool
    {
        return $this->elementsQualification;
    }

    public function setElementsQualification(bool $elementsQualification): void
    {
        $this->elementsQualification = $elementsQualification;
    }

    public function getAttributesQualification(): bool
    {
        return $this->attributesQualification;
    }

    public function setAttributesQualification(bool $attributesQualification): void
    {
        $this->attributesQualification = $attributesQualification;
    }

    public function getTargetNamespace(): ?string
    {
        return $this->targetNamespace;
    }

    public function setTargetNamespace(? string $targetNamespace): void
    {
        $this->targetNamespace = $targetNamespace;
    }

    /**
     * @return Type[]
     */
    public function getTypes(): array
    {
        return $this->types;
    }

    /**
     * @return ElementDef[]
     */
    public function getElements(): array
    {
        return $this->elements;
    }

    /**
     * @return Schema[]
     */
    public function getSchemas(): array
    {
        return $this->schemas;
    }

    /**
     * @return AttributeDef[]
     */
    public function getAttributes(): array
    {
        return $this->attributes;
    }

    /**
     * @return Group[]
     */
    public function getGroups(): array
    {
        return $this->groups;
    }

    public function getDoc(): ?string
    {
        return $this->doc;
    }

    public function setDoc(string $doc): void
    {
        $this->doc = $doc;
    }

    public function addType(Type $type): void
    {
        $this->types[(string) $type->getName()] = $type;
    }

    public function addElement(ElementDef $element): void
    {
        $this->elements[$element->getName()] = $element;
    }

    public function addSchema(self $schema, string $namespace = null): void
    {
        if ($namespace === null) {
            $this->schemas[] = $schema;

            return;
        }

        if ($schema->getTargetNamespace() !== $namespace) {
            throw new SchemaException(sprintf("The target namespace ('%s') for schema, does not match the declared namespace '%s'", $schema->getTargetNamespace(), $namespace));
        }

        if (isset($this->schemas[$namespace])) {
            $this->schemas[$namespace]->addSchema($schema);

            return;
        }

        $this->schemas[$namespace] = $schema;
    }

    public function addAttribute(AttributeDef $attribute): void
    {
        $this->attributes[$attribute->getName()] = $attribute;
    }

    public function addGroup(Group $group): void
    {
        $this->groups[$group->getName()] = $group;
    }

    public function addAttributeGroup(AttributeGroup $group): void
    {
        $this->attributeGroups[$group->getName()] = $group;
    }

    /**
     * @return AttributeGroup[]
     */
    public function getAttributeGroups(): array
    {
        return $this->attributeGroups;
    }

    public function getGroup(string $name): ?Group
    {
        if (isset($this->groups[$name])) {
            return $this->groups[$name];
        }

        return null;
    }

    public function getElement(string $name): ?ElementItem
    {
        if (isset($this->elements[$name])) {
            return $this->elements[$name];
        }

        return null;
    }

    public function getType(string $name): ?Type
    {
        if (isset($this->types[$name])) {
            return $this->types[$name];
        }

        return null;
    }

    public function getAttribute(string $name): ? AttributeItem
    {
        if (isset($this->attributes[$name])) {
            return $this->attributes[$name];
        }

        return null;
    }

    public function getAttributeGroup(string $name): ?AttributeGroup
    {
        if (isset($this->attributeGroups[$name])) {
            return $this->attributeGroups[$name];
        }

        return null;
    }

    public function __toString(): string
    {
        return sprintf('Target namespace %s', $this->getTargetNamespace());
    }

    public function findType(string $name, string $namespace = null): Type
    {
        $out = $this->findSomething('getType', $name, $namespace);

        if (!($out instanceof Type)) {
            throw new TypeNotFoundException(sprintf("Can't find the %s named {%s}#%s.", 'Type', $namespace, $name));
        }

        return $out;
    }

    public function findGroup(string $name, string $namespace = null): Group
    {
        $out = $this->findSomething('getGroup', $name, $namespace);

        if (!($out instanceof Group)) {
            throw new TypeNotFoundException(sprintf("Can't find the %s named {%s}#%s.", 'Group', $namespace, $name));
        }

        return $out;
    }

    public function findElement(string $name, string $namespace = null): ElementDef
    {
        $out = $this->findSomething('getElement', $name, $namespace);

        if (!($out instanceof ElementDef)) {
            throw new TypeNotFoundException(sprintf("Can't find the %s named {%s}#%s.", 'Element', $namespace, $name));
        }

        return $out;
    }

    public function findAttribute(string $name, string $namespace = null): AttributeItem
    {
        $out = $this->findSomething('getAttribute', $name, $namespace);

        if (!($out instanceof AttributeItem)) {
            throw new TypeNotFoundException(sprintf("Can't find the %s named {%s}#%s.", 'Attribute', $namespace, $name));
        }

        return $out;
    }

    public function findAttributeGroup(string $name, string $namespace = null): AttributeGroup
    {
        $out = $this->findSomething('getAttributeGroup', $name, $namespace);

        if (!($out instanceof AttributeGroup)) {
            throw new TypeNotFoundException(sprintf("Can't find the %s named {%s}#%s.", 'AttributeGroup', $namespace, $name));
        }

        return $out;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace GoetasWebservices\XML\XSDReader\Schema;
6
7		use GoetasWebservices\XML\XSDReader\Schema\Attribute\AttributeDef;
8		use GoetasWebservices\XML\XSDReader\Schema\Attribute\AttributeItem;
9		use GoetasWebservices\XML\XSDReader\Schema\Attribute\Group as AttributeGroup;
10		use GoetasWebservices\XML\XSDReader\Schema\Element\ElementDef;
11		use GoetasWebservices\XML\XSDReader\Schema\Element\ElementItem;
12		use GoetasWebservices\XML\XSDReader\Schema\Element\Group;
13		use GoetasWebservices\XML\XSDReader\Schema\Exception\SchemaException;
14		use GoetasWebservices\XML\XSDReader\Schema\Exception\TypeNotFoundException;
15		use GoetasWebservices\XML\XSDReader\Schema\Type\Type;
16
17		class Schema
18		{
19		/**
20		* @param bool[] $calling
21		*/
22	67	protected function findSomethingNoThrow(
23		string $getter,
24		string $name,
25		string $namespace = null,
26		array &$calling = []
27		): ? SchemaItem {
28	67	$calling[spl_object_hash($this)] = true;
29	67	$cid = "$getter, $name, $namespace";
30
31	67	if (isset($this->typeCache[$cid])) {
32	67	return $this->typeCache[$cid];
33		} elseif (
34	67	$this->getTargetNamespace() === $namespace
35		) {
36		/**
37		* @var SchemaItem\|null
38		*/
39	67	$item = $this->$getter($name);
40
41	67	if ($item instanceof SchemaItem) {
42	67	return $this->typeCache[$cid] = $item;
43		}
44		}
45
46	67	return $this->findSomethingNoThrowSchemas(
47	67	$this->getSchemas(),
48	67	$cid,
49	67	$getter,
50	67	$name,
51	67	$namespace,
52	67	$calling
53		);
54		}
55
56		/**
57		* @param Schema[] $schemas
58		* @param bool[] $calling
59		*/
60	67	protected function findSomethingNoThrowSchemas(
61		array $schemas,
62		string $cid,
63		string $getter,
64		string $name,
65		string $namespace = null,
66		array &$calling = []
67		): ? SchemaItem {
68	67	foreach ($schemas as $childSchema) {
69	67	if (!isset($calling[spl_object_hash($childSchema)])) {
70		/**
71		* @var SchemaItem\|null
72		*/
73	67	$in = $childSchema->findSomethingNoThrow($getter, $name, $namespace, $calling);
74
75	67	if ($in instanceof SchemaItem) {
76	67	return $this->typeCache[$cid] = $in;
77		}
78		}
79		}
80
81	12	return null;
82		}
83
84		/**
85		* @param array<mixed> $calling
86		*
87		* @throws TypeNotFoundException
88		*/
89	67	protected function findSomething(string $getter, string $name, string $namespace = null, array &$calling = []): SchemaItem
90		{
91	67	$in = $this->findSomethingNoThrow(
92	67	$getter,
93	67	$name,
94	67	$namespace,
95	67	$calling
96		);
97
98	67	if ($in instanceof SchemaItem) {
99	67	return $in;
100		}
101
102	6	throw new TypeNotFoundException(sprintf("Can't find the %s named {%s}#%s.", substr($getter, 3), $namespace, $name));
103		}
104
105		/**
106		* @var bool
107		*/
108		protected $elementsQualification = false;
109
110		/**
111		* @var bool
112		*/
113		protected $attributesQualification = false;
114
115		/**
116		* @var string\|null
117		*/
118		protected $targetNamespace;
119
120		/**
121		* @var Schema[]
122		*/
123		protected $schemas = [];
124
125		/**
126		* @var Type[]
127		*/
128		protected $types = [];
129
130		/**
131		* @var ElementDef[]
132		*/
133		protected $elements = [];
134
135		/**
136		* @var Group[]
137		*/
138		protected $groups = [];
139
140		/**
141		* @var AttributeGroup[]
142		*/
143		protected $attributeGroups = [];
144
145		/**
146		* @var AttributeDef[]
147		*/
148		protected $attributes = [];
149
150		/**
151		* @var string\|null
152		*/
153		protected $doc;
154
155		/**
156		* @var \GoetasWebservices\XML\XSDReader\Schema\SchemaItem[]
157		*/
158		protected $typeCache = [];
159
160	1	public function getElementsQualification(): bool
161		{
162	1	return $this->elementsQualification;
163		}
164
165	67	public function setElementsQualification(bool $elementsQualification): void
166		{
167	67	$this->elementsQualification = $elementsQualification;
168	67	}
169
170		public function getAttributesQualification(): bool
171		{
172		return $this->attributesQualification;
173		}
174
175	67	public function setAttributesQualification(bool $attributesQualification): void
176		{
177	67	$this->attributesQualification = $attributesQualification;
178	67	}
179
180	67	public function getTargetNamespace(): ?string
181		{
182	67	return $this->targetNamespace;
183		}
184
185	67	public function setTargetNamespace(? string $targetNamespace): void
186		{
187	67	$this->targetNamespace = $targetNamespace;
188	67	}
189
190		/**
191		* @return Type[]
192		*/
193	6	public function getTypes(): array
194		{
195	6	return $this->types;
196		}
197
198		/**
199		* @return ElementDef[]
200		*/
201	4	public function getElements(): array
202		{
203	4	return $this->elements;
204		}
205
206		/**
207		* @return Schema[]
208		*/
209	67	public function getSchemas(): array
210		{
211	67	return $this->schemas;
212		}
213
214		/**
215		* @return AttributeDef[]
216		*/
217	1	public function getAttributes(): array
218		{
219	1	return $this->attributes;
220		}
221
222		/**
223		* @return Group[]
224		*/
225	2	public function getGroups(): array
226		{
227	2	return $this->groups;
228		}
229
230		public function getDoc(): ?string
231		{
232		return $this->doc;
233		}
234
235	67	public function setDoc(string $doc): void
236		{
237	67	$this->doc = $doc;
238	67	}
239
240	67	public function addType(Type $type): void
241		{
242	67	$this->types[(string) $type->getName()] = $type;
243	67	}
244
245	67	public function addElement(ElementDef $element): void
246		{
247	67	$this->elements[$element->getName()] = $element;
248	67	}
249
250	67	public function addSchema(self $schema, string $namespace = null): void
251		{
252	67	if ($namespace === null) {
253	67	$this->schemas[] = $schema;
254
255	67	return;
256		}
257
258	67	if ($schema->getTargetNamespace() !== $namespace) {
259		throw new SchemaException(sprintf("The target namespace ('%s') for schema, does not match the declared namespace '%s'", $schema->getTargetNamespace(), $namespace));
260		}
261
262	67	if (isset($this->schemas[$namespace])) {
263	1	$this->schemas[$namespace]->addSchema($schema);
264
265	1	return;
266		}
267
268	67	$this->schemas[$namespace] = $schema;
269	67	}
270
271	67	public function addAttribute(AttributeDef $attribute): void
272		{
273	67	$this->attributes[$attribute->getName()] = $attribute;
274	67	}
275
276	67	public function addGroup(Group $group): void
277		{
278	67	$this->groups[$group->getName()] = $group;
279	67	}
280
281	67	public function addAttributeGroup(AttributeGroup $group): void
282		{
283	67	$this->attributeGroups[$group->getName()] = $group;
284	67	}
285
286		/**
287		* @return AttributeGroup[]
288		*/
289	1	public function getAttributeGroups(): array
290		{
291	1	return $this->attributeGroups;
292		}
293
294	67	public function getGroup(string $name): ?Group
295		{
296	67	if (isset($this->groups[$name])) {
297	67	return $this->groups[$name];
298		}
299
300		return null;
301		}
302
303	67	public function getElement(string $name): ?ElementItem
304		{
305	67	if (isset($this->elements[$name])) {
306	67	return $this->elements[$name];
307		}
308
309	1	return null;
310		}
311
312	67	public function getType(string $name): ?Type
313		{
314	67	if (isset($this->types[$name])) {
315	67	return $this->types[$name];
316		}
317
318	1	return null;
319		}
320
321	67	public function getAttribute(string $name): ? AttributeItem
322		{
323	67	if (isset($this->attributes[$name])) {
324	67	return $this->attributes[$name];
325		}
326
327		return null;
328		}
329
330	67	public function getAttributeGroup(string $name): ?AttributeGroup
331		{
332	67	if (isset($this->attributeGroups[$name])) {
333	67	return $this->attributeGroups[$name];
334		}
335
336		return null;
337		}
338
339		public function __toString(): string
340		{
341		return sprintf('Target namespace %s', $this->getTargetNamespace());
342		}
343
344	67	public function findType(string $name, string $namespace = null): Type
345		{
346	67	$out = $this->findSomething('getType', $name, $namespace);
347
348	67	if (!($out instanceof Type)) {
349		throw new TypeNotFoundException(sprintf("Can't find the %s named {%s}#%s.", 'Type', $namespace, $name));
350		}
351
352	67	return $out;
353		}
354
355	67	public function findGroup(string $name, string $namespace = null): Group
356		{
357	67	$out = $this->findSomething('getGroup', $name, $namespace);
358
359	67	if (!($out instanceof Group)) {
360		throw new TypeNotFoundException(sprintf("Can't find the %s named {%s}#%s.", 'Group', $namespace, $name));
361		}
362
363	67	return $out;
364		}
365
366	67	public function findElement(string $name, string $namespace = null): ElementDef
367		{
368	67	$out = $this->findSomething('getElement', $name, $namespace);
369
370	67	if (!($out instanceof ElementDef)) {
371		throw new TypeNotFoundException(sprintf("Can't find the %s named {%s}#%s.", 'Element', $namespace, $name));
372		}
373
374	67	return $out;
375		}
376
377	67	public function findAttribute(string $name, string $namespace = null): AttributeItem
378		{
379	67	$out = $this->findSomething('getAttribute', $name, $namespace);
380
381	67	if (!($out instanceof AttributeItem)) {
382		throw new TypeNotFoundException(sprintf("Can't find the %s named {%s}#%s.", 'Attribute', $namespace, $name));
383		}
384
385	67	return $out;
386		}
387
388	67	public function findAttributeGroup(string $name, string $namespace = null): AttributeGroup
389		{
390	67	$out = $this->findSomething('getAttributeGroup', $name, $namespace);
391
392	67	if (!($out instanceof AttributeGroup)) {
393		throw new TypeNotFoundException(sprintf("Can't find the %s named {%s}#%s.", 'AttributeGroup', $namespace, $name));
394		}
395
396	67	return $out;
397		}
398		}
399

goetas-webservices / xsd-reader

Push — master ( 5235c9...9b3e12 )

Schema::getGroup() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like