koteeki/yii2-clearoutphone

此包的最新版本（1.0.0）没有提供许可证信息。

Yii2 ClearoutPhone 扩展

维护者

详细信息

github.com/koteeki/yii2-clearoutphone

源代码

问题

安装: 2

依赖项: 0

建议者: 0

安全: 0

星级: 0

关注者: 2

分支: 0

开放问题: 0

类型:yii2-extension

1.0.0 2020-01-28 04:25 UTC

Requires

Unknown License e9faacd40ca18a0a6a832d3394e7242d5cae9f1b

  • Vlad Ilinyh <v.ilinyh.woop@gmail.com>

yii2clearoutphone

This package is auto-updated.

Last update: 2024-09-28 22:20:51 UTC

README

一个用于使用 ClearoutPhone API 的 Yii2 扩展。支持的国家： https://clearoutphone.io/supported-countries/

安装

安装此扩展的首选方式是通过 composer。

运行以下命令之一：

php composer.phar require --prefer-dist "koteeki/yii2-clearoutphone":"@dev"

或者添加以下内容到您的 composer.json 文件的 require 部分：

"koteeki/yii2-clearoutphone": "@dev"

用法

return [
    'components' => [
        'clearoutphone' => [
            'class' => \koteeki\clearoutphone\ClearoutPhone::class,
            'token' => 'YOUR_TOKEN_HERE',
            'timeout' => 5000,
        ],
    ],
];
  • 现在您可以通过 \Yii::$app->clearoutphone 访问扩展

方法

  • getCredits() - 获取可用余额。

  • getPhoneDetails(string $number, string $countryCode = null) - 验证电话号码，返回 PhoneNumberDetails。

异常

上述方法由于电话号码验证失败而抛出异常

  • BadRequestException - 由于请求错误导致验证失败，
  • PaymentRequiredException - 您的余额已耗尽，
  • ServiceUnavailable - 服务不可用，
  • TimeoutException - 发生超时，
  • UnauthorizedException - 令牌无效，
  • ClearoutPhoneException - 未知错误。

示例

use koteeki\clearoutphone\ClearoutPhone;
use koteeki\clearoutphone\exceptions\ClearoutPhoneException;

try {
    /** @var ClearoutPhone $clearout */ 
    $clearout = \Yii::$app->clearoutphone;
    $phoneDetails = $clearout->getPhoneDetails('+13024401582');
    if ($phoneDetails->isValid) {
        // your magic here
    }
} catch (ClearoutPhoneException $e) {
    Yii::error($e->getMessage());
}