laravel/bundles/docs/pages/auth/config.md

Auth Configuration

Contents

• The Basics
• The User Function
• The Attempt Function
• The Logout Function

The Basics

Most interactive applications have the ability for users to login and logout. Laravel provides a simple class to help you validate user credentials and retrieve information about the current user of your application.

To get started, let's look over the application/config/auth.php file. The authentication configuration contains three functions: user, attempt, and logout. Let's go over each one individually.

The "User" Function

The user function is called when Laravel needs to retrieve the currently logged in user of your application. When a user logs into your application, Laravel stores the ID of that user in the session. So, on subsequent requests, we can use the ID stored in the session to retrieve the user's information from storage. However, applications use various data stores. For this reason, you are given complete flexibility regarding how to retrieve the user.

Of course, a simple default configuration has been setup for you. Let's take a look:

'user' => function($id)
{
    if ( ! is_null($id) and filter_var($id, FILTER_VALIDATE_INT) !== false)
    {
        return DB::table('users')->find($id);
    }
}

As you probably noticed, the user's ID is passed to the function. The default configuration utilizes the fluent query builder to retrieve and return the user from the database. Of course, you are free to use other methods of retrieving the user. If no user is found in storage for the given ID, the function should simply return null.

The "Attempt" Function

Anytime you need to validate the credentials of a user, the attempt function is called. When attempting to authenticate a user, you will typically retrieve the user out of storage, and check the hashed password against the given password. However, since applications may use various methods of hashing or even third-party login providers, you are free to implement the authentication however you wish. Again, a simple and sensible default has been provided:

'attempt' => function($username, $password)
{
    $user = DB::table('users')->where_username($username)->first();

    if ( ! is_null($user) and Hash::check($password, $user->password))
    {
        return $user;
    }
}

Like the previous example, the fluent query builder is used to retrieve the user out of the database by the given username. If the user is found, the given password is hashed and compared against the hashed password stored on the table, and if the passwords match, the user model is returned. If the credentials are invalid or the user does not exist, null should be returned.

Note: Any object may be returned by this function as long as it has an id property.

The "Logout" Function

The logout function is called whenever a user is logged out of your application. This function gives you a convenient location to interact with any third-party authentication providers you may be using.