Create a referrals table to record the recommendation relationship, including the referee, the referee, the recommendation code and the usage time; 2. Define belongsToMany and hasMany relationships in the User model to manage the recommendation data; 3. Generate a unique recommendation code when the user registers (can be implemented through model events); 4. Capture the recommendation code by querying parameters during registration, establish a recommendation relationship after verification and prevent self-recommendation; 5. Trigger the reward mechanism when the recommended user completes the specified behavior (subscription order); 6. Generate a shareable recommendation link, and use Laravel signature URL to enhance security; 7. Display recommendation statistics on the dashboard, such as the total number of recommendations and converted numbers; it is necessary to ensure that database constraints, sessions or cookies persist, recommendation code verification and anti-duplication mechanisms are in place. The entire system is based on Laravel's Eloquent relationship and event system, with good maintainability and scalability.

Implementing a referral system in Laravel involves tracking users who refer others and rewarding them when a referred user completes a specific action (like signing up or making a purchase). Here's how to do it step by step in a clean, maintained way.

1. Set Up the Database Structure

You'll need a table to store referral relationships. Create a migration:

 php artisan make:migration create_referrals_table

In the migration file:

 Schema::create('referrals', function (Blueprint $table) {
    $table->id();
    $table->foreignId('referring_user_id')->constrained('users')->onDelete('cascade');
    $table->foreignId('referred_user_id')->constrained('users')->onDelete('cascade');
    $table->string('referral_code')->nullable(); // Optional: for sharing links
    $table->timestamp('used_at')->nullable(); // When the referral was completed
    $table->timestamps();

    $table->unique(['referring_user_id', 'referred_user_id']);
});

Run the migration:

 php artisan migrate

2. Update the User Model

Add a relationship to the User model ( app/Models/User.php ):

 public function referredBy()
{
    return $this->belongsToMany(
        User::class,
        'referrals',
        'referred_user_id',
        'referring_user_id'
    )->withTimestamps();
}

public function referrals()
{
    return $this->hasMany(Referral::class, 'referring_user_id');
}

Also, ensure your User model has a referral_code field (add it via migration if needed):

 php artisan make:migration add_referral_code_to_users

 $table->string('referral_code')->unique()->nullable();

3. General Referral Codes

Generate a unique referral code when a user registers. In your RegisterController or a listener:

 use Illuminate\Support\Str;

$user = User::create([
    'name' => $request->name,
    'email' => $request->email,
    'password' => Hash::make($request->password),
    'referral_code' => Str::random(8), // eg, "ABCD1234"
]);

Or use a model event (recommended). In User model's boot method:

 protected static function boot()
{
    parent::boot();

    static::created(function ($user) {
        $user->update(['referral_code' => Str::random(8)]);
    });
}

4. Track Referrals During Registration

When a new user signs up using a referral link like /register?ref=ABCD1234 , capture and store the referral.

In your RegisterController :

 public function showRegistrationForm(Request $request)
{
    $referralCode = $request->query('ref');

    // Optional: store in session for later use
    if ($referralCode) {
        session(['referral_code' => $referralCode]);
    }

    return view('auth.register');
}

Then in the registration logic ( register method):

 public function register(Request $request)
{
    // ...validate and create user

    $user = User::create([
        'name' => $request->name,
        'email' => $request->email,
        'password' => Hash::make($request->password),
        'referral_code' => Str::random(8),
    ]);

    // Check for referral
    $referralCode = session('referral_code');
    if ($referralCode) {
        $referrer = User::where('referral_code', $referralCode)->first();

        if ($referrer && $referrer->id !== $user->id) {
            // Prevent self-referral
            $user->referredBy()->attach($referrer->id, [
                'referral_code' => $referralCode,
                'used_at' => now()
            ]);
        }
    }

    // Log in user, etc.
}

5. Reward the Referrer (Optional)

You might want to give a reward when the referred user completes an action (eg, first purchase). Use Laravel events or listeners.

Example: Listen to OrderPlaced event:

 // In OrderController or event listener
$referral = Referral::where('referred_user_id', $user->id)
                   ->whereNull('used_at')
                   ->first();

if ($referral) {
    // Reward the referring user
    RewardUserJob::dispatch($referral->referring_user_id);

    $referral->update(['used_at' => now()]);
}

6. Create Referral Links

Generate sharedable links in your frontend or controller:

 $referralLink = url("/register?ref=" . auth()->user()->referral_code);

You can shorten it or use Laravel's signed URLs for security:

 $referralLink = URL::signedRoute('register', ['ref' => auth()->user()->referral_code]);

7. Display Referral Stats

In a dashboard controller:

 $referrals = auth()->user()->referrals()->with('referredUser')->get();

$count = $referrals->count();
$converted = $referrals->whereNotNull('used_at')->count();

Then pass to view.

Key Points to Remember

• ? Prevent self-referral.
• ? Use sessions or cookies to persist referral code across pages.
• ? Consider using cookies to track referrals over longer sessions.
• ? Validate referral codes before applying.
• ? Use database constraints to avoid duplicates.

Basically, it's about tracking who referred who referred whom using a pivot table, generating shareable codes, and optionally rewarding actions. With Laravel's relationships and events, it's clean and scalable.

The above is the detailed content of How to implement a referral system in Laravel?. For more information, please follow other related articles on the PHP Chinese website!