first commit
This commit is contained in:
43
plugins/schemaorg/book/book.xml
Executable file
43
plugins/schemaorg/book/book.xml
Executable file
@ -0,0 +1,43 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<extension type="plugin" group="schemaorg" method="upgrade">
|
||||
<name>plg_schemaorg_book</name>
|
||||
<author>Joomla! Project</author>
|
||||
<creationDate>2023-07</creationDate>
|
||||
<copyright>(C) 2023 Open Source Matters, Inc.</copyright>
|
||||
<license>GNU General Public License version 2 or later; see LICENSE.txt</license>
|
||||
<authorEmail>admin@joomla.org</authorEmail>
|
||||
<authorUrl>www.joomla.org</authorUrl>
|
||||
<version>5.0.0</version>
|
||||
<description>PLG_SCHEMAORG_BOOK_XML_DESCRIPTION</description>
|
||||
<namespace path="src">Joomla\Plugin\Schemaorg\Book</namespace>
|
||||
<files>
|
||||
<folder plugin="book">services</folder>
|
||||
<folder>src</folder>
|
||||
</files>
|
||||
<languages>
|
||||
<language tag="en-GB">language/en-GB/plg_schemaorg_book.ini</language>
|
||||
<language tag="en-GB">language/en-GB/plg_schemaorg_book.sys.ini</language>
|
||||
</languages>
|
||||
<config>
|
||||
<fields name="params">
|
||||
<fieldset name="basic">
|
||||
<field
|
||||
name="allowedlist"
|
||||
type="SchemaorgComponentSections"
|
||||
label="JSCHEMAORG_EXTENSION_ALLOWED_LABEL"
|
||||
description="JSCHEMAORG_EXTENSION_ALLOWED_DESCRIPTION"
|
||||
multiple="multiple"
|
||||
layout="joomla.form.field.list-fancy-select"
|
||||
/>
|
||||
<field
|
||||
name="forbiddenlist"
|
||||
type="SchemaorgComponentSections"
|
||||
label="JSCHEMAORG_EXTENSION_FORBIDDEN_LABEL"
|
||||
description="JSCHEMAORG_EXTENSION_FORBIDDEN_DESCRIPTION"
|
||||
multiple="multiple"
|
||||
layout="joomla.form.field.list-fancy-select"
|
||||
/>
|
||||
</fieldset>
|
||||
</fields>
|
||||
</config>
|
||||
</extension>
|
||||
205
plugins/schemaorg/book/forms/schemaorg.xml
Executable file
205
plugins/schemaorg/book/forms/schemaorg.xml
Executable file
@ -0,0 +1,205 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<form>
|
||||
<fields name="schema">
|
||||
<fieldset
|
||||
name="schema"
|
||||
label="PLG_SYSTEM_SCHEMA_FIELD_SCHEMA_LABEL"
|
||||
>
|
||||
<field
|
||||
name="Book"
|
||||
type="subform"
|
||||
showon="schemaType:Book"
|
||||
>
|
||||
<form>
|
||||
|
||||
<field
|
||||
name="@type"
|
||||
type="hidden"
|
||||
default="Book"
|
||||
/>
|
||||
|
||||
<field
|
||||
name="noteBook"
|
||||
type="note"
|
||||
description="PLG_SCHEMAORG_BOOK_DESCRIPTION_LABEL"
|
||||
class="alert alert-info w-100"
|
||||
/>
|
||||
|
||||
<field
|
||||
name="name"
|
||||
type="text"
|
||||
label="PLG_SCHEMAORG_BOOK_FIELD_NAME_LABEL"
|
||||
filter="string"
|
||||
size="30"
|
||||
/>
|
||||
|
||||
<field
|
||||
name="author"
|
||||
type="text"
|
||||
label="PLG_SCHEMAORG_BOOK_FIELD_AUTHOR_LABEL"
|
||||
filter="string"
|
||||
size="30"
|
||||
/>
|
||||
|
||||
<field
|
||||
name="datePublished"
|
||||
type="calendar"
|
||||
label="PLG_SCHEMAORG_BOOK_FIELD_DATE_PUBLISHED_LABEL"
|
||||
class="input-small"
|
||||
filter="user_utc"
|
||||
showtime="false"
|
||||
todaybutton="true"
|
||||
translateformat="true"
|
||||
/>
|
||||
|
||||
<field
|
||||
name="abridged"
|
||||
type="list"
|
||||
label="PLG_SCHEMAORG_BOOK_FIELD_ABRIDGED_LABEL"
|
||||
default="0"
|
||||
>
|
||||
<option>JNONE</option>
|
||||
<option value="true">JYES</option>
|
||||
<option value="false">JNO</option>
|
||||
</field>
|
||||
|
||||
<field
|
||||
name="bookEdition"
|
||||
type="text"
|
||||
label="PLG_SCHEMAORG_BOOK_FIELD_BOOK_EDITION_LABEL"
|
||||
filter="string"
|
||||
size="30"
|
||||
/>
|
||||
|
||||
<field
|
||||
name="bookFormat"
|
||||
type="list"
|
||||
label="PLG_SCHEMAORG_BOOK_FIELD_BOOK_FORMAT_LABEL"
|
||||
default="0"
|
||||
>
|
||||
<option>JNONE</option>
|
||||
<option value="AudiobookFormat">PLG_SCHEMAORG_BOOK_FIELD_AUDIOBOOK_LABEL</option>
|
||||
<option value="EBook">PLG_SCHEMAORG_BOOK_FIELD_E_BOOK_LABEL</option>
|
||||
<option value="GraphicNovel">PLG_SCHEMAORG_BOOK_FIELD_GRAPHIC_NOVEL</option>
|
||||
<option value="Hardcover">PLG_SCHEMAORG_BOOK_FIELD_HARDCOVER_LABEL</option>
|
||||
<option value="Paperback">PLG_SCHEMAORG_BOOK_FIELD_PAPERBACK_LABEL</option>
|
||||
</field>
|
||||
|
||||
<field
|
||||
name="illustrator"
|
||||
type="subform"
|
||||
label="PLG_SCHEMAORG_BOOK_FIELD_ILLUSTRATOR_LABEL"
|
||||
>
|
||||
<form>
|
||||
|
||||
<field
|
||||
name="@type"
|
||||
type="hidden"
|
||||
default="Person"
|
||||
/>
|
||||
|
||||
<field
|
||||
name="name"
|
||||
type="text"
|
||||
label="PLG_SCHEMAORG_BOOK_FIELD_ILLUSTRATOR_NAME_LABEL"
|
||||
filter="string"
|
||||
/>
|
||||
|
||||
<field
|
||||
name="url"
|
||||
type="url"
|
||||
label="PLG_SCHEMAORG_BOOK_FIELD_URL_LABEL"
|
||||
filter="url"
|
||||
validate="url"
|
||||
/>
|
||||
|
||||
<field
|
||||
name="email"
|
||||
type="email"
|
||||
label="PLG_SCHEMAORG_BOOK_FIELD_EMAIL_LABEL"
|
||||
validate="email"
|
||||
/>
|
||||
|
||||
<field
|
||||
name="address"
|
||||
type="subform"
|
||||
label="PLG_SCHEMAORG_BOOK_FIELD_ADDRESS_LABEL"
|
||||
>
|
||||
<form>
|
||||
|
||||
<field
|
||||
name="@type"
|
||||
type="hidden"
|
||||
default="PostalAddress"
|
||||
/>
|
||||
|
||||
<field
|
||||
name="addressLocality"
|
||||
type="text"
|
||||
label="PLG_SCHEMAORG_BOOK_FIELD_LOCALITY_LABEL"
|
||||
/>
|
||||
|
||||
<field
|
||||
name="postalCode"
|
||||
type="text"
|
||||
label="PLG_SCHEMAORG_BOOK_FIELD_POSTAL_CODE_LABEL"
|
||||
/>
|
||||
|
||||
<field
|
||||
name="streetAddress"
|
||||
type="text"
|
||||
label="PLG_SCHEMAORG_BOOK_FIELD_STREET_ADDRESS_LABEL"
|
||||
/>
|
||||
|
||||
</form>
|
||||
|
||||
</field>
|
||||
|
||||
</form>
|
||||
|
||||
</field>
|
||||
|
||||
<field
|
||||
name="isbn"
|
||||
type="text"
|
||||
label="PLG_SCHEMAORG_BOOK_FIELD_ISBN_LABEL"
|
||||
filter="string"
|
||||
size="30"
|
||||
/>
|
||||
|
||||
<field
|
||||
name="numberOfPages"
|
||||
type="number"
|
||||
label="PLG_SCHEMAORG_BOOK_FIELD_NUMBER_OF_PAGES_LABEL"
|
||||
/>
|
||||
|
||||
<field
|
||||
name="genericField"
|
||||
type="subform"
|
||||
label="PLG_SCHEMAORG_BOOK_FIELD_GENERIC_FIELD_LABEL"
|
||||
multiple="true"
|
||||
>
|
||||
<form>
|
||||
<field
|
||||
name="genericTitle"
|
||||
type="text"
|
||||
label="PLG_SCHEMAORG_BOOK_FIELD_GENERIC_TITLE_LABEL"
|
||||
filter="string"
|
||||
size="30"
|
||||
/>
|
||||
<field
|
||||
name="genericValue"
|
||||
type="text"
|
||||
label="PLG_SCHEMAORG_BOOK_FIELD_GENERIC_VALUE_LABEL"
|
||||
filter="string"
|
||||
size="30"
|
||||
/>
|
||||
</form>
|
||||
|
||||
</field>
|
||||
|
||||
</form>
|
||||
</field>
|
||||
</fieldset>
|
||||
</fields>
|
||||
</form>
|
||||
49
plugins/schemaorg/book/services/provider.php
Normal file
49
plugins/schemaorg/book/services/provider.php
Normal file
@ -0,0 +1,49 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @package Joomla.Plugin
|
||||
* @subpackage Schemaorg.book
|
||||
*
|
||||
* @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
|
||||
* @license GNU General Public License version 2 or later; see LICENSE.txt
|
||||
*/
|
||||
|
||||
\defined('_JEXEC') or die;
|
||||
|
||||
use Joomla\CMS\Extension\PluginInterface;
|
||||
use Joomla\CMS\Factory;
|
||||
use Joomla\CMS\Plugin\PluginHelper;
|
||||
use Joomla\DI\Container;
|
||||
use Joomla\DI\ServiceProviderInterface;
|
||||
use Joomla\Event\DispatcherInterface;
|
||||
use Joomla\Plugin\Schemaorg\Book\Extension\Book;
|
||||
|
||||
return new class () implements ServiceProviderInterface {
|
||||
/**
|
||||
* Registers the service provider with a DI container.
|
||||
*
|
||||
* @param Container $container The DI container.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 5.0.0
|
||||
*/
|
||||
public function register(Container $container)
|
||||
{
|
||||
$container->set(
|
||||
PluginInterface::class,
|
||||
function (Container $container) {
|
||||
$dispatcher = $container->get(DispatcherInterface::class);
|
||||
|
||||
$plugin = new Book(
|
||||
$dispatcher,
|
||||
(array) PluginHelper::getPlugin('schemaorg', 'book')
|
||||
);
|
||||
|
||||
$plugin->setApplication(Factory::getApplication());
|
||||
|
||||
return $plugin;
|
||||
}
|
||||
);
|
||||
}
|
||||
};
|
||||
92
plugins/schemaorg/book/src/Extension/Book.php
Executable file
92
plugins/schemaorg/book/src/Extension/Book.php
Executable file
@ -0,0 +1,92 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @package Joomla.Plugin
|
||||
* @subpackage Schemaorg.book
|
||||
*
|
||||
* @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
|
||||
* @license GNU General Public License version 2 or later; see LICENSE.txt
|
||||
*/
|
||||
|
||||
namespace Joomla\Plugin\Schemaorg\Book\Extension;
|
||||
|
||||
use Joomla\CMS\Event\Plugin\System\Schemaorg\BeforeCompileHeadEvent;
|
||||
use Joomla\CMS\Plugin\CMSPlugin;
|
||||
use Joomla\CMS\Schemaorg\SchemaorgPluginTrait;
|
||||
use Joomla\CMS\Schemaorg\SchemaorgPrepareDateTrait;
|
||||
use Joomla\Event\Priority;
|
||||
use Joomla\Event\SubscriberInterface;
|
||||
|
||||
// phpcs:disable PSR1.Files.SideEffects
|
||||
\defined('_JEXEC') or die;
|
||||
// phpcs:enable PSR1.Files.SideEffects
|
||||
|
||||
/**
|
||||
* Schemaorg Plugin
|
||||
*
|
||||
* @since 5.0.0
|
||||
*/
|
||||
final class Book extends CMSPlugin implements SubscriberInterface
|
||||
{
|
||||
use SchemaorgPluginTrait;
|
||||
use SchemaorgPrepareDateTrait;
|
||||
|
||||
/**
|
||||
* Load the language file on instantiation.
|
||||
*
|
||||
* @var boolean
|
||||
* @since 5.0.0
|
||||
*/
|
||||
protected $autoloadLanguage = true;
|
||||
|
||||
/**
|
||||
* The name of the schema form
|
||||
*
|
||||
* @var string
|
||||
* @since 5.0.0
|
||||
*/
|
||||
protected $pluginName = 'Book';
|
||||
|
||||
/**
|
||||
* Returns an array of events this subscriber will listen to.
|
||||
*
|
||||
* @return array
|
||||
*
|
||||
* @since 5.0.0
|
||||
*/
|
||||
public static function getSubscribedEvents(): array
|
||||
{
|
||||
return [
|
||||
'onSchemaPrepareForm' => 'onSchemaPrepareForm',
|
||||
'onSchemaBeforeCompileHead' => ['onSchemaBeforeCompileHead', Priority::BELOW_NORMAL],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Cleanup all Book types
|
||||
*
|
||||
* @param BeforeCompileHeadEvent $event The given event
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 5.0.0
|
||||
*/
|
||||
public function onSchemaBeforeCompileHead(BeforeCompileHeadEvent $event): void
|
||||
{
|
||||
$schema = $event->getSchema();
|
||||
|
||||
$graph = $schema->get('@graph');
|
||||
|
||||
foreach ($graph as &$entry) {
|
||||
if (!isset($entry['@type']) || $entry['@type'] !== 'Book') {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (!empty($entry['datePublished'])) {
|
||||
$entry['datePublished'] = $this->prepareDate($entry['datePublished']);
|
||||
}
|
||||
}
|
||||
|
||||
$schema->set('@graph', $graph);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user