Skip to content

[4.1] mod_breadcrumbs - convert microdata to JSON-LD #30727

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
merged 9 commits into from
Oct 27, 2020
Merged

[4.1] mod_breadcrumbs - convert microdata to JSON-LD #30727

Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4710faf
:recycle: convert microdata to JSON-LD
hans2103 Sep 22, 2020
2fbe114
:recycle: move script to WebAssetManager
hans2103 Oct 1, 2020
46f40f7
Merge branch '4.1-dev' into feature/mod_breadcrumbs
hans2103 Oct 1, 2020
f01c729
Update modules/mod_breadcrumbs/tmpl/default.php
hans2103 Oct 1, 2020
be55d71
Update modules/mod_breadcrumbs/tmpl/default.php
hans2103 Oct 1, 2020
4a863cf
removal non used variable
hans2103 Oct 1, 2020
a2a8c9e
Update modules/mod_breadcrumbs/tmpl/default.php
hans2103 Oct 2, 2020
f38b735
replace Uri::current() with Uri::getInstance()
hans2103 Oct 2, 2020
fdf12e3
Merge branch '4.1-dev' into feature/mod_breadcrumbs
hans2103 Oct 21, 2020
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
57 changes: 42 additions & 15 deletions modules/mod_breadcrumbs/tmpl/default.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,15 @@

defined('_JEXEC') or die;

use Joomla\CMS\HTML\HTMLHelper;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Router\Route;
use Joomla\CMS\Uri\Uri;
use Joomla\CMS\WebAsset\WebAssetManager;

?>
<nav role="navigation" aria-label="<?php echo $module->title; ?>">
<ol itemscope itemtype="https://schema.org/BreadcrumbList" class="mod-breadcrumbs breadcrumb">
<ol class="mod-breadcrumbs breadcrumb">
<?php if ($params->get('showHere', 1)) : ?>
<li class="mod-breadcrumbs__here float-left">
<?php echo Text::_('MOD_BREADCRUMBS_HERE'); ?>&#160;
Expand All @@ -37,32 +40,56 @@

// Find last and penultimate items in breadcrumbs list
end($list);
$last_item_key = key($list);
$last_item_key = key($list);
prev($list);
$penult_item_key = key($list);

// Make a link if not the last item in the breadcrumbs
$show_last = $params->get('showLast', 1);

$class = null;

// Generate the trail
foreach ($list as $key => $item) :
if ($key !== $last_item_key) :
if (!empty($item->link)) :
$breadcrumbItem = '<a itemprop="item" href="' . Route::_($item->link) . '" class="pathway"><span itemprop="name">' . $item->name . '</span></a>';
$breadcrumbItem = HTMLHelper::_('link', Route::_($item->link), '<span>' . $item->name . '</span>', ['class' => 'pathway']);
else :
$breadcrumbItem = '<span itemprop="name">' . $item->name . '</span>';
$breadcrumbItem = '<span>' . $item->name . '</span>';
endif;
// Render all but last item - along with separator ?>
<li itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem" class="mod-breadcrumbs__item breadcrumb-item"><?php echo $breadcrumbItem; ?>
<meta itemprop="position" content="<?php echo $key + 1; ?>">
</li>
<?php elseif ($show_last) :
$breadcrumbItem = '<span itemprop="name">' . $item->name . '</span>';
// Render last item if required. ?>
<li aria-current="page" itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem" class="mod-breadcrumbs__item breadcrumb-item active"><?php echo $breadcrumbItem; ?>
<meta itemprop="position" content="<?php echo $key + 1; ?>">
</li>
<?php endif;

elseif ($show_last) :
// Render last item if required.
$breadcrumbItem = '<span>' . $item->name . '</span>';
$class = ' active';
endif;

echo '<li class="mod-breadcrumbs__item breadcrumb-item' . $class . '">' . $breadcrumbItem . '</li>';
endforeach; ?>
</ol>
<?php

// Structured data as JSON
$data = [
'@context' => 'https://schema.org',
'@type' => 'BreadcrumbList',
'itemListElement' => []
];

foreach ($list as $key => $item)
{
$data['itemListElement'][] = [
'@type' => 'ListItem',
'position' => $key + 1,
'item' => [
'@id' => $item->link ? Route::_(Uri::base() . ltrim($item->link, '/')) : Route::_(Uri::current()),
'name' => $item->name
]
];
}

/** @var WebAssetManager $wa */
$wa = $app->getDocument()->getWebAssetManager();
$wa->addInline('script', json_encode($data, JSON_UNESCAPED_UNICODE), [], ['type' => 'application/ld+json']);
?>
</nav>