notifea/notifea-php-laravel

Notifea服务的PHP语言Laravel包装器。

1.2.0 2021-05-16 14:51 UTC

This package is auto-updated.

Last update: 2024-09-16 21:37:59 UTC


README

Notifea服务的PHP语言Laravel包装器。

Notifea 为用户提供了一种非常用户友好的方式,用于向其用户发送交易性电子邮件和短信。

此包是Notifea PHP包的Laravel包装器。

最低要求

此包需要您使用以下内容:

安装

要安装SDK,您需要在项目中使用Composer。有关安装说明,请参阅文档

安装Composer后,安装SDK

composer require notifea/notifea-php-laravel

不要忘记发布配置文件

php artisan vendor:publish --provider='Notifea\Laravel\Providers\NotifeaServiceProvider'

notifea.php配置文件中,您只需要设置authorization配置键,通过设置NOTIFEA_API_AUTHORIZATION环境变量。值可以在访问令牌部分生成。

如果由于任何原因自动发现此包不适用于您,请将Notifea\Laravel\Providers\NotifeaServiceProvider添加到文件config/app.php中的providers部分。

    'providers' => [
        /*
         * Laravel Framework Service Providers...
         */
        Notifea\Laravel\Providers\NotifeaServiceProvider::class,
    ];

用法

此包提供了一层方便的依赖注入层,用于在我们的核心Notifea PHP包中实现的Notifea\Services\EmailServiceNotifea\Services\SmsServiceNotifea\Services\SmsSenderService,因此它们可以轻松地在您的Laravel应用程序的任何地方使用。

可以像这样注入它们:

class UserController
{
    public function sendEmail(Request $request, EmailService $emailService)
    {
        // .. your business logic
        $email = new Email();
        // ... 
        $sentEmail = $emailService->sendEmail($email);
    }

    public function sendSms(Request $request, SmsService $smsService)
    {
        // .. your business logic
        $sms = new Sms();
        // ... 
        $sentSms = $smsService->sendSms($sms);
    }
    
    public function createSmsSender(Request $request, SmsSenderService $smsSenderService)
    {
        // .. your business logic
        $smsSender = new SmsSender();
        // ... 
        $createdSmsSender = $smsSenderService->createSmsSender($smsSender);
    }

}

为了在您的代码中的任何地方快速访问方法,还提供了Notifea\Laravel\Facades\EmailsNotifea\Laravel\Facades\SMSNotifea\Laravel\Facades\SmsSender外观。

Emails外观包含以下方法

  • getEmails()
  • getEmail(string $emailUuid)
  • sendEmail(Email $email)
  • deleteEmail(string $emailUuid)

SMS外观包含以下方法

  • getSmss()
  • getSms(string $smsUuid)
  • sendSms(Sms $sms)
  • deleteSms(string $smsUuid)

SmsSender外观包含以下方法

  • getSmsSenders()
  • getSmsSender(string $smsSenderUuid)
  • createSmsSender(SmsSender $smsSender)
  • updateSmsSender(SmsSender $smsSender)
  • deleteSmsSender(string $smsSenderUuid)

要了解更多关于每个方法的详细信息,请查看我们的核心Notifea PHP包

社区

贡献

依赖关系通过composer管理

$ composer install

可以通过phpunit运行测试

$ vendor/bin/phpunit