Revert "Remove the dispatch event functions in model and view (joomla#45431)"

This reverts commit 2bd3afa.

Author: Fedik

libraries/src/MVC/Model/BaseDatabaseModel.php

@@ -31,6 +31,8 @@
 use Joomla\Database\Exception\DatabaseNotFoundException;
 use Joomla\Event\DispatcherAwareInterface;
 use Joomla\Event\DispatcherAwareTrait;
+use Joomla\Event\DispatcherInterface;
+use Joomla\Event\EventInterface;
 
 // phpcs:disable PSR1.Files.SideEffects
 \defined('_JEXEC') or die;
@@ -335,6 +337,55 @@ protected function bootComponent($component): ComponentInterface
         return Factory::getApplication()->bootComponent($component);
     }
 
+    /**
+     * Get the event dispatcher.
+     *
+     * The override was made to keep a backward compatibility for legacy component.
+     * TODO: Remove the override in 6.0
+     *
+     * @return  DispatcherInterface
+     *
+     * @since   4.4.0
+     * @throws  \UnexpectedValueException May be thrown if the dispatcher has not been set.
+     */
+    public function getDispatcher()
+    {
+        if (!$this->dispatcher) {
+            @trigger_error(
+                \sprintf('Dispatcher for %s should be set through MVC factory. It will throw an exception in 6.0', __CLASS__),
+                E_USER_DEPRECATED
+            );
+
+            return Factory::getContainer()->get(DispatcherInterface::class);
+        }
+
+        return $this->dispatcher;
+    }
+
+    /**
+     * Dispatches the given event on the internal dispatcher, does a fallback to the global one.
+     *
+     * @param   EventInterface  $event  The event
+     *
+     * @return  void
+     *
+     * @since   4.1.0
+     *
+     * @deprecated 4.4 will be removed in 6.0. Use $this->getDispatcher() directly.
+     */
+    protected function dispatchEvent(EventInterface $event)
+    {
+        $this->getDispatcher()->dispatch($event->getName(), $event);
+
+        @trigger_error(
+            \sprintf(
+                'Method %s is deprecated and will be removed in 6.0. Use getDispatcher()->dispatch() directly.',
+                __METHOD__
+            ),
+            E_USER_DEPRECATED
+        );
+    }
+
     /**
      * Get the database driver.
      *

libraries/src/MVC/View/AbstractView.php

@@ -11,13 +11,16 @@
 
 use Joomla\CMS\Document\Document;
 use Joomla\CMS\Document\DocumentAwareInterface;
+use Joomla\CMS\Factory;
 use Joomla\CMS\Language\LanguageAwareInterface;
 use Joomla\CMS\Language\LanguageAwareTrait;
 use Joomla\CMS\MVC\Model\BaseDatabaseModel;
 use Joomla\CMS\Object\LegacyErrorHandlingTrait;
 use Joomla\CMS\Object\LegacyPropertyManagementTrait;
 use Joomla\Event\DispatcherAwareInterface;
 use Joomla\Event\DispatcherAwareTrait;
+use Joomla\Event\DispatcherInterface;
+use Joomla\Event\EventInterface;
 
 // phpcs:disable PSR1.Files.SideEffects
 \defined('_JEXEC') or die;
@@ -289,4 +292,53 @@ public function setDocument(Document $document): void
     {
         $this->document = $document;
     }
+
+    /**
+     * Get the event dispatcher.
+     *
+     * The override was made to keep a backward compatibility for legacy component.
+     * TODO: Remove the override in 6.0
+     *
+     * @return  DispatcherInterface
+     *
+     * @since   4.4.0
+     * @throws  \UnexpectedValueException May be thrown if the dispatcher has not been set.
+     */
+    public function getDispatcher()
+    {
+        if (!$this->dispatcher) {
+            @trigger_error(
+                \sprintf('Dispatcher for %s should be set through MVC factory. It will throw an exception in 6.0', __CLASS__),
+                E_USER_DEPRECATED
+            );
+
+            return Factory::getContainer()->get(DispatcherInterface::class);
+        }
+
+        return $this->dispatcher;
+    }
+
+    /**
+     * Dispatches the given event on the internal dispatcher, does a fallback to the global one.
+     *
+     * @param   EventInterface  $event  The event
+     *
+     * @return  void
+     *
+     * @since   4.1.0
+     *
+     * @deprecated 4.4 will be removed in 6.0. Use $this->getDispatcher() directly.
+     */
+    protected function dispatchEvent(EventInterface $event)
+    {
+        $this->getDispatcher()->dispatch($event->getName(), $event);
+
+        @trigger_error(
+            \sprintf(
+                'Method %s is deprecated and will be removed in 6.0. Use getDispatcher()->dispatch() directly.',
+                __METHOD__
+            ),
+            E_USER_DEPRECATED
+        );
+    }
 }

tests/Unit/Libraries/Cms/MVC/View/AbstractViewTest.php

@@ -12,6 +12,9 @@
 
 use Joomla\CMS\MVC\Model\BaseModel;
 use Joomla\CMS\MVC\View\AbstractView;
+use Joomla\Event\DispatcherInterface;
+use Joomla\Event\Event;
+use Joomla\Event\EventInterface;
 use Joomla\Tests\Unit\UnitTestCase;
 
 /**
@@ -217,4 +220,31 @@ public function display($tpl = null)
 
         $this->assertEquals('test', $view->get('unit'));
     }
+
+    /**
+     * @testdox  can dispatch an event
+     *
+     * @return  void
+     *
+     * @since   4.2.0
+     */
+    public function testDispatchEvent()
+    {
+        $event      = new Event('test');
+        $dispatcher = $this->createMock(DispatcherInterface::class);
+        $dispatcher->expects($this->once())->method('dispatch')->with($this->equalTo('test'), $this->equalTo($event));
+
+        $view = new class () extends AbstractView {
+            public function dispatchEvent(EventInterface $event)
+            {
+                parent::dispatchEvent($event);
+            }
+
+            public function display($tpl = null)
+            {
+            }
+        };
+        $view->setDispatcher($dispatcher);
+        $view->dispatchEvent($event);
+    }
 }