README

# zzipcode.com 的 Zipcode 库

安装与设置

composer require candrews/zipcode

在 zzipcode.com 上注册。这是免费的。

注册后，您将获得一个访问密钥。

将此密钥插入到 /vendor/candrews/Zipcode/src/config.php

使用方法

获取 Zipcode

$zipcode = new Zipcode\Zipcode(33024);
$zipcode->get();

if($zipcode->hasError()){
    echo $zipcode->getError();
}

var_dump($zipcode); // Valid $zipcode

获取带有附近 Zipcode 的 Zipcode

$zipcode = new Zipcode\Zipcode(33024);
$zipcode->get(15);

if($zipcode->hasError()){
    echo $zipcode->getError();
}

var_dump($zipcode->near); // Array of Zipcode Objects within 15 mi of 33024

获取带有详细信息的附近 Zipcode

$zipcode = new Zipcode\Zipcode(33024);
$zipcodes = $zipcode->near(15);

if($zipcodes->hasError()){
    echo $zipcodes->getError();
}

var_dump($zipcodes); // Array of Zipcode Objects within 15 mi of 33024

获取附近 Zipcode

$zipcode = new Zipcode\Zipcode(33024);
$zipcodes = $zipcode->near(15, false);

if($zipcode->hasError()){
    echo $zipcode->getError();
}

var_dump($zipcodes); // Array of Zipcodes within 15 mi of 33024, [33328, 33023, etc..]

按位置名称搜索 Zipcode

$zipcode = new Zipcode\Zipcode();
$zipcodes = $zipcode->search("Hollywood, FL");

if($zipcode->hasError()){
    echo $zipcode->getError();
}

var_dump($zipcodes); // Array of Zipcodes related to Hollywood, FL

获取两个 Zipcode 之间的距离

$zipcode = new Zipcode\Zipcode(33024);
$distance = $zipcode->distance(33328);

if($zipcode->hasError()){
    echo $zipcode->getError();
}

var_dump($distance); // Distance between 33024 and 33328

有关使用详情的更多信息，请参阅： zzipcode.com PHP 库