<?php

/**
 * 文件功能：好友删除广播事件
 *
 * 当用户 A 删除用户 B 为好友时，向 B 的私有频道广播此事件，
 * B 的客户端收到后展示弹窗通知。
 * 携带 hadAddedBack 字段：若 B 之前也把 A 加为好友（互相好友）则为 true，
 * 前端可提示 B "是否同步移除对方"。
 *
 * @author   ChatRoom Laravel
 *
 * @version  1.0.0
 */

namespace App\Events;

use Illuminate\Broadcasting\Channel;
use Illuminate\Broadcasting\InteractsWithSockets;
use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;

class FriendRemoved implements ShouldBroadcast
{
    use Dispatchable, InteractsWithSockets, SerializesModels;

    /**
     * 构造好友删除事件。
     *
     * @param  string  $fromUsername  发起删除的用户名（A）
     * @param  string  $toUsername  被删除的用户名（B，接收通知方）
     * @param  bool  $hadAddedBack  B 之前是否也将 A 加为好友（互相好友=true）
     */
    public function __construct(
        public readonly string $fromUsername,
        public readonly string $toUsername,
        public readonly bool $hadAddedBack = false,
    ) {}

    /**
     * 广播到被删除用户的私有频道，仅本人可见。
     */
    public function broadcastOn(): Channel
    {
        return new PrivateChannel('user.'.$this->toUsername);
    }

    /**
     * 指定广播事件名称（短名），供前端 listen('.FriendRemoved') 匹配。
     *
     * 默认广播名为全类名 App\Events\FriendRemoved，
     * 指定短名后前端只需 .listen('.FriendRemoved')。
     */
    public function broadcastAs(): string
    {
        return 'FriendRemoved';
    }

    /**
     * 广播负载：包含发起人信息和之前互相好友状态，供前端弹窗使用。
     *
     * @return array<string, mixed>
     */
    public function broadcastWith(): array
    {
        return [
            'from_username' => $this->fromUsername,
            'to_username' => $this->toUsername,
            'type' => 'friend_removed',
            'had_added_back' => $this->hadAddedBack,
        ];
    }
}