Storing data

To store data into Session, you can use the put method, or use the auxiliary function session.

// 通过请求实例...
$request->session()->put('key', 'value');
// 通过全局辅助函数...
session(['key' => 'value']);

Save data in Session array

push method can add a new value to the Session array. For example, assuming the key user.teams is an array containing team names, you can add a new value to the array like this:

$request->session()->push('user.teams', 'developers');

Retrieve & Delete A data

pull method can retrieve and delete a statement from the Session using only one statement:

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

Flash data

Sometimes you may want to save data in the Session for the next request, then you can use the flash method. Data saved in the Session using this method will only be retained until the next HTTP request arrives, and then it will be deleted. Flash data is mainly used for short-term status messages:

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

If you need to use this one-time data in more requests, you can use the reflash method, which will save all One-time requests are held until the next request. If you want to save one-time data, you can use keep method:

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

Delete data

forget method will delete the specified data from the Session. If you want to delete all data from the Session, you can use the flush method:

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

Regenerate Session ID

Regenerating session ID is usually to prevent malicious users from using session fixation to attack your application.

If you use the built-in function LoginController, Laravel will automatically regenerate the Session ID in authentication. Otherwise, you need to manually regenerate the Session ID using the regenerate method.

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

Add a custom Session driver

Implementing the driver

Your custom Session driver must implement the SessionHandlerInterface interface. This interface contains some simple methods that we need to implement. The following is an example of the general process for MongoDB implementation:

<?php
  namespace App\Extensions;
  class MongoSessionHandler implements \SessionHandlerInterface{   
   public function open($savePath, $sessionName) {}    
   public function close() {}    
   public function read($sessionId) {}    
   public function write($sessionId, $data) {}    
   public function destroy($sessionId) {}    
   public function gc($lifetime) {}
  }

{tip} Laravel does not come with a directory for package extensions by default. You can place it in the directory you like. In the above example, we created an Extensions directory to store MongoSessionHandler.

Since the above methods are not very easy to understand, let’s quickly go through each method:

Registering the driver

After implementing the driver, you need to register it in the framework. To add additional drivers to the Laravel backend, you need to use the extend method of the Session facade. You should call the extend method in the boot method in the service provider. You can perform this operation on an existing AppServiceProvider or create another service provider:

<?php
   namespace App\Providers;
   use App\Extensions\MongoSessionHandler;
   use Illuminate\Support\Facades\Session;
   use Illuminate\Support\ServiceProvider;
   class SessionServiceProvider extends ServiceProvider{    
      /**
     * 执行服务的注册后启动
     *
     * @return void
     */  
   public function boot()  
     {      
       Session::extend('mongo', function ($app) {           
        // 返回实现 SessionHandlerInterface 的对象            
        return new MongoSessionHandler;        
        });    
      }    
     /**
     * 在容器中注册绑定关系
     *
     * @return void
     */    
     public function register()  
       {    
           //    
        }
      }

When the driver completes registration, you can use the configuration file config/session. The mongo driver is used in php.