README

由http://viacep.com.br/提供的Web服务

演示

演示Artesãos ZipCode

快速入门

所需设置

在composer.json文件的require键中添加以下内容

"artesaos/zipcode": "dev-master"

运行Composer update命令

$ composer update

在您的config/app.php中，将'Artesaos\ZipCode\Providers\ZipCodeServiceProvider'添加到providers数组末尾

'providers' => array(
    ...,
    'Illuminate\Workbench\WorkbenchServiceProvider',
    'Artesaos\ZipCode\Providers\ZipCodeServiceProvider',

),

在config/app.php末尾添加'ZipCode' => 'Artesaos\ZipCode\Facade\ZipCode'到aliases数组中

'aliases' => array(
    ...,
    'View'       => 'Illuminate\Support\Facades\View',
    'ZipCode'    => 'Artesaos\ZipCode\Facades\ZipCode',

),

使用方法

使用非常简单，传递ZIP并调用各种类型的返回，如下所示

外观

添加命名空间

use Artesaos\ZipCode\Facades\ZipCode;

代码示例

$zipCodeInfo = ZipCode::find('01414-001');

辅助工具

$zipCodeInfo = zipcode('01414000');

注入

添加命名空间

use Artesaos\ZipCode\Contracts\ZipCodeContract;

代码示例

public function index(ZipCodeContract $zipcode)
{
      $zipCodeInfo = $zipcode->find('01414000');

特性

添加命名空间

use Artesaos\ZipCode\ZipCodeTrait;

代码示例

class WelcomeController extends Controller {

    use ZipCodeTrait;

    public function index()
    {
            $zipCodeInfo =  $this->zipcode('01414000');

使用总结

代码

$zipCodeInfo = ZipCode::find('01414000', false); //Facade
$zipCodeInfo = $zipcode->find('01414000', false); //Contracts
$zipCodeInfo = zipcode('01414000', false); // Helper
$zipCodeInfo = $this->zipcode('01414000', true); //Traist

返回

返回可以是null或类实例ZipCodeInfo（《Artesaos\ZipCode\ZipCodeInfo》）

ZipCodeInfo方法:

• Json => getJson()

if ($zipCodeInfo) 
{
    $zipCodeInfo->getJson();

    {
        "cep": "01414-001",
        "logradouro": "Rua Haddock Lobo",
        "bairro": "Cerqueira César",
        "localidade": "São Paulo",
        "uf": "SP",
        "ibge": "3550308", 
        "complemento": ""
    }
}

• Array => getArray()

if ($zipCodeInfo) 
{
    $zipCodeInfo->getArray();

    Array
    (
        [cep] => 01414-001
        [logradouro] => Rua Haddock Lobo
        [bairro] => Cerqueira César
        [localidade] => São Paulo
        [uf] => SP
        [ibge] => 3550308,
        [complemento] => 
    )
}

• Object => getObject()

if ($zipCodeInfo) 
{
    $zipCodeInfo->getObject();

    stdClass Object
    (
        [cep] => 01414-001
        [logradouro] => Rua Haddock Lobo
        [bairro] => Cerqueira César
        [localidade] => São Paulo
        [uf] => SP
        [ibge] => 3550308
        [complemento] => 
    )
}

从缓存中更新项目

$zipCodeInfo  = ZipCode::find('01414001', true);            
if ($zipCodeInfo) 
{
    $zipCodeInfo->getObject();

    stdClass Object
    (
        [cep] => 01414-001
        [logradouro] => Rua Haddock Lobo
        [bairro] => Cerqueira César
        [localidade] => São Paulo
        [uf] => SP
        [ibge] => 3550308
        [complemento] => 
    )
}