Document event, AfterInitialiseDocument Event

joomla · May 7, 2023 · 1efc69a · 1efc69a
1 parent 34024c5
commit 1efc69a
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 6 deletions.
diff --git a/libraries/src/Application/AdministratorApplication.php b/libraries/src/Application/AdministratorApplication.php
@@ -11,6 +11,7 @@
 
 use Joomla\Application\Web\WebClient;
 use Joomla\CMS\Component\ComponentHelper;
+use Joomla\CMS\Event\Application\AfterInitialiseDocumentEvent;
 use Joomla\CMS\Factory;
 use Joomla\CMS\Filter\InputFilter;
 use Joomla\CMS\Input\Input;
@@ -141,8 +142,11 @@ public function dispatch($component = null)
         $document->setGenerator('Joomla! - Open Source Content Management');
 
         // Trigger the onAfterInitialiseDocument event.
-        PluginHelper::importPlugin('system');
-        $this->triggerEvent('onAfterInitialiseDocument');
+        PluginHelper::importPlugin('system', null, true, $this->getDispatcher());
+        $this->dispatchEvent(
+            'onAfterInitialiseDocument',
+            new AfterInitialiseDocumentEvent('onAfterInitialiseDocument', ['subject' => $this, 'document' => $document])
+        );
 
         $contents = ComponentHelper::renderComponent($component);
         $document->setBuffer($contents, 'component');

diff --git a/libraries/src/Application/ApiApplication.php b/libraries/src/Application/ApiApplication.php
@@ -12,6 +12,7 @@
 use Joomla\Application\Web\WebClient;
 use Joomla\CMS\Access\Exception\AuthenticationFailed;
 use Joomla\CMS\Component\ComponentHelper;
+use Joomla\CMS\Event\Application\AfterInitialiseDocumentEvent;
 use Joomla\CMS\Factory;
 use Joomla\CMS\Plugin\PluginHelper;
 use Joomla\CMS\Router\ApiRouter;
@@ -416,8 +417,11 @@ public function dispatch($component = null)
         Factory::$document = $document;
 
         // Trigger the onAfterInitialiseDocument event.
-        PluginHelper::importPlugin('system');
-        $this->triggerEvent('onAfterInitialiseDocument');
+        PluginHelper::importPlugin('system', null, true, $this->getDispatcher());
+        $this->dispatchEvent(
+            'onAfterInitialiseDocument',
+            new AfterInitialiseDocumentEvent('onAfterInitialiseDocument', ['subject' => $this, 'document' => $document])
+        );
 
         $contents = ComponentHelper::renderComponent($component);
         $document->setBuffer($contents, 'component');

diff --git a/libraries/src/Application/SiteApplication.php b/libraries/src/Application/SiteApplication.php
@@ -13,6 +13,7 @@
 use Joomla\CMS\Cache\CacheControllerFactoryAwareTrait;
 use Joomla\CMS\Cache\Controller\OutputController;
 use Joomla\CMS\Component\ComponentHelper;
+use Joomla\CMS\Event\Application\AfterInitialiseDocumentEvent;
 use Joomla\CMS\Factory;
 use Joomla\CMS\Filter\InputFilter;
 use Joomla\CMS\Input\Input;
@@ -206,8 +207,11 @@ public function dispatch($component = null)
         }
 
         // Trigger the onAfterInitialiseDocument event.
-        PluginHelper::importPlugin('system');
-        $this->triggerEvent('onAfterInitialiseDocument');
+        PluginHelper::importPlugin('system', null, true, $this->getDispatcher());
+        $this->dispatchEvent(
+            'onAfterInitialiseDocument',
+            new AfterInitialiseDocumentEvent('onAfterInitialiseDocument', ['subject' => $this, 'document' => $document])
+        );
 
         $contents = ComponentHelper::renderComponent($component);
         $document->setBuffer($contents, 'component');

diff --git a/libraries/src/Event/Application/AfterInitialiseDocumentEvent.php b/libraries/src/Event/Application/AfterInitialiseDocumentEvent.php
@@ -0,0 +1,23 @@
+<?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
+ */
+
+namespace Joomla\CMS\Event\Application;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('JPATH_PLATFORM') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Event class for AfterInitialiseDocument event
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+class AfterInitialiseDocumentEvent extends ApplicationDocumentEvent
+{
+}
diff --git a/libraries/src/Exception/ExceptionHandler.php b/libraries/src/Exception/ExceptionHandler.php
@@ -11,6 +11,7 @@
 
 use Joomla\CMS\Application\CMSApplication;
 use Joomla\CMS\Error\AbstractRenderer;
+use Joomla\CMS\Event\Application\AfterInitialiseDocumentEvent;
 use Joomla\CMS\Factory;
 use Joomla\CMS\Log\Log;
 
@@ -118,6 +119,15 @@ public static function render(\Throwable $error)
             Factory::$document = $renderer->getDocument();
             Factory::getApplication()->loadDocument(Factory::$document);
 
+            // Trigger the onAfterInitialiseDocument event.
+            $app->getDispatcher()->dispatch(
+                'onAfterInitialiseDocument',
+                new AfterInitialiseDocumentEvent('onAfterInitialiseDocument', [
+                    'subject'  => $app,
+                    'document' => $renderer->getDocument(),
+                ])
+            );
+
             $data = $renderer->render($error);
 
             // If nothing was rendered, just use the message from the Exception