Allow to modify UserQuery in getByUsernameOrEmail (#216)

src/events/UserQueryCriteria.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace flipbox\saml\sp\events;
+
+use craft\elements\db\UserQuery;
+use yii\base\Event;
+
+class UserQueryCriteria extends Event
+{
+    public UserQuery $userQuery;
+
+    public string $usernameOrEmail;
+
+    public bool $applyDefaultCriteria = true;
+
+    public bool $archived;
+}

src/services/login/User.php

@@ -14,12 +14,14 @@
 use craft\models\FieldLayout;
 use flipbox\saml\core\exceptions\InvalidMessage;
 use flipbox\saml\core\helpers\ProviderHelper;
+use flipbox\saml\sp\events\UserQueryCriteria;
 use flipbox\saml\sp\helpers\UserHelper;
 use flipbox\saml\sp\models\Settings;
 use flipbox\saml\sp\records\ProviderIdentityRecord;
 use flipbox\saml\sp\records\ProviderRecord;
 use flipbox\saml\sp\Saml;
 use SAML2\Response as SamlResponse;
+use yii\base\Event;
 use yii\base\UserException;
 
 /**
@@ -32,6 +34,8 @@ class User extends Component
 
     const EVENT_BEFORE_USER_SAVE = 'eventBeforeUserSave';
 
+    const EVENT_GET_CUSTOM_USER_CRITERIA = 'eventGetCustomUserCriteria';
+
     /**
      * @var FieldLayout|null
      */
@@ -435,18 +439,30 @@ protected function forceGet($username)
      */
     protected function getByUsernameOrEmail($usernameOrEmail, $archived = false)
     {
+        $event = new UserQueryCriteria([
+            'userQuery'       => UserElement::find(),
+            'usernameOrEmail' => $usernameOrEmail,
+            'archived'        => $archived,
+        ]);
+
+        if (Event::hasHandlers(self::class, self::EVENT_GET_CUSTOM_USER_CRITERIA)) {
+            Event::trigger(
+                self::class,
+                self::EVENT_GET_CUSTOM_USER_CRITERIA,
+                $event
+            );
+        }
 
-        return UserElement::find()
+        return ($event->applyDefaultCriteria ? $event->userQuery
             ->where(
                 [
                     'or',
-                    ['username' => $usernameOrEmail],
-                    ['email' => $usernameOrEmail],
+                    ['username' => $event->usernameOrEmail],
+                    ['email'    => $event->usernameOrEmail],
                 ]
             )
             ->status(null)
-            ->archived($archived)
-            ->one();
+            ->archived($event->archived) : $event->userQuery)->one();
     }
 
     private function getAttributeValue($attributeValue)