Fix deprecations in the codebase

phpDocumentor · Nov 30, 2024 · 37f375b · 37f375b
1 parent ca2098e
commit 37f375b
Show file tree

Hide file tree

Showing 31 changed files with 146 additions and 107 deletions.
diff --git a/packages/guides-graphs/resources/template/html/body/uml.html.twig b/packages/guides-graphs/resources/template/html/body/uml.html.twig
@@ -1,9 +1,8 @@
-{% apply spaceless %}
-    <figure
-        class="uml-diagram{% if node.classesString %} {{ node.classesString }}{% endif %}"
-        {% if node.hasOption('width') %}style="width: {{ node.option('width') }}"{% endif %}
-    >
-        {{ uml(node.value) }}
-    {% if node.caption %}<figcaption>{{ node.caption }}</figcaption>{% endif %}
-    </figure>
-{% endapply %}
+<figure class="uml-diagram{% if node.classesString %} {{ node.classesString }}{% endif %}"
+    {%- if node.hasOption('width') %} style="width: {{ node.option('width') }}"{% endif -%}
+>
+    {{ uml(node.value) }}
+    {% if node.caption %}
+    <figcaption>{{ node.caption }}</figcaption>
+    {% endif %}
+</figure>
diff --git a/packages/guides-markdown/src/Markdown/Parsers/InlineParsers/EmphasisParser.php b/packages/guides-markdown/src/Markdown/Parsers/InlineParsers/EmphasisParser.php
@@ -19,6 +19,7 @@
 use phpDocumentor\Guides\Nodes\Inline\InlineNode;
 use phpDocumentor\Guides\Nodes\Inline\InlineNodeInterface;
 use Psr\Log\LoggerInterface;
+use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
 
 /** @extends AbstractInlineTextDecoratorParser<EmphasisInlineNode> */
 final class EmphasisParser extends AbstractInlineTextDecoratorParser
@@ -39,7 +40,7 @@ protected function getType(): string
     /** @param InlineNodeInterface[] $children */
     protected function createInlineNode(CommonMarkNode $commonMarkNode, string|null $content, array $children = []): InlineNodeInterface
     {
-        return new EmphasisInlineNode($content ?? '', $children);
+        return new EmphasisInlineNode($content ? [new PlainTextInlineNode($content)] : $children);
     }
 
     protected function supportsCommonMarkNode(CommonMarkNode $commonMarkNode): bool

diff --git a/packages/guides-markdown/src/Markdown/Parsers/InlineParsers/LinkParser.php b/packages/guides-markdown/src/Markdown/Parsers/InlineParsers/LinkParser.php
@@ -20,6 +20,7 @@
 use phpDocumentor\Guides\Nodes\Inline\InlineNodeInterface;
 use Psr\Log\LoggerInterface;
 
+use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
 use function assert;
 use function filter_var;
 use function str_ends_with;
@@ -48,13 +49,12 @@ protected function createInlineNode(CommonMarkNode $commonMarkNode, string|null
     {
         assert($commonMarkNode instanceof Link);
 
-        $content ??= $commonMarkNode->getUrl();
         $url =  $commonMarkNode->getUrl();
         if (str_ends_with($url, '.md') && filter_var($url, FILTER_VALIDATE_URL) === false) {
             $url = substr($url, 0, -3);
         }
 
-        return new HyperLinkNode($content, $url, $children);
+        return new HyperLinkNode($content ? [new PlainTextInlineNode($content)] : $children, $url);
     }
 
     protected function supportsCommonMarkNode(CommonMarkNode $commonMarkNode): bool

diff --git a/packages/guides-markdown/src/Markdown/Parsers/InlineParsers/StrongParser.php b/packages/guides-markdown/src/Markdown/Parsers/InlineParsers/StrongParser.php
@@ -17,6 +17,7 @@
 use League\CommonMark\Node\Node as CommonMarkNode;
 use phpDocumentor\Guides\Nodes\Inline\InlineNode;
 use phpDocumentor\Guides\Nodes\Inline\InlineNodeInterface;
+use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
 use phpDocumentor\Guides\Nodes\Inline\StrongInlineNode;
 use Psr\Log\LoggerInterface;
 
@@ -39,7 +40,7 @@ protected function getType(): string
     /** @param InlineNodeInterface[] $children */
     protected function createInlineNode(CommonMarkNode $commonMarkNode, string|null $content, array $children = []): InlineNodeInterface
     {
-        return new StrongInlineNode($content ?? '', $children);
+        return new StrongInlineNode($content ? [new PlainTextInlineNode($content)] : $children);
     }
 
     protected function supportsCommonMarkNode(CommonMarkNode $commonMarkNode): bool

diff --git a/packages/guides-restructured-text/src/RestructuredText/Directives/ImageDirective.php b/packages/guides-restructured-text/src/RestructuredText/Directives/ImageDirective.php
@@ -77,21 +77,21 @@ public function processNode(
     private function resolveLinkTarget(string $targetReference): LinkInlineNode
     {
         if (filter_var($targetReference, FILTER_VALIDATE_EMAIL)) {
-            return new HyperLinkNode('', $targetReference);
+            return new HyperLinkNode([], $targetReference);
         }
 
         if (filter_var($targetReference, FILTER_VALIDATE_URL)) {
-            return new HyperLinkNode('', $targetReference);
+            return new HyperLinkNode([], $targetReference);
         }
 
         if (preg_match(self::REFERENCE_REGEX, $targetReference, $matches)) {
-            return new ReferenceNode($matches[1], '');
+            return new ReferenceNode($matches[1]);
         }
 
         if (preg_match(self::REFERENCE_ESCAPED_REGEX, $targetReference, $matches)) {
-            return new ReferenceNode($matches[1], '');
+            return new ReferenceNode($matches[1]);
         }
 
-        return new DocReferenceNode($targetReference, '');
+        return new DocReferenceNode($targetReference);
     }
 }
diff --git a/...es-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/EmphasisRule.php b/...es-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/EmphasisRule.php
@@ -15,6 +15,7 @@
 
 use phpDocumentor\Guides\Nodes\Inline\EmphasisInlineNode;
 use phpDocumentor\Guides\Nodes\Inline\InlineNodeInterface;
+use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
 use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
 use phpDocumentor\Guides\RestructuredText\Parser\InlineLexer;
 
@@ -45,7 +46,7 @@ public function apply(BlockContext $blockContext, InlineLexer $lexer): InlineNod
 
                     $lexer->moveNext();
 
-                    return new EmphasisInlineNode($text);
+                    return new EmphasisInlineNode([new PlainTextInlineNode($text)]);
 
                 default:
                     $text .= $token->value;

diff --git a/...s-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/ReferenceRule.php b/...s-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/ReferenceRule.php
@@ -16,6 +16,7 @@
 use phpDocumentor\Guides\Nodes\Inline\AbstractLinkInlineNode;
 use phpDocumentor\Guides\Nodes\Inline\DocReferenceNode;
 use phpDocumentor\Guides\Nodes\Inline\HyperLinkNode;
+use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
 use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
 
 use function filter_var;
@@ -39,13 +40,17 @@ protected function createReference(BlockContext $blockContext, string $reference
         if (str_ends_with($reference, '.rst') && filter_var($reference, FILTER_VALIDATE_URL) === false) {
             $reference = substr($reference, 0, -4);
 
-            return new DocReferenceNode($reference, $text ?? $reference);
+            $text ??= $reference;
+
+            return new DocReferenceNode($reference, $text !== '' ? [new PlainTextInlineNode($text)] : []);
         }
 
         if ($registerLink && $text !== null) {
             $blockContext->getDocumentParserContext()->setLink($text, $reference);
         }
 
-        return new HyperLinkNode($text ?? $reference, $reference);
+        $text ??= $reference;
+
+        return new HyperLinkNode($text !== '' ? [new PlainTextInlineNode($text)] : [], $reference);
     }
 }
diff --git a/...ides-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/StrongRule.php b/...ides-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/StrongRule.php
@@ -14,6 +14,7 @@
 namespace phpDocumentor\Guides\RestructuredText\Parser\Productions\InlineRules;
 
 use phpDocumentor\Guides\Nodes\Inline\InlineNodeInterface;
+use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
 use phpDocumentor\Guides\Nodes\Inline\StrongInlineNode;
 use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
 use phpDocumentor\Guides\RestructuredText\Parser\InlineLexer;
@@ -45,7 +46,7 @@ public function apply(BlockContext $blockContext, InlineLexer $lexer): InlineNod
 
                     $lexer->moveNext();
 
-                    return new StrongInlineNode($text);
+                    return new StrongInlineNode([new PlainTextInlineNode($text)]);
 
                 default:
                     $text .= $token->value;

diff --git a/packages/guides-restructured-text/src/RestructuredText/TextRoles/ApiClassTextRole.php b/packages/guides-restructured-text/src/RestructuredText/TextRoles/ApiClassTextRole.php
@@ -14,6 +14,7 @@
 namespace phpDocumentor\Guides\RestructuredText\TextRoles;
 
 use phpDocumentor\Guides\Nodes\Inline\AbstractLinkInlineNode;
+use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
 use phpDocumentor\Guides\Nodes\Inline\ReferenceNode;
 use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
 use phpDocumentor\Guides\RestructuredText\Parser\Interlink\InterlinkParser;
@@ -49,6 +50,6 @@ protected function createNode(string $referenceTarget, string|null $referenceNam
         $reference = $this->anchorReducer->reduceAnchor($interlinkData->reference);
         $prefix = $this->genericLinkProvider->getLinkPrefix($role);
 
-        return new ReferenceNode($reference, $referenceName ?? '', $interlinkData->interlink, self::TYPE, $prefix);
+        return new ReferenceNode($reference, $referenceName ? [new PlainTextInlineNode($referenceName)] : [], $interlinkData->interlink, self::TYPE, $prefix);
     }
 }
diff --git a/packages/guides-restructured-text/src/RestructuredText/TextRoles/DocReferenceTextRole.php b/packages/guides-restructured-text/src/RestructuredText/TextRoles/DocReferenceTextRole.php
@@ -15,6 +15,7 @@
 
 use phpDocumentor\Guides\Nodes\Inline\AbstractLinkInlineNode;
 use phpDocumentor\Guides\Nodes\Inline\DocReferenceNode;
+use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
 use phpDocumentor\Guides\RestructuredText\Parser\Interlink\InterlinkParser;
 
 /**
@@ -51,6 +52,6 @@ protected function createNode(string $referenceTarget, string|null $referenceNam
     {
         $interlinkData = $this->interlinkParser->extractInterlink($referenceTarget);
 
-        return new DocReferenceNode($interlinkData->reference, $referenceName ?? '', $interlinkData->interlink);
+        return new DocReferenceNode($interlinkData->reference, $referenceName ? [new PlainTextInlineNode($referenceName)] : [], $interlinkData->interlink);
     }
 }
diff --git a/...ages/guides-restructured-text/src/RestructuredText/TextRoles/GenericReferenceTextRole.php b/...ages/guides-restructured-text/src/RestructuredText/TextRoles/GenericReferenceTextRole.php
@@ -14,6 +14,7 @@
 namespace phpDocumentor\Guides\RestructuredText\TextRoles;
 
 use phpDocumentor\Guides\Nodes\Inline\AbstractLinkInlineNode;
+use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
 use phpDocumentor\Guides\Nodes\Inline\ReferenceNode;
 use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
 use phpDocumentor\Guides\RestructuredText\Parser\Interlink\InterlinkParser;
@@ -48,6 +49,12 @@ protected function createNode(string $referenceTarget, string|null $referenceNam
         $reference = $this->anchorReducer->reduceAnchor($interlinkData->reference);
         $prefix = $this->genericLinkProvider->getLinkPrefix($role);
 
-        return new ReferenceNode($reference, $referenceName ?? '', $interlinkData->interlink, $linkType, $prefix);
+        return new ReferenceNode(
+            $reference,
+            $referenceName ? [new PlainTextInlineNode($referenceName)] : [],
+            $interlinkData->interlink,
+            $linkType,
+            $prefix
+        );
     }
 }
diff --git a/packages/guides-restructured-text/src/RestructuredText/TextRoles/ReferenceTextRole.php b/packages/guides-restructured-text/src/RestructuredText/TextRoles/ReferenceTextRole.php
@@ -14,6 +14,7 @@
 namespace phpDocumentor\Guides\RestructuredText\TextRoles;
 
 use phpDocumentor\Guides\Nodes\Inline\AbstractLinkInlineNode;
+use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
 use phpDocumentor\Guides\Nodes\Inline\ReferenceNode;
 
 final class ReferenceTextRole extends AbstractReferenceTextRole
@@ -34,6 +35,6 @@ public function getAliases(): array
     /** @return ReferenceNode */
     protected function createNode(string $referenceTarget, string|null $referenceName, string $role): AbstractLinkInlineNode
     {
-        return new ReferenceNode($referenceTarget, $referenceName ?? '');
+        return new ReferenceNode($referenceTarget, $referenceName ? [new PlainTextInlineNode($referenceName)] : []);
     }
 }
diff --git a/packages/guides-theme-rst/resources/template/rst/inline/emphasis.rst.twig b/packages/guides-theme-rst/resources/template/rst/inline/emphasis.rst.twig
@@ -1 +1 @@
-*{{- node.value|raw -}}*
+*{{- node|plaintext -}}*
diff --git a/packages/guides-theme-rst/resources/template/rst/inline/link.rst.twig b/packages/guides-theme-rst/resources/template/rst/inline/link.rst.twig
@@ -1,7 +1,7 @@
 {%- if node.url -%}
-    `{{ node.value|raw }} <{{- node.url -}}>`__
+    `{{ node|plaintext }} <{{- node.url -}}>`__
 {%- elseif node.targetReference -%}
-    :doc:`{{ node.value|raw }} <{{- node.targetReference -}}>`
+    :doc:`{{ node|plaintext }} <{{- node.targetReference -}}>`
 {%- else -%}
-    {{- node.value -}}
+    {{- node|plaintext -}}
 {%- endif -%}
diff --git a/packages/guides-theme-rst/resources/template/rst/inline/strong.rst.twig b/packages/guides-theme-rst/resources/template/rst/inline/strong.rst.twig
@@ -1 +1 @@
-**{{- node.value|raw -}}**
+**{{- node|plaintext -}}**
diff --git a/packages/guides-theme-rst/src/RstTheme/Twig/RstExtension.php b/packages/guides-theme-rst/src/RstTheme/Twig/RstExtension.php
@@ -14,6 +14,8 @@
 namespace phpDocumentor\Guides\RstTheme\Twig;
 
 use phpDocumentor\Guides\NodeRenderers\NodeRenderer;
+use phpDocumentor\Guides\Nodes\Inline\InlineNodeInterface;
+use phpDocumentor\Guides\Nodes\InlineCompoundNode;
 use phpDocumentor\Guides\Nodes\Table\TableColumn;
 use phpDocumentor\Guides\Nodes\Table\TableRow;
 use phpDocumentor\Guides\Nodes\TableNode;
@@ -57,14 +59,24 @@ public function getFunctions(): array
     public function getFilters(): array
     {
         return [
-            new TwigFilter('clean_content', [$this, 'cleanContent']),
+            new TwigFilter('clean_content', $this->cleanContent(...)),
+            new TwigFilter('plaintext', $this->plaintext(...)),
         ];
     }
 
+    public function plaintext(InlineNodeInterface $node): string
+    {
+        if ($node instanceof InlineCompoundNode) {
+            return implode('', array_map($this->plaintext(...), $node->getChildren()));
+        }
+
+        return $node->toString();
+    }
+
     public function cleanContent(string $content): string
     {
         $lines = explode("\n", $content);
-        $lines = array_map('rtrim', $lines);
+        $lines = array_map(rtrim(...), $lines);
         $content = implode("\n", $lines);
 
         $content = preg_replace('/(\n){2,}/', "\n\n", $content);

diff --git a/packages/guides/src/Nodes/Inline/AbstractLinkInlineNode.php b/packages/guides/src/Nodes/Inline/AbstractLinkInlineNode.php
@@ -74,7 +74,7 @@ public function getDebugInformation(): array
         return [
             'type' => $this->getType(),
             'targetReference' => $this->getTargetReference(),
-            'value' => $this->getValue(),
+            'value' => $this->toString(),
         ];
     }
 

diff --git a/packages/guides/src/ReferenceResolvers/AnchorHyperlinkResolver.php b/packages/guides/src/ReferenceResolvers/AnchorHyperlinkResolver.php
@@ -15,10 +15,13 @@
 
 use phpDocumentor\Guides\Nodes\Inline\HyperLinkNode;
 use phpDocumentor\Guides\Nodes\Inline\LinkInlineNode;
+use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
 use phpDocumentor\Guides\Nodes\SectionNode;
 use phpDocumentor\Guides\RenderContext;
 use phpDocumentor\Guides\Renderer\UrlGenerator\UrlGeneratorInterface;
 
+use function count;
+
 /**
  * Resolves references with an anchor URL.
  *
@@ -51,8 +54,8 @@ public function resolve(LinkInlineNode $node, RenderContext $renderContext, Mess
         }
 
         $node->setUrl($this->urlGenerator->generateCanonicalOutputUrl($renderContext, $target->getDocumentPath(), $target->getAnchor()));
-        if ($node->getValue() === '') {
-            $node->setValue($target->getTitle() ?? '');
+        if (count($node->getChildren()) === 0) {
+            $node->addChildNode(new PlainTextInlineNode($target->getTitle() ?? ''));
         }
 
         return true;

diff --git a/packages/guides/src/ReferenceResolvers/AnchorReferenceResolver.php b/packages/guides/src/ReferenceResolvers/AnchorReferenceResolver.php
@@ -14,10 +14,13 @@
 namespace phpDocumentor\Guides\ReferenceResolvers;
 
 use phpDocumentor\Guides\Nodes\Inline\LinkInlineNode;
+use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
 use phpDocumentor\Guides\Nodes\Inline\ReferenceNode;
 use phpDocumentor\Guides\RenderContext;
 use phpDocumentor\Guides\Renderer\UrlGenerator\UrlGeneratorInterface;
 
+use function count;
+
 /**
  * Resolves references with an anchor URL.
  *
@@ -47,8 +50,8 @@ public function resolve(LinkInlineNode $node, RenderContext $renderContext, Mess
         }
 
         $node->setUrl($this->urlGenerator->generateCanonicalOutputUrl($renderContext, $target->getDocumentPath(), $target->getPrefix() . $target->getAnchor()));
-        if ($node->getValue() === '') {
-            $node->setValue($target->getTitle() ?? '');
+        if (count($node->getChildren()) === 0) {
+            $node->addChildNode(new PlainTextInlineNode($target->getTitle() ?? ''));
         }
 
         return true;

diff --git a/packages/guides/src/ReferenceResolvers/DocReferenceResolver.php b/packages/guides/src/ReferenceResolvers/DocReferenceResolver.php
@@ -15,9 +15,11 @@
 
 use phpDocumentor\Guides\Nodes\Inline\DocReferenceNode;
 use phpDocumentor\Guides\Nodes\Inline\LinkInlineNode;
+use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
 use phpDocumentor\Guides\RenderContext;
 use phpDocumentor\Guides\Renderer\UrlGenerator\UrlGeneratorInterface;
 
+use function count;
 use function explode;
 use function sprintf;
 use function str_contains;
@@ -64,8 +66,8 @@ public function resolve(LinkInlineNode $node, RenderContext $renderContext, Mess
         }
 
         $node->setUrl($this->urlGenerator->generateCanonicalOutputUrl($renderContext, $document->getFile()) . $anchor);
-        if ($node->getValue() === '') {
-            $node->setValue($document->getTitle()->toString());
+        if (count($node->getChildren()) === 0) {
+            $node->addChildNode(new PlainTextInlineNode($document->getTitle()->toString()));
         }
 
         return true;

diff --git a/packages/guides/src/ReferenceResolvers/InterlinkReferenceResolver.php b/packages/guides/src/ReferenceResolvers/InterlinkReferenceResolver.php
@@ -15,9 +15,12 @@
 
 use phpDocumentor\Guides\Nodes\Inline\CrossReferenceNode;
 use phpDocumentor\Guides\Nodes\Inline\LinkInlineNode;
+use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
 use phpDocumentor\Guides\ReferenceResolvers\Interlink\InventoryRepository;
 use phpDocumentor\Guides\RenderContext;
 
+use function count;
+
 final class InterlinkReferenceResolver implements ReferenceResolver
 {
     public final const PRIORITY = 50;
@@ -44,8 +47,8 @@ public function resolve(LinkInlineNode $node, RenderContext $renderContext, Mess
         }
 
         $node->setUrl($inventory->getBaseUrl() . $link->getPath());
-        if ($node->getValue() === '') {
-            $node->setValue($link->getTitle());
+        if (count($node->getChildren()) === 0) {
+            $node->addChildNode(new PlainTextInlineNode($link->getTitle()));
         }
 
         return true;
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{{- node.value\|raw -}}
		{{- node\|plaintext -}}