Skip to content

FindLoginUserEvent ​

Type
Class
Namespace
craft\events
Inherits
craft\events\FindLoginUserEvent » craft\base\Event » yii\base\Event » yii\base\BaseObject
Implements
yii\base\Configurable
Since
4.2.0

FindLoginUserEvent class.

View source

Public Properties ​

PropertyDescription
datamixed – The data that is passed to yii\base\Component::on() when attaching an event handler.
handledboolean – Whether the event is handled.
loginNamestring – The provided email or username
namestring – The event name.
senderobject, null – The sender of this event.
usercraft\elements\User, null – The resolved user, if any.

loginName ​

Type
string
Default value
null

The provided email or username

View source

user ​

Type
craft\elements\User, null
Default value
null

The resolved user, if any.

If this is set by an event handler, that will be the user that is attempted to be signed in.

View source

Public Methods ​

MethodDescription
__call()Calls the named method which is not a class method.
__construct()
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
hasHandlers()Returns a value indicating whether there is any handler attached to the specified class-level event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
off()Detaches an event handler from a class-level event.
offAll()Detaches all registered class-level event handlers.
on()Attaches an event handler to a class-level event.
once()Attaches an event handler to a class-level event, which will be triggered at most one time.
trigger()Triggers a class-level event.