spikkl / spikkl-php-laravel-client
Laravel 的 Spikkl API 客户端包装器
v1.3.0
2022-10-04 10:08 UTC
Requires
- php: ^7.2 | ^8.0
- ext-json: *
- illuminate/support: ^6.0 | ^7.0 | ^8.0 | ^9.0
- spikkl/spikkl-php-client: ^1.1
Requires (Dev)
- graham-campbell/testbench: ^5.5
- mockery/mockery: ^1.0
- phpunit/phpunit: ^7.5 | ^8.0
README
Spikkl for Laravel
Spikkl-php-laravel-client 将 Spikkl API 集成到您的 Laravel 或 Lumen 项目中。
要求
- 注册一个免费的 Spikkl 账户。无需注册费用。
- 按照 几个步骤 启用适合的订阅以与 API 通信。
- 可以从您的 Spikkl 控制台 生成的有效 API 密钥。
- PHP >= 7.1。
- Laravel (或 Lumen) >= 5.5
安装
使用 composer require 命令将 Spikkl-php-laravel-client 添加到您的 composer 文件中
$ composer require spikkl/spikkl-php-laravel-client:^1.0
或手动将其添加到 composer.json
"require": { "spikkl/spikkl-php-laravel-client": "^1.0" }
Spikkl-php-laravel-client 的服务提供者将自动通过 Laravel 的自动发现功能进行注册。
注意:对于 Lumen,您必须手动将 Spikkl 门面和服务提供者添加到 bootstrap/app.php
$app->withFacades(true, [ 'Spikkl\Laravel\Facades\Spikkl' => 'Spikkl' ]); $app->register(Spikkl\Laravel\ServiceProvider::class);
配置
您只需将 SPIKKL_API_KEY 变量添加到您的 .env 文件中。
SPIKKL_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
示例用法
在这里,您可以看到这个包如何简单易用。
通过支持的国家代码、邮政编码、街道号码和街道号码后缀进行位置查找。
$results = Spikkl::api()->lookup('nld', '2611HB', '175', null);
通过支持的国家代码、经度和纬度进行位置反向查找。
$results = Spikkl::api()->reverse('nld', 4.354901, 52.012133);
注意:经度和纬度值将四舍五入到 9 位小数。
全局帮助方法
为了方便您,我们添加了全局的 spikkl() 帮助函数。它是一个简单的快捷方式,用于访问 Spikkl::api() 门面访问器。
// Using facade accessor $results = Spikkl::api()->lookup('nld', '2611HB', '175', null); // Using global helper function $results = spikkl()->lookup('nld', '2611HB', '175', null);
许可
BSD (伯克利软件发行版) 许可。版权所有 (c) 2020, Spikkl