<?php

namespace App\Module\Promotion\Events;

use App\Module\Promotion\Models\PromotionUserReferral;
use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

/**
 * 推荐关系创建事件
 *
 * 当用户的推荐关系被创建时触发此事件。
 * 监听此事件可以执行如下操作：
 * 1. 更新用户的团队统计数据
 * 2. 更新用户的达人等级
 * 3. 发放邀请奖励
 */
class ReferralCreatedEvent
{
    use Dispatchable, InteractsWithSockets, SerializesModels;

    /**
     * 推荐关系模型
     *
     * @var PromotionUserReferral
     */
    public $referral;

    /**
     * 创建一个新的事件实例
     *
     * @param PromotionUserReferral $referral 推荐关系模型
     * @return void
     */
    public function __construct(PromotionUserReferral $referral)
    {
        $this->referral = $referral;
    }
}