README

这是 Laravel 5 的分支版本，基于 https://travis-ci.org/adityamenon/postcodes-io-laravel.svg。

这是一个用于查询 postcodes.io 网络服务的 Laravel 扩展包。

大部分的 Guzzle 层代码来自 @BoxUk 的 Symfony 扩展包，多谢贡献！

许可证

安装

安装通过 Composer 完成。

1. 运行以下命令

   $ composer require chadanuk/postcodes-io dev-master

   这应该在您的项目的 composer.json 文件中添加以下内容

   "require": {
       "chadanuk/postcodes-io": "dev-master"
   }

2. 将服务提供者添加到您的 app/config/app.php 文件中

   'providers' => array('Chadanuk\PostcodesIo\PostcodesIoServiceProvider')

3. 在同一个文件中添加外观

   'aliases' => array('PostcodesIo' => 'Chadanuk\PostcodesIo\Facade')

用法

使用以下方法中的任何一个来通过 PostcodesIo 外观从服务获取数据。例如：PostcodesIo::lookup('CF10 1DD')。

方法

lookup()

API 文档

查找特定邮编的数据。

参数

• postcode (必需)：邮编。

示例

$response = $client->lookup(array('postcode' => 'CF10 1DD'));

bulkLookup()

API 文档

查找一组邮编的数据。

参数

• postcodes (必需)：邮编数组（最多 100 个）。

示例

$response = $client->bulkLookup(array('postcodes' => array('CF10 1DD', 'W1B 4BD'));

reverseGeocode()

API 文档

获取给定纬度/经度坐标附近邮编的数据。

参数

• latitude (必需)：纬度。
• longitude (必需)：经度。
• limit (可选)：返回邮编的最大数量（默认 10，最多 100）。
• radius (可选)：查找邮编的半径（以米为单位）（默认 100，最多 1000）。

示例

$response = $client->reverseGeocode(array('latitude' => 51.481667, 'longitude' => -3.182155);

bulkReverseGeocode()

API 文档

批量将纬度/经度坐标转换为邮编数据。

参数

• geolocations (必需)：要查找的地理位置（最多 100）。此参数应是一个数组，每个元素具有以下键

  • latitude (必需)：纬度。
  • longitude (必需)：经度。
  • limit (可选)：返回邮编的最大数量（默认 10，最多 100）。
  • radius (可选)：查找邮编的半径（以米为单位）（默认 100，最多 1000）。

示例

$response = $client->bulkReverseGeocode(
    array(
        'geolocations' => array(
            array('latitude' => 51.481667, 'longitude' => -3.182155),
            array('latitude' => 51.88328, 'longitude' => -3.43684, 'limit' => 5, 'radius' => 500)
        )
    )
);

matching()

API 文档

查找符合给定查询的邮编。

参数

• query (可选)：邮编查询，例如 'CF10'。
• limit (可选)：返回邮编的最大数量（默认 10，最多 100）。

示例

$response = $client->matching(array('query' => 'CF10', 'limit' => 20);

validate()

API 文档

验证邮编。

参数

• postcode (必需)：要验证的邮编。

示例

$response = $client->validate(array('postcode' => 'CF10 1DD');

autocomplete()

API 文档

获取一组邮编以自动完成部分邮编。

参数

• postcode (必需)：要自动完成的邮编。
• limit (可选)：返回邮编的最大数量（默认 10，最多 100）。

示例

$response = $client->autocomplete(array('postcode' => 'CF10', 'limit' => 20);

random()

API 文档

获取随机邮编的数据。

参数：无。

示例

$response = $client->random();

outwardCodeLookup()

API 文档

获取指定 "outward code"（邮编前半部分）的数据。

参数

• outcode (必需)：要获取位置数据的 "outward code"（邮编前半部分）。

示例

$response = $client->outwardCodeLookup(array('outcode' => 'CF10');