[TASK] Improve warning vor invalid method names (#37)

Output context and make more clear we are talking about a method description here
TYPO3-Documentation · Mar 2, 2024 · cec5826 · cec5826
1 parent b4b38b8
commit cec5826
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/src/Directives/Php/MethodDirective.php b/src/Directives/Php/MethodDirective.php
@@ -102,7 +102,7 @@ protected function processSub(
         CollectionNode $collectionNode,
         Directive $directive,
     ): Node|null {
-        $name = $this->methodNameService->getMethodName(trim($directive->getData()));
+        $name = $this->methodNameService->getMethodName($blockContext, trim($directive->getData()));
         $id = $this->anchorNormalizer->reduceAnchor($name->toString());
 
         $modifiers = $this->modifierService->getModifiersFromDirectiveOptions($directive, $this->allowedModifiers);

diff --git a/src/Directives/Php/StaticMethodDirective.php b/src/Directives/Php/StaticMethodDirective.php
@@ -44,7 +44,7 @@ protected function processSub(
             'Directive `.. php:staticmethod::` is deprecated use directive `.. php:method::` with option `:static:` instead. ',
             $blockContext->getLoggerInformation()
         );
-        $name = $this->methodNameService->getMethodName(trim($directive->getData()));
+        $name = $this->methodNameService->getMethodName($blockContext, trim($directive->getData()));
         $id = $this->anchorNormalizer->reduceAnchor($name->toString());
 
         return new PhpMethodNode(

diff --git a/src/PhpDomain/MethodNameService.php b/src/PhpDomain/MethodNameService.php
@@ -4,6 +4,7 @@
 
 namespace T3Docs\GuidesPhpDomain\PhpDomain;
 
+use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
 use Psr\Log\LoggerInterface;
 use T3Docs\GuidesPhpDomain\Nodes\MethodNameNode;
 
@@ -18,7 +19,7 @@ public function __construct(
         private readonly LoggerInterface $logger
     ) {}
 
-    public function getMethodName(string $name): MethodNameNode
+    public function getMethodName(BlockContext $blockContext, string $name): MethodNameNode
     {
         if (preg_match(self::METHOD_SIGNATURE_REGEX, $name, $matches)) {
             $methodName = $matches[1];
@@ -30,7 +31,7 @@ public function getMethodName(string $name): MethodNameNode
             }
             return new MethodNameNode($methodName, $parametersArray, $returnType);
         }
-        $this->logger->warning(sprintf('Method signature %s is invalid. ', $name));
+        $this->logger->warning(sprintf('Method signature %s in PHP-domain method description is invalid. ', $name), $blockContext->getLoggerInformation());
         return new MethodNameNode($name, [], null);
     }
 }