Laravel - Session

Laravel - Session Management

Sessions are a way to store information about a user across multiple requests. Laravel provides various drivers to handle session data, including file, cookie, database, apc, array, memcached, and redis. The file driver is used by default as it’s lightweight and requires no setup. Session configuration is located in the config/session.php file. For production applications, drivers like redis or memcached are often preferred for better performance.

Accessing Session Data

To access session data, you typically use the Request object, which can be injected into your controller methods or route closures. Once you have a request instance, you can access the session instance and use the get() method. This method takes one argument, the session key, to retrieve its value. If the key is not found, it returns null or a default value if provided as a second argument.

// Via Illuminate\Http\Request instance
$value = $request->session()->get('key');
$valueWithDefault = $request->session()->get('key', 'default_value');

// You can also use the global session helper
$value = session('key');
$valueWithDefault = session('key', 'default_value');

To retrieve all data in the session, you can use the all() method:

$allData = $request->session()->all();

To check if an item exists in the session, use the has() method. It returns true if the item exists and is not null.

if ($request->session()->has('key')) {
    // Key exists
}

Storing Session Data

Data can be stored in the session using the put() method. The put() method takes two arguments: the key (a string) and the value.

// Via Illuminate\Http\Request instance
$request->session()->put('key', 'value');

// You can also use the global session helper
session(['another_key' => 'another_value']);

Deleting Session Data

The forget() method is used to remove a specific item from the session. This method accepts the key of the item to be deleted.

$request->session()->forget('key');

To remove all data from the session, use the flush() method:

$request->session()->flush();

The pull() method retrieves an item from the session and then deletes it in a single operation. It takes the key as an argument and returns the item’s value.

$value = $request->session()->pull('key_to_pull', 'default');

Flash Data

Sometimes you may wish to store items in the session only for the next request. You may do so using the flash method. Data stored using this method will only be available during the subsequent HTTP request and then will be deleted. Flash data is primarily useful for short-lived status messages:

$request->session()->flash('status', 'Task was successful!');

If you need to persist your flash data for several requests, you may use the reflash method, which will keep all of the flash data for an additional request. If you only need to keep specific flash data, you may use the keep method:

$request->session()->reflash();

$request->session()->keep(['username', 'email']);

Example: Basic Session Usage

Step 1: Create a controller named UserSessionController by executing the following Artisan command in your terminal:

php artisan make:controller UserSessionController

Step 2: After successful execution, a new controller file will be created at app/Http/Controllers/UserSessionController.php. Open this file and replace its content with the following code:

app/Http/Controllers/UserSessionController.php

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class UserSessionController extends Controller
{
    // Store data in the session
    public function setSessionData(Request $request)
    {
        $request->session()->put('user_name', 'John Doe');
        $request->session()->put('user_email', 'john.doe@example.com');
        return 'Session data has been set.';
    }

    // Access data from the session
    public function getSessionData(Request $request)
    {
        if ($request->session()->has('user_name')) {
            $name = $request->session()->get('user_name');
            $email = $request->session()->get('user_email');
            return "User Name: " . $name . "<br>Email: " . $email;
        } else {
            return 'No data found in the session.';
        }
    }

    // Delete data from the session
    public function removeSessionData(Request $request)
    {
        $request->session()->forget('user_name');
        // Or remove specific items:
        // $request->session()->forget(['user_name', 'user_email']);
        return 'User name has been removed from the session.';
    }

    // Delete all session data
    public function flushSessionData(Request $request)
    {
        $request->session()->flush();
        return 'All session data has been removed.';
    }
}

Step 3: Define routes for these controller actions. Open your routes/web.php file and add the following lines:

routes/web.php

use App\Http\Controllers\UserSessionController;

Route::get('session/set', [UserSessionController::class, 'setSessionData']);
Route::get('session/get', [UserSessionController::class, 'getSessionData']);
Route::get('session/remove', [UserSessionController::class, 'removeSessionData']);
Route::get('session/flush', [UserSessionController::class, 'flushSessionData']);

Step 4: Start your Laravel development server if it’s not already running (php artisan serve).

Step 5: Visit the following URL in your browser to store data in the session:

http://localhost:8000/session/set

The browser will display: “Session data has been set.”

Step 6: Visit the following URL to retrieve the data from the session:

http://localhost:8000/session/get

The browser will display: “User Name: John Doe
Email: john.doe@example.com”

Step 7: Visit the following URL to remove specific session data (user_name):

http://localhost:8000/session/remove

The browser will display: “User name has been removed from the session.”

Step 8: Visit http://localhost:8000/session/get again. Now it will display: “User Name:
Email: john.doe@example.com” (or similar, as user_name was removed but email remains if not explicitly removed). If you removed both user_name and user_email, or flushed the session, it would show ‘No data found in the session.’

Step 9: To remove all session data, visit:

http://localhost:8000/session/flush

The browser will display: “All session data has been removed.”

Further Reading: For more details on session configuration and advanced usage, refer to the official Laravel documentation on HTTP Sessions.