Gacela\Framework\ClassResolver\DocBlockService\MissingClassDefinitionException

Complexity

Total Complexity

2

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getSuggestions()	0	40	1
A	missingDefinition()	0	11	1

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