apxcde/laravel-onfon-sms

此包的最新版本(dev-main)没有提供许可证信息。

将 OnFon SMS 添加到您的 Laravel 网络应用程序

dev-main 2022-11-23 18:23 UTC

This package is auto-updated.

Last update: 2024-09-23 22:29:07 UTC


README

您的描述应该在这里。请限制为一两段。考虑添加一个小示例。

安装

您可以通过 composer 安装此包

composer require apxcde/laravel-onfon-sms

发布配置文件

您可以使用以下命令发布配置文件

php artisan vendor:publish --provider="Apxcde\OnfonSms\OnfonSmsServiceProvider" --tag="onfon-sms-config"

这是已发布配置文件的内容

return [
    'senderId' => env('ONFON_SMS_SENDER_ID', ''),

    'api_key' => env('ONFON_SMS_API_KEY', ''),

    'client_id' => env('ONFON_SMS_CLIENT_ID', ''),

    'access_key' => env('ONFON_SMS_ACCESS_KEY', ''),
];

添加环境变量

在您的 .env 文件中设置以下变量。您将从 onfon media 收到这些变量

ONFON_SMS_SENDER_ID=""
ONFON_SMS_API_KEY=""
ONFON_SMS_CLIENT_ID=""
ONFON_SMS_ACCESS_KEY=""

设置可通知模型

在您的可通知模型上添加 routeNotificationForOnfon 方法。如果不添加此方法,将自动使用 phone_number 字段。

<?php

namespace App;

use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable
{
    use Notifiable;

    /**
     * Route notifications for the OnFon channel.
     *
     * @param  \Illuminate\Notifications\Notification  $notification
     * @return string
     */
    public function routeNotificationForOnfon($notification)
    {
        return $this->phone;
    }
}

用法

要使用此包,您需要在 Laravel 应用程序中创建一个通知类,例如下面的 NewsWasPublished,确保查看 Laravel 文档了解此过程。

<?php

use Apxcde\OnfonSms\OnfonChannel;
use Apxcde\OnfonSms\OnfonMessage;

class NewsWasPublished extends Notification
{

    /**
     * Get the notification's delivery channels.
     *
     * @param  mixed  $notifiable
     * @return array
     */
    public function via($notifiable)
    {
        return [OnfonChannel::class];
    }

    public function toOnfon($notifiable)
    {
		return (new OnfonMessage())
                    ->content('Your SMS message content');

    }
}

测试

composer test

变更日志

有关最近更改的更多信息,请参阅 CHANGELOG

贡献

有关详细信息,请参阅 CONTRIBUTING

安全漏洞

如果您发现任何与安全相关的问题,请通过电子邮件 erick@apexcode.dev 联系,而不是使用问题跟踪器。

致谢