Files
chatroom/app/Events/FriendRemoved.php

73 lines
2.2 KiB
PHP
Raw Normal View History

<?php
/**
* 文件功能:好友删除广播事件
*
* 当用户 A 删除用户 B 为好友时,向 B 的私有频道广播此事件。
* 频道名使用数字 IDuser.{id}),避免中文用户名导致 Pusher 频道名验证失败。
*
* @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\ShouldBroadcastNow;
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;
class FriendRemoved implements ShouldBroadcastNow
{
use Dispatchable, InteractsWithSockets, SerializesModels;
/**
* 构造好友删除事件。
*
* @param string $fromUsername 发起删除的用户名A
* @param string $toUsername 被删除的用户名B用于消息显示
* @param int $toUserId 被删除用户的数字 ID用于私有频道避免中文名非法
* @param bool $hadAddedBack B 之前是否也将 A 加为好友(互相好友=true
*/
public function __construct(
public readonly string $fromUsername,
public readonly string $toUsername,
public readonly int $toUserId,
public readonly bool $hadAddedBack = false,
) {}
/**
* 广播到被删除用户的私有频道(用数字 ID 命名,避免中文频道名不合法)。
*/
public function broadcastOn(): Channel
{
return new PrivateChannel('user.'.$this->toUserId);
}
/**
* 指定广播事件名称(短名),供前端 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,
];
}
}