[4.1] [RFC] Use schema.org for metadata #25117
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,9 +11,11 @@ | |
|
|
||
| defined('_JEXEC') or die; | ||
|
|
||
| use Joomla\CMS\Application\CMSApplicationInterface; | ||
| use Joomla\CMS\Categories\Categories; | ||
| use Joomla\CMS\Factory; | ||
| use Joomla\CMS\Helper\TagsHelper; | ||
| use Joomla\CMS\HTML\HTMLHelper; | ||
| use Joomla\CMS\Language\Associations; | ||
| use Joomla\CMS\Language\Text; | ||
| use Joomla\CMS\Layout\FileLayout; | ||
|
|
@@ -23,6 +25,9 @@ | |
| use Joomla\CMS\Router\Route; | ||
| use Joomla\CMS\Uri\Uri; | ||
| use Joomla\Component\Content\Site\Helper\AssociationHelper; | ||
| use Spatie\SchemaOrg\Article; | ||
| use Spatie\SchemaOrg\Person; | ||
| use Spatie\SchemaOrg\Schema; | ||
|
|
||
| /** | ||
| * HTML Article View class for the Content component | ||
|
|
@@ -80,13 +85,16 @@ class HtmlView extends BaseHtmlView | |
| * | ||
| * @param string $tpl The name of the template file to parse; automatically searches through the template paths. | ||
| * | ||
| * @return void | ||
| * @throws \Exception | ||
| */ | ||
| public function display($tpl = null) | ||
| { | ||
| if ($this->getLayout() == 'pagebreak') | ||
| { | ||
| parent::display($tpl); | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| $app = Factory::getApplication(); | ||
|
|
@@ -255,6 +263,7 @@ public function display($tpl = null) | |
| $this->pageclass_sfx = htmlspecialchars($this->item->params->get('pageclass_sfx')); | ||
|
|
||
| $this->_prepareDocument(); | ||
| $this->addJsonSchema($app); | ||
|
|
||
| parent::display($tpl); | ||
| } | ||
|
|
@@ -387,4 +396,61 @@ protected function _prepareDocument() | |
| $this->document->setMetaData('robots', 'noindex, nofollow'); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Prepares the document. | ||
| * | ||
| * @param CMSApplicationInterface $app The application object | ||
| * | ||
This comment was marked as abuse.
Sorry, something went wrong. |
||
| * @return void | ||
| */ | ||
| private function addJsonSchema($app) | ||
| { | ||
| $images = json_decode($this->item->images); | ||
| $articleLanguage = ($this->item->language === '*') ? $app->get('language') : $this->item->language; | ||
| $authorised = $app->getIdentity()->getAuthorisedViewLevels(); | ||
| $keywords = []; | ||
|
|
||
| foreach ($this->item->tags->itemTags as $tag) | ||
| { | ||
| if (in_array($tag->access, $authorised)) { | ||
| $keywords[] = $this->escape($tag->title); | ||
| } | ||
| } | ||
|
|
||
| // TODO: This requires a publisher to pass google structured data checker | ||
|
There was a problem hiding this comment. Looks like it needs an image as well although the error messages are conflicting
There was a problem hiding this comment. Yeah I saw that - but I'm not sure the best way of achieving this as its mandated for the image to be above 700px width - which clearly may not be the case in an article :/ |
||
| $schema = Schema::article() | ||
| ->articleBody($this->item->text) | ||
|
There was a problem hiding this comment. Duplicating the entire article text into JSON? There was a problem hiding this comment. yup. that's apparently how it should be There was a problem hiding this comment. Are you sure about that @wilsonge ? I am looking at some pages from the site of another cms that dont There was a problem hiding this comment. If true, I stand by my deleted comment - this is probably unsuitable for content. How does one insert this into article and tie it up to specific pieces of content? With Microdata it's simple by using editor button that inserts the tags around selected content. There was a problem hiding this comment.
There was a problem hiding this comment. That looks counter-productive to me. Would not want to bloat up the page like this. How about the other question? Microdata is not just for automatically generated content. It can be used inside actual content, e.g. inside articles. |
||
| ->if($this->item->params->get('show_title'), function (Article $schema) { | ||
| $schema->headline($this->escape($this->item->title)); | ||
| }) | ||
| ->inLanguage($articleLanguage) | ||
| ->dateCreated(HTMLHelper::_('date', $this->item->created, "Y-m-d")) | ||
| ->dateModified(HTMLHelper::_('date', $this->item->modified, "Y-m-d")) | ||
| ->datePublished(HTMLHelper::_('date', $this->item->publish_up, "Y-m-d")) | ||
| ->if($this->item->params->get('show_author') === '1' && !empty($this->item->author), function (Article $schema) { | ||
| $schema->author( | ||
| Schema::Person() | ||
| ->name($this->item->created_by_alias ?: $this->item->author) | ||
| ->if($this->item->params->get('link_author'), function(Person $schema) { | ||
| $schema->url($this->item->contact_link); | ||
| }) | ||
| ); | ||
| }); | ||
|
|
||
| if (!empty($keywords)) | ||
| { | ||
| $schema->keywords($keywords); | ||
| } | ||
|
|
||
| if (!empty($images->image_fulltext)) | ||
| { | ||
| $schema->image( | ||
| Schema::imageObject() | ||
| ->url($images->image_fulltext) | ||
| ); | ||
| } | ||
|
|
||
| $this->document->addScriptDeclaration(json_encode($schema, JDEBUG ? JSON_PRETTY_PRINT : 0), 'application/ld+json'); | ||
| } | ||
| } | ||
This comment was marked as abuse.
Sorry, something went wrong.