[5.0][Events] User event classes

components/com_users/src/Model/RemindModel.php

@@ -10,6 +10,7 @@
 
 namespace Joomla\Component\Users\Site\Model;
 
+use Joomla\CMS\Event\User\AfterRemindEvent;
 use Joomla\CMS\Factory;
 use Joomla\CMS\Form\Form;
 use Joomla\CMS\Language\Text;
@@ -201,7 +202,9 @@ public function processRemindRequest($data)
             return false;
         }
 
-        Factory::getApplication()->triggerEvent('onUserAfterRemind', [$user]);
+        $this->getDispatcher()->dispatch('onUserAfterRemind', new AfterRemindEvent('onUserAfterRemind', [
+            'subject' => $user,
+        ]));
 
         return true;
     }

libraries/src/Application/CMSApplication.php

@@ -20,6 +20,13 @@
 use Joomla\CMS\Event\Application\BeforeRenderEvent;
 use Joomla\CMS\Event\Application\BeforeRespondEvent;
 use Joomla\CMS\Event\ErrorEvent;
+use Joomla\CMS\Event\User\AfterLoginEvent;
+use Joomla\CMS\Event\User\AfterLogoutEvent;
+use Joomla\CMS\Event\User\AuthorisationFailureEvent;
+use Joomla\CMS\Event\User\LoginEvent;
+use Joomla\CMS\Event\User\LoginFailureEvent;
+use Joomla\CMS\Event\User\LogoutEvent;
+use Joomla\CMS\Event\User\LogoutFailureEvent;
 use Joomla\CMS\Exception\ExceptionHandler;
 use Joomla\CMS\Extension\ExtensionManagerTrait;
 use Joomla\CMS\Factory;
@@ -837,9 +844,10 @@ public function login($credentials, $options = [])
         // Get the global Authentication object.
         $authenticate = Authentication::getInstance($this->authenticationPluginType);
         $response     = $authenticate->authenticate($credentials, $options);
+        $dispatcher   = $this->getDispatcher();
 
         // Import the user plugin group.
-        PluginHelper::importPlugin('user', null, true, $this->getDispatcher());
+        PluginHelper::importPlugin('user', null, true, $dispatcher);
 
         if ($response->status === Authentication::STATUS_SUCCESS) {
             /*
@@ -852,7 +860,10 @@ public function login($credentials, $options = [])
             foreach ($authorisations as $authorisation) {
                 if ((int) $authorisation->status & $denied_states) {
                     // Trigger onUserAuthorisationFailure Event.
-                    $this->triggerEvent('onUserAuthorisationFailure', [(array) $authorisation]);
+                    $dispatcher->dispatch('onUserAuthorisationFailure', new AuthorisationFailureEvent('onUserAuthorisationFailure', [
+                        'subject' => (array) $authorisation,
+                        'options' => $options,
+                    ]));
 
                     // If silent is set, just return false.
                     if (isset($options['silent']) && $options['silent']) {
@@ -862,25 +873,27 @@ public function login($credentials, $options = [])
                     // Return the error.
                     switch ($authorisation->status) {
                         case Authentication::STATUS_EXPIRED:
-                            Factory::getApplication()->enqueueMessage(Text::_('JLIB_LOGIN_EXPIRED'), 'error');
+                            $this->enqueueMessage(Text::_('JLIB_LOGIN_EXPIRED'), 'error');
 
                             return false;
 
                         case Authentication::STATUS_DENIED:
-                            Factory::getApplication()->enqueueMessage(Text::_('JLIB_LOGIN_DENIED'), 'error');
+                            $this->enqueueMessage(Text::_('JLIB_LOGIN_DENIED'), 'error');
 
                             return false;
 
                         default:
-                            Factory::getApplication()->enqueueMessage(Text::_('JLIB_LOGIN_AUTHORISATION'), 'error');
+                            $this->enqueueMessage(Text::_('JLIB_LOGIN_AUTHORISATION'), 'error');
 
                             return false;
                     }
                 }
             }
 
             // OK, the credentials are authenticated and user is authorised.  Let's fire the onLogin event.
-            $results = $this->triggerEvent('onUserLogin', [(array) $response, $options]);
+            $loginEvent = new LoginEvent('onUserLogin', ['subject' => (array) $response, 'options' => $options]);
+            $dispatcher->dispatch('onUserLogin', $loginEvent);
+            $results = $loginEvent['result'] ?? [];
 
             /*
              * If any of the user plugins did not successfully complete the login routine
@@ -900,14 +913,20 @@ public function login($credentials, $options = [])
                 $options['responseType'] = $response->type;
 
                 // The user is successfully logged in. Run the after login events
-                $this->triggerEvent('onUserAfterLogin', [$options]);
+                $dispatcher->dispatch('onUserAfterLogin', new AfterLoginEvent('onUserAfterLogin', [
+                    'options' => $options,
+                    'subject' => (array) $response,
+                ]));
 
                 return true;
             }
         }
 
         // Trigger onUserLoginFailure Event.
-        $this->triggerEvent('onUserLoginFailure', [(array) $response]);
+        $dispatcher->dispatch('onUserLoginFailure', new LoginFailureEvent('onUserLoginFailure', [
+            'subject' => (array) $response,
+            'options' => $options,
+        ]));
 
         // If silent is set, just return false.
         if (isset($options['silent']) && $options['silent']) {
@@ -942,7 +961,8 @@ public function login($credentials, $options = [])
     public function logout($userid = null, $options = [])
     {
         // Get a user object from the Application.
-        $user = Factory::getUser($userid);
+        $user       = Factory::getUser($userid);
+        $dispatcher = $this->getDispatcher();
 
         // Build the credentials array.
         $parameters = [
@@ -956,21 +976,29 @@ public function logout($userid = null, $options = [])
         }
 
         // Import the user plugin group.
-        PluginHelper::importPlugin('user', null, true, $this->getDispatcher());
+        PluginHelper::importPlugin('user', null, true, $dispatcher);
 
         // OK, the credentials are built. Lets fire the onLogout event.
-        $results = $this->triggerEvent('onUserLogout', [$parameters, $options]);
+        $logoutEvent = new LogoutEvent('onUserLogout', ['subject' => $parameters, 'options' => $options]);
+        $dispatcher->dispatch('onUserLogout', $logoutEvent);
+        $results = $logoutEvent['result'] ?? [];
 
         // Check if any of the plugins failed. If none did, success.
         if (!\in_array(false, $results, true)) {
             $options['username'] = $user->get('username');
-            $this->triggerEvent('onUserAfterLogout', [$options]);
+            $dispatcher->dispatch('onUserAfterLogout', new AfterLogoutEvent('onUserAfterLogout', [
+                'options' => $options,
+                'subject' => $parameters,
+            ]));
 
             return true;
         }
 
         // Trigger onUserLogoutFailure Event.
-        $this->triggerEvent('onUserLogoutFailure', [$parameters]);
+        $dispatcher->dispatch('onUserLogoutFailure', new LogoutFailureEvent('onUserLogoutFailure', [
+            'subject' => $parameters,
+            'options' => $options,
+        ]));
 
         return false;
     }

libraries/src/Authentication/Authentication.php

@@ -9,6 +9,7 @@
 
 namespace Joomla\CMS\Authentication;
 
+use Joomla\CMS\Event\User\AuthorisationEvent;
 use Joomla\CMS\Factory;
 use Joomla\CMS\Language\Text;
 use Joomla\CMS\Log\Log;
@@ -212,10 +213,14 @@ public function authenticate($credentials, $options = [])
      */
     public function authorise($response, $options = [])
     {
+        $dispatcher = $this->getDispatcher();
+
         // Get plugins in case they haven't been imported already
-        PluginHelper::importPlugin('user');
-        $results = Factory::getApplication()->triggerEvent('onUserAuthorisation', [$response, $options]);
+        PluginHelper::importPlugin('user', null, true, $dispatcher);
+
+        $event = new AuthorisationEvent('onUserAuthorisation', ['subject' => $response, 'options' => $options]);
+        $dispatcher->dispatch('onUserAuthorisation', $event);
 
-        return $results;
+        return $event['result'] ?? [];
     }
 }

libraries/src/Event/CoreEventAware.php

@@ -121,6 +121,26 @@ trait CoreEventAware
         'onContentChangeState'          => Model\AfterChangeStateEvent::class,
         'onCategoryChangeState'         => Model\AfterCategoryChangeStateEvent::class,
         'onBeforeBatch'                 => Model\BeforeBatchEvent::class,
+        // User
+        'onUserAuthorisation'        => User\AuthorisationEvent::class,
+        'onUserAuthorisationFailure' => User\AuthorisationFailureEvent::class,
+        'onUserLogin'                => User\LoginEvent::class,
+        'onUserAfterLogin'           => User\AfterLoginEvent::class,
+        'onUserLoginFailure'         => User\LoginFailureEvent::class,
+        'onUserLogout'               => User\LogoutEvent::class,
+        'onUserAfterLogout'          => User\AfterLogoutEvent::class,
+        'onUserLogoutFailure'        => User\LogoutFailureEvent::class,
+        'onUserLoginButtons'         => User\LoginButtonsEvent::class,
+        'onUserBeforeSave'           => User\BeforeSaveEvent::class,
+        'onUserAfterSave'            => User\AfterSaveEvent::class,
+        'onUserBeforeDelete'         => User\BeforeDeleteEvent::class,
+        'onUserAfterDelete'          => User\AfterDeleteEvent::class,
+        'onUserAfterRemind'          => User\AfterRemindEvent::class,
+        // User Group
+        'onUserBeforeSaveGroup'   => Model\BeforeSaveEvent::class,
+        'onUserAfterSaveGroup'    => Model\AfterSaveEvent::class,
+        'onUserBeforeDeleteGroup' => Model\BeforeDeleteEvent::class,
+        'onUserAfterDeleteGroup'  => Model\AfterDeleteEvent::class,
         // Modules
         'onRenderModule'         => Module\BeforeRenderModuleEvent::class,
         'onAfterRenderModule'    => Module\AfterRenderModuleEvent::class,

libraries/src/Event/User/AbstractDeleteEvent.php

@@ -0,0 +1,58 @@
+<?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\User;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Base class for User delete event
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+abstract class AbstractDeleteEvent extends UserEvent
+{
+    /**
+     * 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 = ['subject'];
+
+    /**
+     * Setter for the subject argument.
+     *
+     * @param   array  $value  The value to set
+     *
+     * @return  array
+     *
+     * @since  __DEPLOY_VERSION__
+     */
+    protected function setSubject(array $value): array
+    {
+        return $value;
+    }
+
+    /**
+     * Getter for the user.
+     *
+     * @return  array
+     *
+     * @since  __DEPLOY_VERSION__
+     */
+    public function getUser(): array
+    {
+        return $this->arguments['subject'];
+    }
+}

libraries/src/Event/User/AbstractLoginEvent.php

@@ -0,0 +1,84 @@
+<?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\User;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Base class for User login event
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+abstract class AbstractLoginEvent extends UserEvent
+{
+    /**
+     * 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 = ['subject', 'options'];
+
+    /**
+     * Setter for the subject argument.
+     *
+     * @param   array  $value  The value to set
+     *
+     * @return  array
+     *
+     * @since  __DEPLOY_VERSION__
+     */
+    protected function setSubject(array $value): array
+    {
+        return $value;
+    }
+
+    /**
+     * Setter for the options argument.
+     *
+     * @param   array  $value  The value to set
+     *
+     * @return  array
+     *
+     * @since  __DEPLOY_VERSION__
+     */
+    protected function setOptions(array $value): array
+    {
+        return $value;
+    }
+
+    /**
+     * Getter for the response.
+     *
+     * @return  array
+     *
+     * @since  __DEPLOY_VERSION__
+     */
+    public function getAuthenticationResponse(): array
+    {
+        return $this->arguments['subject'];
+    }
+
+    /**
+     * Getter for the options.
+     *
+     * @return  array
+     *
+     * @since  __DEPLOY_VERSION__
+     */
+    public function getOptions(): array
+    {
+        return $this->arguments['options'] ?? [];
+    }
+}