MissingClassDefinitionException::missingDefinition() - Code Metrics - Inspection of "Add production optimization and developer experien..." - gacela-project/gacela - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — main (#342)

by Chema

created 2025-11-09 11:29 UTC

missingDefinition() A

↳ Parent: MissingClassDefinitionException

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Gacela\Framework\ClassResolver\DocBlockService;

use RuntimeException;

final class MissingClassDefinitionException extends RuntimeException
{
    public static function missingDefinition(string $className, string $method, string $found): self
    {
        $suggestions = self::getSuggestions($method);

        return new self("
Missing the concrete return type for the method `{$method}()` (Found: `{$found}`).

Class: `{$className}`

Possible solutions:
{$suggestions}

Learn more: https://gacela-project.com/docs/service-resolution
");
    }

    private static function getSuggestions(string $method): string
    {
        $suggestions = [];

        // Add suggestion for using ServiceMap attribute
        $suggestions[] = "1. Use the #[ServiceMap] attribute (recommended - fastest):

   use Gacela\Framework\ClassResolver\Attribute\ServiceMap;

   #[ServiceMap('{$method}', YourClass::class)]
   final class YourFacade extends AbstractFacade
   {
       public function {$method}(): YourClass
       {
           return \$this->resolve(YourClass::class);
       }
   }";

        // Add suggestion for DocBlock
        $suggestions[] = "2. Add a DocBlock with the return type:

   /**
    * @method YourClass {$method}()
    */
   final class YourFacade extends AbstractFacade
   {
   }";

        // Add suggestion for inline type hint
        $suggestions[] = "3. Add an inline return type hint:

   final class YourFacade extends AbstractFacade
   {
       public function {$method}(): YourClass
       {
           return \$this->resolve(YourClass::class);
       }
   }";

        return implode("\n\n", $suggestions);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Gacela\Framework\ClassResolver\DocBlockService;
6
7		use RuntimeException;
8
9		final class MissingClassDefinitionException extends RuntimeException
10		{
11	3	public static function missingDefinition(string $className, string $method, string $found): self
12		{
13	3	$suggestions = self::getSuggestions($method);
14	3
15		return new self("
16		Missing the concrete return type for the method `{$method}()` (Found: `{$found}`).
17	3
18	3	Class: `{$className}`
19
20		Possible solutions:
21		{$suggestions}
22
23		Learn more: https://gacela-project.com/docs/service-resolution
24		");
25		}
26
27		private static function getSuggestions(string $method): string
28		{
29		$suggestions = [];
30
31		// Add suggestion for using ServiceMap attribute
32		$suggestions[] = "1. Use the #[ServiceMap] attribute (recommended - fastest):
33
34		use Gacela\Framework\ClassResolver\Attribute\ServiceMap;
35
36		#[ServiceMap('{$method}', YourClass::class)]
37		final class YourFacade extends AbstractFacade
38		{
39		public function {$method}(): YourClass
40		{
41		return \$this->resolve(YourClass::class);
42		}
43		}";
44
45		// Add suggestion for DocBlock
46		$suggestions[] = "2. Add a DocBlock with the return type:
47
48		/**
49		* @method YourClass {$method}()
50		*/
51		final class YourFacade extends AbstractFacade
52		{
53		}";
54
55		// Add suggestion for inline type hint
56		$suggestions[] = "3. Add an inline return type hint:
57
58		final class YourFacade extends AbstractFacade
59		{
60		public function {$method}(): YourClass
61		{
62		return \$this->resolve(YourClass::class);
63		}
64		}";
65
66		return implode("\n\n", $suggestions);
67		}
68		}
69

gacela-project / gacela

Pull Request — main (#342)

missingDefinition() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like