Gii::addGenerator() - Code Metrics - Inspection of "Fix lazy loading" - yiisoft/yii-gii - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#124)

by Dmitriy

created 2024-05-29 00:01 UTC

Gii::addGenerator() A

↳ Parent: Gii

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	1	Features	0

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

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Gii;

use Yiisoft\Yii\Gii\Exception\GeneratorNotFoundException;

final class Gii implements GiiInterface
{
    /**
     * @param array<string, GeneratorInterface|GeneratorProxy> $proxies
     * @param array<string, GeneratorInterface> $instances
     */
    public function __construct(
        private readonly array $proxies,
        private array $instances,
    )
    {
    }

    public function addGenerator(GeneratorInterface $generator): void
    {
        $this->instances[$generator::getId()] = $generator;
    }

    public function getGenerator(string $id): GeneratorInterface
    {
        if (isset($this->instances[$id])) {
            return $this->instances[$id];
        }
        return isset($this->proxies[$id])
            ? $this->proxies[$id]->loadGenerator()
            : throw new GeneratorNotFoundException('Generator "' . $id . '" not found');
    }

    public function getGenerators(): array
    {
        return [
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
            ...$this->instances,
            ...$this->proxies,
        ];
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Yii\Gii;
6
7		use Yiisoft\Yii\Gii\Exception\GeneratorNotFoundException;
8
9		final class Gii implements GiiInterface
10		{
11		/**
12		* @param array<string, GeneratorInterface\|GeneratorProxy> $proxies
13		* @param array<string, GeneratorInterface> $instances
14		*/
15	8	public function __construct(
16		private readonly array $proxies,
17		private array $instances,
18		)
19		{
20	8	}
21
22		public function addGenerator(GeneratorInterface $generator): void
23		{
24		$this->instances[$generator::getId()] = $generator;
25		}
26
27	1	public function getGenerator(string $id): GeneratorInterface
28		{
29	1	if (isset($this->instances[$id])) {
30		return $this->instances[$id];
31		}
32	1	return isset($this->proxies[$id])
33		? $this->proxies[$id]->loadGenerator()
34	1	: throw new GeneratorNotFoundException('Generator "' . $id . '" not found');
35		}
36
37	4	public function getGenerators(): array
38		{
39	4	return [
		0 ignored issues – show Bug Best Practice introduced 2024-05-29 00:04 UTC by Report Bug Copy Issue Report The expression `return array($this->instances, $this->proxies)` returns the type `array<integer,array>` which is incompatible with the return type mandated by `Yiisoft\Yii\Gii\GiiInterface::getGenerators()` of `Yiisoft\Yii\Gii\GeneratorInterface[]`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
40	4	...$this->instances,
41	4	...$this->proxies,
42	4	];
43		}
44		}
45

yiisoft / yii-gii

Pull Request — master (#124)

Gii::addGenerator() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like