README

这个库是一个为 Laravel 提供的适配器，用于 https://github.com/artem-prozorov/data-locker 库。

安装

composer require zebrains/laravel-data-verificator

安装包之后，它将自动发布。现在需要应用迁移并发布配置

php artisan migrate

。

php artisan vendor:publish --provider="Zebrains\LaravelDataLocker\OtpServiceProvider" --tag="config"

实现示例

请求获取控制器

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Prozorov\DataVerification\Types\Address;

class OtpController extends Controller
{
    /**
     * Handle the incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\Response
     */
    public function __invoke(Request $request)
    {
        $manager = app('otp');

        $address = new Address('79034106060');

        $otp = $manager->generateAndSend($address, 'sms');

        return response()->json(['code' => $otp->getVerificationCode()]);
    }
}

请求验证控制器

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class VerificationController extends Controller
{
    /**
     * Handle the incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\Response
     */
    public function __invoke(Request $request)
    {
        $manager = app('otp');

        $pass = $request->get('pass');
        $code = $request->get('code');

        $otp = $manager->verifyOrFail($code, $pass);
    }
}

错误处理

系统中存在一系列异常。其中一些在单次密码请求超时或密码验证不正确时抛出。这些异常不应导致500错误。为了使Laravel正确处理这些异常，需要在ErrorHandler中给出指导。本库有一个特殊的特性 Zebrains\LaravelDataLocker\HandlesOtpExceptions，它加载这些指导。在 App\Exceptions\Handler 类中连接此特性，并在 register 方法内调用 registerOtpExceptionHandlers 方法。

示例

<?php

namespace App\Exceptions;

use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
use Zebrains\LaravelDataLocker\HandlesOtpExceptions;
use Throwable;

class Handler extends ExceptionHandler
{
    use HandlesOtpExceptions;

    protected $dontFlash = [
        'password',
        'password_confirmation',
    ];

    public function register()
    {
        $this->reportable(function (Throwable $e) {
            //
        });

        $this->registerOtpExceptionHandlers();
    }
}

事件系统

您可以通过事件系统来改变库的行为。目前有一个在生成单次密码之前被调用的事件。这对于测试特别有用，可以只为特定的地址改变系统的行为。

例如，如果指定了特定的电话号码，则可以替换生成的代码。

<?php

namespace App\Providers;

use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
use Illuminate\Support\Facades\Event;
use Prozorov\DataVerification\Events\OtpGenerationEvent;

class EventServiceProvider extends ServiceProvider
{
    public function boot()
    {
        Event::listen(function (OtpGenerationEvent $event) {
            if ((string) $event->getAddress() === '79181234567') {
                $event->setOtp('1234');
            }
        });
    }
}

删除过期的密码

php artisan otp:clear

zebrains / laravel-data-verificator

维护者

详情