README

以下是基于您提供的信息的README文件

Filament SMS Sender 插件

这是一个使用Vonage（原名Nexmo）发送短信消息的Filament插件。此包允许您从下拉列表中选择用户，配置短信设置，并直接从您的Laravel应用程序发送消息。

功能

• 从下拉列表中选择多个用户
• 使用Vonage发送短信消息
• 可配置用户电话号码的表格和列名
• 轻松集成到Filament管理面板

安装

1. 安装包

   使用Composer将包添加到您的Laravel项目中

   composer require kwenziwa/filament-sms-sender

2. 发布配置

   发布包配置文件

   php artisan vendor:publish --provider="Kwenziwa\FilamentSmsSender\Providers\SmsSenderServiceProvider" --tag=config

3. 配置环境变量

   将以下条目添加到您的 .env 文件中

   SMS_SENDER_TABLE_NAME=users
   SMS_SENDER_PHONE_COLUMN=phone_number
   VONAGE_API_KEY=your_api_key
   VONAGE_API_SECRET=your_api_secret
   

   将 your_api_key 和 your_api_secret 替换为您自己的Vonage API凭据。

4. 运行数据库迁移

   确保您的数据库中有一个具有适当电话号码列的表。例如，将电话号码列添加到 users 表中

   php artisan make:migration add_phone_number_to_users_table --table=users

   在迁移文件中

   public function up()
   {
       Schema::table('users', function (Blueprint $table) {
           $table->string('phone_number')->nullable();
       });
   }

   运行迁移

   php artisan migrate

使用方法

1. 将短信发送页面添加到Filament

   在您的Filament管理面板中注册短信发送页面。通常，这是在服务提供程序中完成的

   use Kwenziwa\FilamentSmsSender\Pages\SendSms;
   
   public function boot()
   {
       Filament::registerPages([
           SendSms::class,
       ]);
   }

2. 访问短信发送页面

   导航到您的Filament管理面板中的短信发送页面。您应该看到一个表单，您可以

   • 从多选下拉列表中选择用户
   • 输入发送者号码
   • 编写您的短信消息
   • 点击“发送短信”向所选用户发送消息

配置

您可以通过编辑 config/filament-sms-sender.php 文件来配置电话号码的表格和列名

return [
    'table_name' => env('SMS_SENDER_TABLE_NAME', 'users'),
    'phone_column' => env('SMS_SENDER_PHONE_COLUMN', 'phone_number'),
    'api_key' => env('VONAGE_API_KEY'),
    'api_secret' => env('VONAGE_API_SECRET'),
];

开发

1. 克隆仓库

   将此仓库克隆到您的本地计算机上

   git clone https://github.com/yourusername/filament-sms-sender.git

2. 导航到包目录

   cd filament-sms-sender

3. 安装依赖项

   composer install

4. 运行测试

   确保一切按预期工作

   phpunit

许可证

此包根据MIT许可证授权。有关详细信息，请参阅LICENSE文件。

贡献

欢迎贡献！请通过GitHub提交问题或拉取请求。请确保遵循贡献指南。

联系方式

如有支持或查询，请联系 kwenziwa@live.com。