master

laravel/framework

Last updated at: 29/12/2023 09:20

Failed.php

TLDR

The Failed class defines an event that is triggered when a user fails to authenticate.

Classes

Failed

The Failed class represents an event that is triggered when a user fails to authenticate. It contains the following properties:

  • $guard: The authentication guard name.
  • $user: The user the attempter was trying to authenticate as.
  • $credentials: The credentials provided by the attempter.

It also has a constructor method that initializes these properties.

<?php

namespace Illuminate\Auth\Events;

class Failed
{
    /**
     * The authentication guard name.
     *
     * @var string
     */
    public $guard;

    /**
     * The user the attempter was trying to authenticate as.
     *
     * @var \Illuminate\Contracts\Auth\Authenticatable|null
     */
    public $user;

    /**
     * The credentials provided by the attempter.
     *
     * @var array
     */
    public $credentials;

    /**
     * Create a new event instance.
     *
     * @param  string  $guard
     * @param  \Illuminate\Contracts\Auth\Authenticatable|null  $user
     * @param  array  $credentials
     * @return void
     */
    public function __construct($guard, $user, $credentials)
    {
        $this->user = $user;
        $this->guard = $guard;
        $this->credentials = $credentials;
    }
}