Skip to content

Commit b1a365a

Browse files
jaapiojaapio
authored
Merge pull request #1212 from phpDocumentor/inline-content-deprecation
Inline content deprecation
2 parents 98d5455 + c79ee0c commit b1a365a

File tree

46 files changed

+358
-153
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+358
-153
lines changed

‎packages/guides-graphs/resources/template/html/body/uml.html.twig‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
{% apply spaceless %}
2-
<figure
3-
class="uml-diagram{% if node.classesString %} {{ node.classesString }}{% endif %}"
4-
{% if node.hasOption('width') %}style="width: {{ node.option('width') }}"{% endif %}
5-
>
6-
{{ uml(node.value) }}
7-
{% if node.caption %}<figcaption>{{ node.caption }}</figcaption>{% endif %}
8-
</figure>
9-
{% endapply %}
1+
<figure class="uml-diagram{% if node.classesString %} {{ node.classesString }}{% endif %}"
2+
{%- if node.hasOption('width') %} style="width: {{ node.option('width') }}"{% endif -%}
3+
>
4+
{{ uml(node.value) }}
5+
{% if node.caption %}
6+
<figcaption>{{ node.caption }}</figcaption>
7+
{% endif %}
8+
</figure>

‎packages/guides-markdown/src/Markdown/Parsers/InlineParsers/EmphasisParser.php‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
use phpDocumentor\Guides\Nodes\Inline\EmphasisInlineNode;
1919
use phpDocumentor\Guides\Nodes\Inline\InlineNode;
2020
use phpDocumentor\Guides\Nodes\Inline\InlineNodeInterface;
21+
use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
2122
use Psr\Log\LoggerInterface;
2223

2324
/** @extends AbstractInlineTextDecoratorParser<EmphasisInlineNode> */
@@ -39,7 +40,7 @@ protected function getType(): string
3940
/** @param InlineNodeInterface[] $children */
4041
protected function createInlineNode(CommonMarkNode $commonMarkNode, string|null $content, array $children = []): InlineNodeInterface
4142
{
42-
return new EmphasisInlineNode($content ?? '', $children);
43+
return new EmphasisInlineNode($content ? [new PlainTextInlineNode($content)] : $children);
4344
}
4445

4546
protected function supportsCommonMarkNode(CommonMarkNode $commonMarkNode): bool

‎packages/guides-markdown/src/Markdown/Parsers/InlineParsers/LinkParser.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
use phpDocumentor\Guides\Nodes\Inline\HyperLinkNode;
1919
use phpDocumentor\Guides\Nodes\Inline\InlineNode;
2020
use phpDocumentor\Guides\Nodes\Inline\InlineNodeInterface;
21+
use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
2122
use Psr\Log\LoggerInterface;
2223

2324
use function assert;
@@ -48,13 +49,12 @@ protected function createInlineNode(CommonMarkNode $commonMarkNode, string|null
4849
{
4950
assert($commonMarkNode instanceof Link);
5051

51-
$content ??= $commonMarkNode->getUrl();
5252
$url = $commonMarkNode->getUrl();
5353
if (str_ends_with($url, '.md') && filter_var($url, FILTER_VALIDATE_URL) === false) {
5454
$url = substr($url, 0, -3);
5555
}
5656

57-
return new HyperLinkNode($content, $url, $children);
57+
return new HyperLinkNode($content ? [new PlainTextInlineNode($content)] : $children, $url);
5858
}
5959

6060
protected function supportsCommonMarkNode(CommonMarkNode $commonMarkNode): bool

‎packages/guides-markdown/src/Markdown/Parsers/InlineParsers/StrongParser.php‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
use League\CommonMark\Node\Node as CommonMarkNode;
1818
use phpDocumentor\Guides\Nodes\Inline\InlineNode;
1919
use phpDocumentor\Guides\Nodes\Inline\InlineNodeInterface;
20+
use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
2021
use phpDocumentor\Guides\Nodes\Inline\StrongInlineNode;
2122
use Psr\Log\LoggerInterface;
2223

@@ -39,7 +40,7 @@ protected function getType(): string
3940
/** @param InlineNodeInterface[] $children */
4041
protected function createInlineNode(CommonMarkNode $commonMarkNode, string|null $content, array $children = []): InlineNodeInterface
4142
{
42-
return new StrongInlineNode($content ?? '', $children);
43+
return new StrongInlineNode($content ? [new PlainTextInlineNode($content)] : $children);
4344
}
4445

4546
protected function supportsCommonMarkNode(CommonMarkNode $commonMarkNode): bool

‎packages/guides-restructured-text/src/RestructuredText/Directives/ImageDirective.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,21 +77,21 @@ public function processNode(
7777
private function resolveLinkTarget(string $targetReference): LinkInlineNode
7878
{
7979
if (filter_var($targetReference, FILTER_VALIDATE_EMAIL)) {
80-
return new HyperLinkNode('', $targetReference);
80+
return new HyperLinkNode([], $targetReference);
8181
}
8282

8383
if (filter_var($targetReference, FILTER_VALIDATE_URL)) {
84-
return new HyperLinkNode('', $targetReference);
84+
return new HyperLinkNode([], $targetReference);
8585
}
8686

8787
if (preg_match(self::REFERENCE_REGEX, $targetReference, $matches)) {
88-
return new ReferenceNode($matches[1], '');
88+
return new ReferenceNode($matches[1]);
8989
}
9090

9191
if (preg_match(self::REFERENCE_ESCAPED_REGEX, $targetReference, $matches)) {
92-
return new ReferenceNode($matches[1], '');
92+
return new ReferenceNode($matches[1]);
9393
}
9494

95-
return new DocReferenceNode($targetReference, '');
95+
return new DocReferenceNode($targetReference);
9696
}
9797
}

‎packages/guides-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/EmphasisRule.php‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
use phpDocumentor\Guides\Nodes\Inline\EmphasisInlineNode;
1717
use phpDocumentor\Guides\Nodes\Inline\InlineNodeInterface;
18+
use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
1819
use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
1920
use phpDocumentor\Guides\RestructuredText\Parser\InlineLexer;
2021

@@ -45,7 +46,7 @@ public function apply(BlockContext $blockContext, InlineLexer $lexer): InlineNod
4546

4647
$lexer->moveNext();
4748

48-
return new EmphasisInlineNode($text);
49+
return new EmphasisInlineNode([new PlainTextInlineNode($text)]);
4950

5051
default:
5152
$text .= $token->value;

‎packages/guides-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/ReferenceRule.php‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
use phpDocumentor\Guides\Nodes\Inline\AbstractLinkInlineNode;
1717
use phpDocumentor\Guides\Nodes\Inline\DocReferenceNode;
1818
use phpDocumentor\Guides\Nodes\Inline\HyperLinkNode;
19+
use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
1920
use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
2021

2122
use function filter_var;
@@ -39,13 +40,17 @@ protected function createReference(BlockContext $blockContext, string $reference
3940
if (str_ends_with($reference, '.rst') && filter_var($reference, FILTER_VALIDATE_URL) === false) {
4041
$reference = substr($reference, 0, -4);
4142

42-
return new DocReferenceNode($reference, $text ?? $reference);
43+
$text ??= $reference;
44+
45+
return new DocReferenceNode($reference, $text !== '' ? [new PlainTextInlineNode($text)] : []);
4346
}
4447

4548
if ($registerLink && $text !== null) {
4649
$blockContext->getDocumentParserContext()->setLink($text, $reference);
4750
}
4851

49-
return new HyperLinkNode($text ?? $reference, $reference);
52+
$text ??= $reference;
53+
54+
return new HyperLinkNode($text !== '' ? [new PlainTextInlineNode($text)] : [], $reference);
5055
}
5156
}

‎packages/guides-restructured-text/src/RestructuredText/Parser/Productions/InlineRules/StrongRule.php‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
namespace phpDocumentor\Guides\RestructuredText\Parser\Productions\InlineRules;
1515

1616
use phpDocumentor\Guides\Nodes\Inline\InlineNodeInterface;
17+
use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
1718
use phpDocumentor\Guides\Nodes\Inline\StrongInlineNode;
1819
use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
1920
use phpDocumentor\Guides\RestructuredText\Parser\InlineLexer;
@@ -45,7 +46,7 @@ public function apply(BlockContext $blockContext, InlineLexer $lexer): InlineNod
4546

4647
$lexer->moveNext();
4748

48-
return new StrongInlineNode($text);
49+
return new StrongInlineNode([new PlainTextInlineNode($text)]);
4950

5051
default:
5152
$text .= $token->value;

‎packages/guides-restructured-text/src/RestructuredText/TextRoles/ApiClassTextRole.php‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
namespace phpDocumentor\Guides\RestructuredText\TextRoles;
1515

1616
use phpDocumentor\Guides\Nodes\Inline\AbstractLinkInlineNode;
17+
use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
1718
use phpDocumentor\Guides\Nodes\Inline\ReferenceNode;
1819
use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
1920
use phpDocumentor\Guides\RestructuredText\Parser\Interlink\InterlinkParser;
@@ -49,6 +50,6 @@ protected function createNode(string $referenceTarget, string|null $referenceNam
4950
$reference = $this->anchorReducer->reduceAnchor($interlinkData->reference);
5051
$prefix = $this->genericLinkProvider->getLinkPrefix($role);
5152

52-
return new ReferenceNode($reference, $referenceName ?? '', $interlinkData->interlink, self::TYPE, $prefix);
53+
return new ReferenceNode($reference, $referenceName ? [new PlainTextInlineNode($referenceName)] : [], $interlinkData->interlink, self::TYPE, $prefix);
5354
}
5455
}

‎packages/guides-restructured-text/src/RestructuredText/TextRoles/DocReferenceTextRole.php‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
use phpDocumentor\Guides\Nodes\Inline\AbstractLinkInlineNode;
1717
use phpDocumentor\Guides\Nodes\Inline\DocReferenceNode;
18+
use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
1819
use phpDocumentor\Guides\RestructuredText\Parser\Interlink\InterlinkParser;
1920

2021
/**
@@ -51,6 +52,6 @@ protected function createNode(string $referenceTarget, string|null $referenceNam
5152
{
5253
$interlinkData = $this->interlinkParser->extractInterlink($referenceTarget);
5354

54-
return new DocReferenceNode($interlinkData->reference, $referenceName ?? '', $interlinkData->interlink);
55+
return new DocReferenceNode($interlinkData->reference, $referenceName ? [new PlainTextInlineNode($referenceName)] : [], $interlinkData->interlink);
5556
}
5657
}

0 commit comments

Comments
 (0)