refactor editor-xtd plugin Weblink class

Author: alikon

src/plugins/editors-xtd/weblink/src/Extension/Weblink.php

@@ -4,7 +4,7 @@
  * @package     Joomla.Plugin
  * @subpackage  Editors-xtd.weblink
  *
- * @copyright   Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
+ * @copyright   Copyright (C) 2005 - 2026 Open Source Matters, Inc. All rights reserved.
  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  */
 
@@ -14,19 +14,19 @@
 \defined('_JEXEC') or die;
 // phpcs:enable PSR1.Files.SideEffects
 
-use Joomla\CMS\Application\CMSApplicationInterface;
+use Joomla\CMS\Editor\Button\Button;
+use Joomla\CMS\Event\Editor\EditorButtonsSetupEvent;
 use Joomla\CMS\Language\Text;
 use Joomla\CMS\Plugin\CMSPlugin;
 use Joomla\CMS\Session\Session;
-use Joomla\Database\DatabaseInterface;
-use Joomla\Event\DispatcherInterface;
+use Joomla\Event\SubscriberInterface;
 
 /**
  * Editor Web Link button
  *
  * @since  5.1.0
  */
-final class Weblink extends CMSPlugin
+final class Weblink extends CMSPlugin implements SubscriberInterface
 {
     /**
      * Load the language file on instantiation.
@@ -37,19 +37,39 @@ final class Weblink extends CMSPlugin
     protected $autoloadLanguage = true;
 
     /**
-     * Constructor
+     * Returns an array of events this subscriber will listen to.
      *
-     * @param   DispatcherInterface  $dispatcher
-     * @param   array                $config
-     * @param   DatabaseInterface    $database
+     * @return array
+     *
+     * @since   5.2.0
      */
-    public function __construct(DispatcherInterface $dispatcher, array $config, CMSApplicationInterface $application)
+    public static function getSubscribedEvents(): array
     {
-        parent::__construct($dispatcher, $config);
-
-        $this->setApplication($application);
+        return ['onEditorButtonsSetup' => 'onEditorButtonsSetup'];
     }
 
+    /**
+     * @param  EditorButtonsSetupEvent $event
+     * @return void
+     *
+     * @since   5.2.0
+     */
+    public function onEditorButtonsSetup(EditorButtonsSetupEvent $event): void
+    {
+        $subject  = $event->getButtonsRegistry();
+        $disabled = $event->getDisabledButtons();
+
+        if (\in_array($this->_name, $disabled)) {
+            return;
+        }
+
+        $button = $this->onDisplay($event->getEditorId());
+
+        if ($button) {
+            $subject->add($button);
+        }
+    }
+  
     /**
      * Display the button
       *
@@ -72,27 +92,21 @@ public function onDisplay($name): ?object
             $link = 'index.php?option=com_weblinks&view=weblinks&layout=modal&tmpl=component&'
                 . Session::getFormToken() . '=1&editor=' . $name;
 
-            $button          = new \stdClass();
-            $button->modal   = true;
-            $button->link    = $link;
-            $button->text    = Text::_('PLG_EDITORS-XTD_WEBLINK_BUTTON_WEBLINK');
-            $button->name    = $this->_type . '_' . $this->_name;
-            $button->icon    = 'globe';
-            // phpcs:disable Generic.Files.LineLength
-            $button->iconSVG = '<svg xmlns="http://www.w3.org/2000/svg" width="24 height="24" fill="currentColor" class="bi bi-globe" viewBox="0 0 16 16">
+            $button          = new Button(
+                $this->_name,
+                [
+                    'action'  => 'modal',
+                    'link'    => $link,
+                    'text'    => Text::_('PLG_EDITORS-XTD_WEBLINK_BUTTON_WEBLINK'),
+                    'icon'    => 'globe',
+                    'iconSVG' => '<svg xmlns="http://www.w3.org/2000/svg" width="24 height="24" fill="currentColor" class="bi bi-globe" viewBox="0 0 16 16">
 								  <path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8zm7.5-6.923c-.67.204-1.335.82-1.887 1.855A7.97 7.97 0 0 0 5.145 4H7.5V1.077zM4.09 4a9.267 9.267 0 0 1 .64-1.539 6.7 6.7 0 0 1 .597-.933A7.025 7.025 0 0 0 2.255 4H4.09zm-.582 3.5c.03-.877.138-1.718.312-2.5H1.674a6.958 6.958 0 0 0-.656 2.5h2.49zM4.847 5a12.5 12.5 0 0 0-.338 2.5H7.5V5H4.847zM8.5 5v2.5h2.99a12.495 12.495 0 0 0-.337-2.5H8.5zM4.51 8.5a12.5 12.5 0 0 0 .337 2.5H7.5V8.5H4.51zm3.99 0V11h2.653c.187-.765.306-1.608.338-2.5H8.5zM5.145 12c.138.386.295.744.468 1.068.552 1.035 1.218 1.65 1.887 1.855V12H5.145zm.182 2.472a6.696 6.696 0 0 1-.597-.933A9.268 9.268 0 0 1 4.09 12H2.255a7.024 7.024 0 0 0 3.072 2.472zM3.82 11a13.652 13.652 0 0 1-.312-2.5h-2.49c.062.89.291 1.733.656 2.5H3.82zm6.853 3.472A7.024 7.024 0 0 0 13.745 12H11.91a9.27 9.27 0 0 1-.64 1.539 6.688 6.688 0 0 1-.597.933zM8.5 12v2.923c.67-.204 1.335-.82 1.887-1.855.173-.324.33-.682.468-1.068H8.5zm3.68-1h2.146c.365-.767.594-1.61.656-2.5h-2.49a13.65 13.65 0 0 1-.312 2.5zm2.802-3.5a6.959 6.959 0 0 0-.656-2.5H12.18c.174.782.282 1.623.312 2.5h2.49zM11.27 2.461c.247.464.462.98.64 1.539h1.835a7.024 7.024 0 0 0-3.072-2.472c.218.284.418.598.597.933zM10.855 4a7.966 7.966 0 0 0-.468-1.068C9.835 1.897 9.17 1.282 8.5 1.077V4h2.355z"/>
-								</svg>';
-            // phpcs:enable Generic.Files.LineLength
-            $button->options = [
-                'height'     => '300px',
-                'width'      => '800px',
-                'bodyHeight' => '70',
-                'modalWidth' => '80',
-            ];
-
-            return $button;
-        }
-
-        return null; // return null if conditions are not met
+								</svg>',
+                    // This is whole Plugin name, it is needed for keeping backward compatibility
+                    'name' => $this->_type . '_' . $this->_name,
+                ]
+            );
+            return $button;            
+        }                    
     }
 }