192 lines
5.5 KiB
PHP
192 lines
5.5 KiB
PHP
<?php
|
|
namespace Grav\Plugin;
|
|
|
|
use Grav\Common\Plugin;
|
|
use Grav\Common\Page\Page;
|
|
use RocketTheme\Toolbox\Event\Event;
|
|
use Grav\Common\Utils;
|
|
use Grav\Plugin\Aura\Aura;
|
|
|
|
|
|
/**
|
|
* Class AuraPlugin
|
|
* @package Grav\Plugin
|
|
*/
|
|
class AuraPlugin extends Plugin
|
|
{
|
|
|
|
/**
|
|
* Gives the core a list of events the plugin wants to listen to
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function getSubscribedEvents()
|
|
{
|
|
return [
|
|
'onPluginsInitialized' => ['onPluginsInitialized', 0]
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Initialize the plugin
|
|
*/
|
|
public function onPluginsInitialized()
|
|
{
|
|
|
|
// Don't proceed if php ext-json is not available
|
|
if (!function_exists('json_encode')) {
|
|
return;
|
|
}
|
|
|
|
spl_autoload_register(function ($class) {
|
|
if (Utils::startsWith($class, 'Grav\Plugin\Aura\\')) {
|
|
require_once __DIR__ .'/classes/' . strtolower(basename(str_replace("\\", '/', $class))) . '.php';
|
|
}
|
|
});
|
|
|
|
// Admin only events
|
|
if ($this->isAdmin()) {
|
|
$this->enable([
|
|
'onGetPageBlueprints' => ['onGetPageBlueprints', 0],
|
|
'onAdminSave' => ['onAdminSave', 0],
|
|
]);
|
|
return;
|
|
}
|
|
|
|
// Frontend events
|
|
$this->enable([
|
|
'onPageInitialized' => ['onPageInitialized', 0]
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Extend page blueprints with additional configuration options.
|
|
*
|
|
* @param Event $event
|
|
*/
|
|
public function onGetPageBlueprints($event)
|
|
{
|
|
$types = $event->types;
|
|
$types->scanBlueprints('plugins://' . $this->name . '/blueprints');
|
|
}
|
|
|
|
public function onAdminSave(Event $event)
|
|
{
|
|
// Don't proceed if Admin is not saving a Page
|
|
if (!$event['object'] instanceof Page) {
|
|
return;
|
|
}
|
|
|
|
// Don't proceed if required params not set
|
|
$requiredParams = array(
|
|
'org-name',
|
|
'org-url',
|
|
);
|
|
foreach ($requiredParams as $param) {
|
|
$key = 'plugins.aura.' . $param;
|
|
if (!$this->grav['config']->get($key)) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
$page = $event['object'];
|
|
$aura = new Aura($page);
|
|
|
|
// Meta Description
|
|
if ($aura->webpage->description) {
|
|
// Append description to page metadata
|
|
$aura->webpage->metadata['description'] = array(
|
|
'name' => 'description',
|
|
'content' => htmlentities($aura->webpage->description),
|
|
);
|
|
}
|
|
|
|
// Open Graph
|
|
if ($this->grav['config']->get('plugins.aura.output-og')) {
|
|
$aura->generateOpenGraphMeta();
|
|
}
|
|
|
|
// Twitter
|
|
if ($this->grav['config']->get('plugins.aura.output-twitter')) {
|
|
$aura->generateTwitterMeta();
|
|
}
|
|
|
|
// LinkedIn
|
|
if ($this->grav['config']->get('plugins.aura.output-linkedin')) {
|
|
$aura->generateLinkedInMeta();
|
|
}
|
|
|
|
// Generate Aura metadata
|
|
$metadata = [];
|
|
foreach ($aura->webpage->metadata as $tag) {
|
|
if (array_key_exists('property', $tag)) {
|
|
$metadata[$tag['property']] = $tag['content'];
|
|
} else if (array_key_exists('name', $tag)) {
|
|
$metadata[$tag['name']] = $tag['content'];
|
|
}
|
|
}
|
|
|
|
// Check for existing metadata that may have been set prior to installation of Aura v2.0.0.
|
|
if (isset($page->header()->metadata) && is_array($page->header()->metadata)) {
|
|
foreach ($page->header()->metadata as $key => $val) {
|
|
$exists = false;
|
|
if (array_key_exists($key, $metadata)) {
|
|
$exists = true;
|
|
} else {
|
|
if (isset($page->header()->aura['metadata']) && is_array($page->header()->aura['metadata'])) {
|
|
if (array_key_exists($key, $page->header()->aura['metadata'])) {
|
|
$exists = true;
|
|
}
|
|
}
|
|
}
|
|
if (!$exists) {
|
|
$metadata[$key] = $val;
|
|
$page->header()->aura['metadata'] = array($key => $val);
|
|
}
|
|
}
|
|
}
|
|
|
|
$page->header()->metadata = array_merge($metadata, isset($page->header()->aura['metadata']) ? $page->header()->aura['metadata'] : []);
|
|
|
|
}
|
|
|
|
/**
|
|
* Insert meta tags and structured data to head of each page
|
|
*
|
|
* @param Event $e
|
|
*/
|
|
public function onPageInitialized()
|
|
{
|
|
// Structured Data
|
|
if ($this->grav['config']->get('plugins.aura.output-sd')) {
|
|
|
|
// Don't proceed if required params not set
|
|
$requiredParams = array(
|
|
'org-name',
|
|
'org-url',
|
|
);
|
|
foreach ($requiredParams as $param) {
|
|
$key = 'plugins.aura.' . $param;
|
|
if (!$this->grav['config']->get($key)) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
$page = $this->grav['page'];
|
|
$assets = $this->grav['assets'];
|
|
|
|
$aura = new Aura($page);
|
|
|
|
// Generate structured data block
|
|
$sd = $aura->generateStructuredData();
|
|
// Drop into JS pipeline
|
|
$type = array('type' => 'application/ld+json');
|
|
if (version_compare(GRAV_VERSION, '1.6.0', '<')) {
|
|
$type = 'application/ld+json';
|
|
}
|
|
$assets->addInlineJs($sd, null, null, $type);
|
|
}
|
|
|
|
}
|
|
|
|
} |