Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TASK] Split Anchor link resolvers #719

Merged
merged 1 commit into from
Nov 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/guides/resources/config/guides.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
use phpDocumentor\Guides\NodeRenderers\Html\TableNodeRenderer;
use phpDocumentor\Guides\NodeRenderers\OutputAwareDelegatingNodeRenderer;
use phpDocumentor\Guides\Parser;
use phpDocumentor\Guides\ReferenceResolvers\AnchorHyperlinkResolver;
use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;
use phpDocumentor\Guides\ReferenceResolvers\AnchorReferenceResolver;
use phpDocumentor\Guides\ReferenceResolvers\DelegatingReferenceResolver;
Expand Down Expand Up @@ -121,6 +122,8 @@

->set(EmailReferenceResolver::class)

->set(AnchorHyperlinkResolver::class)

->set(AnchorReferenceResolver::class)

->set(InternalReferenceResolver::class)
Expand Down
52 changes: 52 additions & 0 deletions packages/guides/src/ReferenceResolvers/AnchorHyperlinkResolver.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?php

declare(strict_types=1);

namespace phpDocumentor\Guides\ReferenceResolvers;

use phpDocumentor\Guides\Nodes\Inline\HyperLinkNode;
use phpDocumentor\Guides\Nodes\Inline\LinkInlineNode;
use phpDocumentor\Guides\RenderContext;
use phpDocumentor\Guides\Renderer\UrlGenerator\UrlGeneratorInterface;

/**
* Resolves references with an anchor URL.
*
* A link is an anchor if it starts with a hashtag
*/
class AnchorHyperlinkResolver implements ReferenceResolver
{
public final const PRIORITY = -100;

public function __construct(
private readonly AnchorReducer $anchorReducer,
private readonly UrlGeneratorInterface $urlGenerator,
) {
}

public function resolve(LinkInlineNode $node, RenderContext $renderContext): bool
{
if (!$node instanceof HyperLinkNode) {
return false;
}

$reducedAnchor = $this->anchorReducer->reduceAnchor($node->getTargetReference());
$target = $renderContext->getProjectNode()->getInternalTarget($reducedAnchor);

if ($target === null) {
return false;
}

$node->setUrl($this->urlGenerator->generateCanonicalOutputUrl($renderContext, $target->getDocumentPath(), $target->getAnchor()));
if ($node->getValue() === '') {
$node->setValue($target->getTitle() ?? '');
}

return true;
}

public static function getPriority(): int
{
return self::PRIORITY;
}
}
16 changes: 6 additions & 10 deletions packages/guides/src/ReferenceResolvers/AnchorReferenceResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,14 @@ public function __construct(

public function resolve(LinkInlineNode $node, RenderContext $renderContext): bool
{
$reducedAnchor = $this->anchorReducer->reduceAnchor($node->getTargetReference());
if ($node instanceof ReferenceNode) {
if ($node->getInterlinkDomain() !== '') {
return false;
}

$target = $renderContext->getProjectNode()->getInternalTarget($reducedAnchor, $node->getLinkType());
} else {
// Todo: move this to a separate resolver?
$target = $renderContext->getProjectNode()->getInternalTarget($reducedAnchor);
if (!$node instanceof ReferenceNode) {
return false;
}

$reducedAnchor = $this->anchorReducer->reduceAnchor($node->getTargetReference());

$target = $renderContext->getProjectNode()->getInternalTarget($reducedAnchor, $node->getLinkType());

if ($target === null) {
return false;
}
Expand Down