app-packers / laravel-bag
Laravel 的 BAG (Basisregistraties Adressen en Gebouwen) 软件包,来自 Kadaster。
Requires
- php: >=7.1.0
- app-packers/php-bag: ^1.0
- guzzlehttp/guzzle: ^6.3
- illuminate/support: ^5.0|^6.0
Requires (Dev)
- graham-campbell/testbench: ^5.0
- orchestra/testbench: ~3.6
- phpunit/phpunit: ^7.1
This package is auto-updated.
Last update: 2021-09-03 11:06:16 UTC
README
Laravel-BAG 集成了易于使用的软件包,可以从 Basisregistraties Adressen en Gebouwen (BAG) 中检索地址信息,并将其集成到您的 Laravel 或 Lumen 项目中。
要求
- PHP 7.1
安装
通过 composer require
命令将 Laravel-BAG 添加到您的 Composer 文件中
$ composer require app-packers/laravel-bag
或者手动将其添加到 composer.json
"require": { "app-packers/laravel-bag": "1.0.0" }
Laravel
Laravel 5.5+ 将使用其自动发现功能。
在 Laravel 5.4(或者如果您没有使用自动发现)中,通过将服务提供者添加到 config/app.php
中的 providers
键来注册它。同时,通过将外观添加到 config/app.php
中的 aliases
键来注册外观。
'providers' => [ ... AppPackers\LaravelBag\BagServiceProvider::class, ], 'aliases' => [ ... 'Bag' => AppPackers\LaravelBag\BagFacade::class, ]
Lumen
在您的启动应用文件 bootstrap/app.php
中注册提供者。
在文件的“注册服务提供者”部分的底部添加以下行。
$app->register(\AppPackers\LaravelBag\BagServiceProvider::class);
可选:注册外观,在“创建应用程序”部分添加以下行。(不要忘记启用 $app->withFacades();
)
class_alias(\AppPackers\LaravelBag\BagFacade::class, 'Bag');
配置
要开始,您需要在 .env
文件中设置 Basisregistraties Adressen en Gebouwen 的 API 密钥。
BAG_API_KEY=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
您可以通过 Basisregistraties Adressen en Gebouwen 请求 API 密钥。
您还可能想发布所有供应商资产(仅限 Laravel)
$ php artisan vendor:publish --provider="AppPackers\LaravelBag\BagServiceProvider"
这将创建一个 config/bag.php
文件,您可以在其中修改以设置配置。
用法
在这里,您可以看到这个软件包有多么简单易用。
$bagAddress = Bag::getAddressByZipcodeAndStreetNumber('7311KZ', 110);
结果
BagAddress { -street: "Hofstraat" -streetNumber: 110 -city: "Apeldoorn" -zipCode: "7311KZ" }
许可证
此库是开源软件,根据 Apache 许可证 2.0 版 许可。