[5.0][Events] Extension and Installer event classes

administrator/components/com_categories/src/Model/CategoryModel.php

@@ -14,6 +14,7 @@
 use Joomla\CMS\Association\AssociationServiceInterface;
 use Joomla\CMS\Categories\CategoryServiceInterface;
 use Joomla\CMS\Component\ComponentHelper;
+use Joomla\CMS\Event\Model\AfterCategoryChangeStateEvent;
 use Joomla\CMS\Factory;
 use Joomla\CMS\Form\Form;
 use Joomla\CMS\Helper\TagsHelper;
@@ -740,10 +741,14 @@ public function publish(&$pks, $value = 1)
             $extension = Factory::getApplication()->getInput()->get('extension');
 
             // Include the content plugins for the change of category state event.
-            PluginHelper::importPlugin('content');
+            PluginHelper::importPlugin('content', null, true, $this->getDispatcher());
 
             // Trigger the onCategoryChangeState event.
-            Factory::getApplication()->triggerEvent('onCategoryChangeState', [$extension, $pks, $value]);
+            $this->getDispatcher()->dispatch('onCategoryChangeState', new AfterCategoryChangeStateEvent('onCategoryChangeState', [
+                'context' => $extension,
+                'subject' => $pks,
+                'value'   => $value,
+            ]));
 
             return true;
         }

administrator/components/com_mails/src/Controller/TemplateController.php

@@ -11,7 +11,7 @@
 namespace Joomla\Component\Mails\Administrator\Controller;
 
 use Joomla\CMS\Application\CMSApplication;
-use Joomla\CMS\Factory;
+use Joomla\CMS\Event\Model;
 use Joomla\CMS\Language\Text;
 use Joomla\CMS\MVC\Controller\FormController;
 use Joomla\CMS\MVC\Factory\MVCFactoryInterface;
@@ -192,9 +192,13 @@ public function save($key = null, $urlVar = null)
 
         // Send an object which can be modified through the plugin event
         $objData = (object) $data;
-        $this->app->triggerEvent(
+        $this->getDispatcher()->dispatch(
             'onContentNormaliseRequestData',
-            [$this->option . '.' . $this->context, $objData, $form]
+            new Model\NormaliseRequestDataEvent('onContentNormaliseRequestData', [
+                'context' => $this->option . '.' . $this->context,
+                'data'    => $objData,
+                'subject' => $form,
+            ])
         );
         $data = (array) $objData;
 

administrator/components/com_scheduler/src/Traits/TaskPluginTrait.php

@@ -10,6 +10,7 @@
 
 namespace Joomla\Component\Scheduler\Administrator\Traits;
 
+use Joomla\CMS\Event\Model;
 use Joomla\CMS\Factory;
 use Joomla\CMS\Form\Form;
 use Joomla\CMS\Language\Text;
@@ -97,8 +98,8 @@ protected function endRoutine(ExecuteTaskEvent $event, int $exitCode): void
      * `onContentPrepareForm` event through {@see SubscriberInterface::getSubscribedEvents()} and will take care
      * of injecting the fields without additional logic in the plugin class.
      *
-     * @param   EventInterface|Form  $context  The onContentPrepareForm event or the Form object.
-     * @param   mixed                $data     The form data, required when $context is a {@see Form} instance.
+     * @param   Model\PrepareFormEvent|Form  $context  The onContentPrepareForm event or the Form object.
+     * @param   mixed                        $data     The form data, required when $context is a {@see Form} instance.
      *
      * @return boolean  True if the form was successfully enhanced or the context was not relevant.
      *
@@ -107,10 +108,9 @@ protected function endRoutine(ExecuteTaskEvent $event, int $exitCode): void
      */
     public function enhanceTaskItemForm($context, $data = null): bool
     {
-        if ($context instanceof EventInterface) {
-            /** @var Form $form */
-            $form = $context->getArgument('0');
-            $data = $context->getArgument('1');
+        if ($context instanceof Model\PrepareFormEvent) {
+            $form = $context->getForm();
+            $data = $context->getData();
         } elseif ($context instanceof Form) {
             $form = $context;
         } else {

components/com_content/src/View/Article/HtmlView.php

@@ -11,6 +11,7 @@
 namespace Joomla\Component\Content\Site\View\Article;
 
 use Joomla\CMS\Categories\Categories;
+use Joomla\CMS\Event\Content;
 use Joomla\CMS\Factory;
 use Joomla\CMS\Helper\TagsHelper;
 use Joomla\CMS\Language\Associations;
@@ -23,7 +24,6 @@
 use Joomla\CMS\Uri\Uri;
 use Joomla\Component\Content\Site\Helper\AssociationHelper;
 use Joomla\Component\Content\Site\Helper\RouteHelper;
-use Joomla\Event\Event;
 
 // phpcs:disable PSR1.Files.SideEffects
 \defined('_JEXEC') or die;
@@ -173,7 +173,7 @@ public function display($tpl = null)
             }
         }
 
-        $offset = $this->state->get('list.offset');
+        $offset = (int) $this->state->get('list.offset');
 
         // Check the view access to the article (the model has already computed the values).
         if ($item->params->get('access-view') == false && ($item->params->get('show_noauth', '0') == '0')) {
@@ -223,18 +223,31 @@ public function display($tpl = null)
         }
 
         // Process the content plugins.
-        PluginHelper::importPlugin('content');
-        $this->dispatchEvent(new Event('onContentPrepare', ['com_content.article', &$item, &$item->params, $offset]));
-
-        $item->event                    = new \stdClass();
-        $results                        = Factory::getApplication()->triggerEvent('onContentAfterTitle', ['com_content.article', &$item, &$item->params, $offset]);
-        $item->event->afterDisplayTitle = trim(implode("\n", $results));
-
-        $results                           = Factory::getApplication()->triggerEvent('onContentBeforeDisplay', ['com_content.article', &$item, &$item->params, $offset]);
-        $item->event->beforeDisplayContent = trim(implode("\n", $results));
-
-        $results                          = Factory::getApplication()->triggerEvent('onContentAfterDisplay', ['com_content.article', &$item, &$item->params, $offset]);
-        $item->event->afterDisplayContent = trim(implode("\n", $results));
+        PluginHelper::importPlugin('content', null, true, $this->getDispatcher());
+
+        $contentEventArguments = [
+            'context' => 'com_content.article',
+            'subject' => $item,
+            'params'  => $item->params,
+            'page'    => $offset,
+        ];
+
+        $this->dispatchEvent(new Content\ContentPrepareEvent('onContentPrepare', $contentEventArguments));
+
+        // Extra content from events
+        $item->event   = new \stdClass();
+        $contentEvents = [
+            'afterDisplayTitle'    => new Content\AfterTitleEvent('onContentAfterTitle', $contentEventArguments),
+            'beforeDisplayContent' => new Content\BeforeDisplayEvent('onContentBeforeDisplay', $contentEventArguments),
+            'afterDisplayContent'  => new Content\AfterDisplayEvent('onContentAfterDisplay', $contentEventArguments),
+        ];
+
+        foreach ($contentEvents as $resultKey => $event) {
+            $this->dispatchEvent($event);
+            $results = $event['result'];
+
+            $item->event->{$resultKey} = $results ? trim(implode("\n", $results)) : '';
+        }
 
         // Escape strings for HTML output
         $this->pageclass_sfx = htmlspecialchars($this->item->params->get('pageclass_sfx', ''));

components/com_users/src/Controller/ProfileController.php

@@ -10,6 +10,7 @@
 
 namespace Joomla\Component\Users\Site\Controller;
 
+use Joomla\CMS\Event\Model;
 use Joomla\CMS\Language\Text;
 use Joomla\CMS\MVC\Controller\BaseController;
 use Joomla\CMS\Router\Route;
@@ -105,9 +106,13 @@ public function save()
 
         // Send an object which can be modified through the plugin event
         $objData = (object) $requestData;
-        $app->triggerEvent(
+        $this->getDispatcher()->dispatch(
             'onContentNormaliseRequestData',
-            ['com_users.user', $objData, $form]
+            new Model\NormaliseRequestDataEvent('onContentNormaliseRequestData', [
+                'context' => 'com_users.user',
+                'data'    => $objData,
+                'subject' => $form,
+            ])
         );
         $requestData = (array) $objData;
 

libraries/src/Event/AbstractEvent.php

@@ -111,8 +111,6 @@ public function __construct(string $name, array $arguments = [])
     {
         parent::__construct($name, $arguments);
 
-        $this->arguments = [];
-
         foreach ($arguments as $argumentName => $value) {
             $this->setArgument($argumentName, $value);
         }

libraries/src/Event/Content/AfterDisplayEvent.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * Joomla! Content Management System
+ *
+ * @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\CMS\Event\Content;
+
+use Joomla\CMS\Event\Result\ResultAware;
+use Joomla\CMS\Event\Result\ResultAwareInterface;
+use Joomla\CMS\Event\Result\ResultTypeStringAware;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Class for Content event.
+ * Example:
+ *  new AfterDisplayEvent('onEventName', ['context' => 'com_example.example', 'subject' => $contentObject, 'params' => $params, 'page' => $pageNum]);
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+class AfterDisplayEvent extends ContentPrepareEvent implements ResultAwareInterface
+{
+    use ResultAware;
+    use ResultTypeStringAware;
+}

libraries/src/Event/Content/AfterTitleEvent.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * Joomla! Content Management System
+ *
+ * @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\CMS\Event\Content;
+
+use Joomla\CMS\Event\Result\ResultAware;
+use Joomla\CMS\Event\Result\ResultAwareInterface;
+use Joomla\CMS\Event\Result\ResultTypeStringAware;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Class for Content event.
+ * Example:
+ *  new AfterTitleEvent('onEventName', ['context' => 'com_example.example', 'subject' => $contentObject, 'params' => $params, 'page' => $pageNum]);
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+class AfterTitleEvent extends ContentPrepareEvent implements ResultAwareInterface
+{
+    use ResultAware;
+    use ResultTypeStringAware;
+}

libraries/src/Event/Content/BeforeDisplayEvent.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * Joomla! Content Management System
+ *
+ * @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\CMS\Event\Content;
+
+use Joomla\CMS\Event\Result\ResultAware;
+use Joomla\CMS\Event\Result\ResultAwareInterface;
+use Joomla\CMS\Event\Result\ResultTypeStringAware;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Class for Content event.
+ * Example:
+ *  new BeforeDisplayEvent('onEventName', ['context' => 'com_example.example', 'subject' => $contentObject, 'params' => $params, 'page' => $pageNum]);
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+class BeforeDisplayEvent extends ContentPrepareEvent implements ResultAwareInterface
+{
+    use ResultAware;
+    use ResultTypeStringAware;
+}

libraries/src/Event/Content/ContentEvent.php

@@ -0,0 +1,91 @@
+<?php
+
+/**
+ * Joomla! Content Management System
+ *
+ * @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\CMS\Event\Content;
+
+use Joomla\CMS\Event\AbstractImmutableEvent;
+use Joomla\CMS\Event\ReshapeArgumentsAware;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Base class for Content events
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+abstract class ContentEvent extends AbstractImmutableEvent
+{
+    use ReshapeArgumentsAware;
+
+    /**
+     * The argument names, in order expected by legacy plugins.
+     *
+     * @var array
+     *
+     * @since  __DEPLOY_VERSION__
+     * @deprecated 5.0 will be removed in 6.0
+     */
+    protected $legacyArgumentsOrder = [];
+
+    /**
+     * Constructor.
+     *
+     * @param   string  $name       The event name.
+     * @param   array   $arguments  The event arguments.
+     *
+     * @throws  \BadMethodCallException
+     *
+     * @since   __DEPLOY_VERSION__
+     */
+    public function __construct($name, array $arguments = [])
+    {
+        // Reshape the arguments array to preserve b/c with legacy listeners
+        if ($this->legacyArgumentsOrder) {
+            $arguments = $this->reshapeArguments($arguments, $this->legacyArgumentsOrder);
+        }
+
+        if (!\array_key_exists('context', $arguments)) {
+            throw new \BadMethodCallException("Argument 'context' of event {$name} is required but has not been provided");
+        }
+
+        if (!\array_key_exists('subject', $arguments)) {
+            throw new \BadMethodCallException("Argument 'subject' of event {$name} is required but has not been provided");
+        }
+
+        parent::__construct($name, $arguments);
+    }
+
+    /**
+     * Setter for the context argument.
+     *
+     * @param   string  $value  The value to set
+     *
+     * @return  string
+     *
+     * @since  __DEPLOY_VERSION__
+     */
+    protected function setContext(string $value): string
+    {
+        return $value;
+    }
+
+    /**
+     * Getter for the context argument.
+     *
+     * @return  string
+     *
+     * @since  __DEPLOY_VERSION__
+     */
+    public function getContext(): string
+    {
+        return $this->arguments['context'];
+    }
+}