first commit
This commit is contained in:
48
plugins/system/accessibility/accessibility.xml
Normal file
48
plugins/system/accessibility/accessibility.xml
Normal file
@ -0,0 +1,48 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<extension type="plugin" group="system" method="upgrade">
|
||||
<name>plg_system_accessibility</name>
|
||||
<author>Joomla! Project</author>
|
||||
<creationDate>2020-02-15</creationDate>
|
||||
<copyright>(C) 2020 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>4.0.0</version>
|
||||
<description>PLG_SYSTEM_ACCESSIBILITY_XML_DESCRIPTION</description>
|
||||
<namespace path="src">Joomla\Plugin\System\Accessibility</namespace>
|
||||
<files>
|
||||
<folder plugin="accessibility">services</folder>
|
||||
<folder>src</folder>
|
||||
</files>
|
||||
<languages folder="admin">
|
||||
<language tag="en-GB">language/en-GB/plg_system_accessibility.ini</language>
|
||||
<language tag="en-GB">language/en-GB/plg_system_accessibility.sys.ini</language>
|
||||
</languages>
|
||||
<config>
|
||||
<fields name="params">
|
||||
<fieldset name="basic">
|
||||
<field
|
||||
name="section"
|
||||
type="list"
|
||||
label="PLG_SYSTEM_ACCESSIBILITY_SECTION"
|
||||
default="administrator"
|
||||
validate="options"
|
||||
>
|
||||
<option value="site">PLG_SYSTEM_ACCESSIBILITY_SECTION_SITE</option>
|
||||
<option value="administrator">PLG_SYSTEM_ACCESSIBILITY_SECTION_ADMIN</option>
|
||||
<option value="both">PLG_SYSTEM_ACCESSIBILITY_SECTION_BOTH</option>
|
||||
</field>
|
||||
<field
|
||||
name="useEmojis"
|
||||
type="list"
|
||||
label="PLG_SYSTEM_ACCESSIBILITY_EMOJIS"
|
||||
default="true"
|
||||
validate="options"
|
||||
>
|
||||
<option value="true">PLG_SYSTEM_ACCESSIBILITY_EMOJIS_TRUE</option>
|
||||
<option value="false">PLG_SYSTEM_ACCESSIBILITY_EMOJIS_FALSE</option>
|
||||
</field>
|
||||
</fieldset>
|
||||
</fields>
|
||||
</config>
|
||||
</extension>
|
||||
46
plugins/system/accessibility/services/provider.php
Normal file
46
plugins/system/accessibility/services/provider.php
Normal file
@ -0,0 +1,46 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @package Joomla.Plugin
|
||||
* @subpackage System.accessibility
|
||||
*
|
||||
* @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\System\Accessibility\Extension\Accessibility;
|
||||
|
||||
return new class () implements ServiceProviderInterface {
|
||||
/**
|
||||
* Registers the service provider with a DI container.
|
||||
*
|
||||
* @param Container $container The DI container.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 4.4.0
|
||||
*/
|
||||
public function register(Container $container): void
|
||||
{
|
||||
$container->set(
|
||||
PluginInterface::class,
|
||||
function (Container $container) {
|
||||
$plugin = new Accessibility(
|
||||
$container->get(DispatcherInterface::class),
|
||||
(array) PluginHelper::getPlugin('system', 'accessibility')
|
||||
);
|
||||
$plugin->setApplication(Factory::getApplication());
|
||||
|
||||
return $plugin;
|
||||
}
|
||||
);
|
||||
}
|
||||
};
|
||||
114
plugins/system/accessibility/src/Extension/Accessibility.php
Normal file
114
plugins/system/accessibility/src/Extension/Accessibility.php
Normal file
@ -0,0 +1,114 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @package Joomla.Plugin
|
||||
* @subpackage System.accessibility
|
||||
*
|
||||
* @copyright (C) 2020 Open Source Matters, Inc. <https://www.joomla.org>
|
||||
* @license GNU General Public License version 2 or later; see LICENSE.txt
|
||||
*/
|
||||
|
||||
namespace Joomla\Plugin\System\Accessibility\Extension;
|
||||
|
||||
use Joomla\CMS\Plugin\CMSPlugin;
|
||||
|
||||
// phpcs:disable PSR1.Files.SideEffects
|
||||
\defined('_JEXEC') or die;
|
||||
// phpcs:enable PSR1.Files.SideEffects
|
||||
|
||||
/**
|
||||
* System plugin to add additional accessibility features to the administrator interface.
|
||||
*
|
||||
* @since 4.0.0
|
||||
*/
|
||||
final class Accessibility extends CMSPlugin
|
||||
{
|
||||
/**
|
||||
* Add the javascript for the accessibility menu
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 4.0.0
|
||||
*/
|
||||
public function onBeforeCompileHead()
|
||||
{
|
||||
$section = $this->params->get('section', 'administrator');
|
||||
|
||||
if ($section !== 'both' && $this->getApplication()->isClient($section) !== true) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Get the document object.
|
||||
$document = $this->getApplication()->getDocument();
|
||||
|
||||
if ($document->getType() !== 'html') {
|
||||
return;
|
||||
}
|
||||
|
||||
// Are we in a modal?
|
||||
if ($this->getApplication()->getInput()->get('tmpl', '', 'cmd') === 'component') {
|
||||
return;
|
||||
}
|
||||
|
||||
// Load language file.
|
||||
$this->loadLanguage();
|
||||
|
||||
// Determine if it is an LTR or RTL language
|
||||
$direction = $this->getApplication()->getLanguage()->isRtl() ? 'right' : 'left';
|
||||
|
||||
// Detect the current active language
|
||||
$lang = $this->getApplication()->getLanguage()->getTag();
|
||||
|
||||
/**
|
||||
* Add strings for translations in Javascript.
|
||||
* Reference https://ranbuch.github.io/accessibility/
|
||||
*/
|
||||
$document->addScriptOptions(
|
||||
'accessibility-options',
|
||||
[
|
||||
'labels' => [
|
||||
'menuTitle' => $this->getApplication()->getLanguage()->_('PLG_SYSTEM_ACCESSIBILITY_MENU_TITLE'),
|
||||
'increaseText' => $this->getApplication()->getLanguage()->_('PLG_SYSTEM_ACCESSIBILITY_INCREASE_TEXT'),
|
||||
'decreaseText' => $this->getApplication()->getLanguage()->_('PLG_SYSTEM_ACCESSIBILITY_DECREASE_TEXT'),
|
||||
'increaseTextSpacing' => $this->getApplication()->getLanguage()->_('PLG_SYSTEM_ACCESSIBILITY_INCREASE_SPACING'),
|
||||
'decreaseTextSpacing' => $this->getApplication()->getLanguage()->_('PLG_SYSTEM_ACCESSIBILITY_DECREASE_SPACING'),
|
||||
'invertColors' => $this->getApplication()->getLanguage()->_('PLG_SYSTEM_ACCESSIBILITY_INVERT_COLORS'),
|
||||
'grayHues' => $this->getApplication()->getLanguage()->_('PLG_SYSTEM_ACCESSIBILITY_GREY'),
|
||||
'underlineLinks' => $this->getApplication()->getLanguage()->_('PLG_SYSTEM_ACCESSIBILITY_UNDERLINE'),
|
||||
'bigCursor' => $this->getApplication()->getLanguage()->_('PLG_SYSTEM_ACCESSIBILITY_CURSOR'),
|
||||
'readingGuide' => $this->getApplication()->getLanguage()->_('PLG_SYSTEM_ACCESSIBILITY_READING'),
|
||||
'textToSpeech' => $this->getApplication()->getLanguage()->_('PLG_SYSTEM_ACCESSIBILITY_TTS'),
|
||||
'speechToText' => $this->getApplication()->getLanguage()->_('PLG_SYSTEM_ACCESSIBILITY_STT'),
|
||||
'resetTitle' => $this->getApplication()->getLanguage()->_('PLG_SYSTEM_ACCESSIBILITY_RESET'),
|
||||
'closeTitle' => $this->getApplication()->getLanguage()->_('PLG_SYSTEM_ACCESSIBILITY_CLOSE'),
|
||||
],
|
||||
'icon' => [
|
||||
'position' => [
|
||||
$direction => [
|
||||
'size' => '0',
|
||||
'units' => 'px',
|
||||
],
|
||||
],
|
||||
'useEmojis' => $this->params->get('useEmojis', 'true') === 'true',
|
||||
],
|
||||
'hotkeys' => [
|
||||
'enabled' => true,
|
||||
'helpTitles' => true,
|
||||
],
|
||||
'textToSpeechLang' => [$lang],
|
||||
'speechToTextLang' => [$lang],
|
||||
]
|
||||
);
|
||||
|
||||
$document->getWebAssetManager()
|
||||
->useScript('accessibility')
|
||||
->addInlineScript(
|
||||
'window.addEventListener("load", function() {'
|
||||
. 'new Accessibility(Joomla.getOptions("accessibility-options") || {});'
|
||||
. '});',
|
||||
['name' => 'inline.plg.system.accessibility'],
|
||||
['type' => 'module'],
|
||||
['accessibility']
|
||||
);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user