Skip to content

feat(PageContent): set unique ids on nested headers #3069

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.

Sign up for GitHub

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

Merged
ssddanbrown merged 1 commit into from
Nov 22, 2021
Merged

feat(PageContent): set unique ids on nested headers #3069

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions app/Entities/Tools/PageContent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,15 @@ protected function formatHtml(string $htmlText): string
}
}

// Set ids on nested header nodes
$nestedHeaders = $xPath->query('//body//*//h1|//body//*//h2|//body//*//h3|//body//*//h4|//body//*//h5|//body//*//h6');
foreach ($nestedHeaders as $nestedHeader) {
[$oldId, $newId] = $this->setUniqueId($nestedHeader, $idMap);
if ($newId && $newId !== $oldId) {
$this->updateLinks($xPath, '#' . $oldId, '#' . $newId);
}
}

// Ensure no duplicate ids within child items
$idElems = $xPath->query('//body//*//*[@id]');
foreach ($idElems as $domElem) {
Expand Down
20 changes: 20 additions & 0 deletions tests/Entity/PageContentTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -670,4 +670,24 @@ public function test_base64_images_within_markdown_blanked_if_not_supported_exte
$page->refresh();
$this->assertStringContainsString('<img src=""', $page->html);
}

public function test_nested_headers_gets_assigned_an_id()
{
$this->asEditor();
$page = Page::query()->first();

$content = '<table><tbody><tr><td><h5>Simple Test</h5></td></tr></tbody></table>';
$this->put($page->getUrl(), [
'name' => $page->name,
'html' => $content,
'summary' => '',
]);

$updatedPage = Page::query()->where('id', '=', $page->id)->first();

// The top level <table> node will get assign the bkmrk-simple-test id because the system will
// take the node value of h5
// So the h5 should get the bkmrk-simple-test-1 id
$this->assertStringContainsString('<h5 id="bkmrk-simple-test-1">Simple Test</h5>', $updatedPage->html);
}
}