2017 © Pedro Peláez
 

library cep

CEP do Brasil

image

canducci/cep

CEP do Brasil

  • Monday, November 13, 2017
  • by netdragoon
  • Repository
  • 1 Watchers
  • 5 Stars
  • 10,963 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 2 Forks
  • 0 Open issues
  • 9 Versions
  • 3 % Grown

The README.md

Canducci Cep

CEP do Brazil - Web Service https://www.viacep.com.br, (*1)

Version Downloads PHP Composer License, (*2)

Versão de configuração V2 - clique aqui, (*3)

Instalação do Pacote

composer require canducci/cep

Configuração

1) Laravel

Se você utiliza o Framework Laravel segue logo abaixo as confgurações após a instalação., (*4)

  1. Entre na pasta app/config no arquivo app.php.
  2. No arquivo procure o array providers
  3. Entre com o provider no final da lista como exemplo:, (*5)

    'providers' => [
       ...
       Canducci\Cep\Providers\CepServiceProvider::class
    ]
    
    
  4. Dentro do mesmo arquivo (app.php) configure os apelidos (Facades) como exemplo:, (*6)

    'aliases' => [
       ...
       'Cep' => Canducci\Cep\Facades\Cep::class,
       'Endereco' => Canducci\Cep\Facades\Endereco::class
    ]
    
    
  5. Como utilizar?, (*7)

    5.1 Com Injeção de Dependencia:, (*8)

    Route::get('/cep', function(\Canducci\Cep\Cep $cep){
       $cepResponse = $cep->find('01010000');
       $data = $cepResponse->getCepModel();
       return response()->json($data);
    });
    
    Route::get('/endereco', function(\Canducci\Cep\Endereco $endereco){
       $enderecoResponse = $endereco->find('sp','são paulo', 'ave');
       $data = $enderecoResponse->getCepModels();
       return response()->json($data);
    });
    

    5.2 Com Facade Laravel:, (*9)

    Route::get('/cep', function(){
      $cepResponse = \Canducci\Cep\Facades\Cep::find('01010000');
      $data = $cepResponse->getCepModel();
      return response()->json($data);
    });
    
    Route::get('/endereco', function(){
      $enderecoResponse = \Canducci\Cep\Facades\Endereco::find('sp','são paulo', 'ave');
      $data = $enderecoResponse->getCepModels();
      return response()->json($data);
    });
    

    5.3 Com function (função), (*10)

    Route::get('/cep', function(){
      $cepResponse = cep('01010000');
      $data = $cepResponse->getCepModel();
      return response()->json($data);
    });
    
    Route::get('/endereco', function(){
       $enderecoResponse = endereco('sp','são paulo','ave');
       $data = $enderecoResponse->getCepModels();
       return response()->json($data);
    });
    
  6. Resposta satisfatória:, (*11)

    6.1 - Utilize o método isOk() para verificar se realmente os dados foram recebidos:, (*12)

    $cepResponse = cep('01010000');
    if ($cepResponse->isOk())
    {
       $data = $cepResponse->getCepModel();
       return response()->json($data);
    }
    

    e os dados são recuperados pelos metodos ou propriedades, exemplo:, (*13)

    $model->getCep() ou $model->cep
    $model->getLogradouro() ou $model->logradouro
    $model->getComplemento() ou $model->c omplemento
    $model->getBairro() ou $model->bairro
    $model->getLocalidade() ou $m odel->localidade
    $model->getUf() ou $model->uf
    $model->getDdd() ou $model->ddd
    $model->getSiafi() ou $model->siafi
    $model->getIbge() ou $model->ibge
    $model->getGia() ou $model->gia
    $model->getUnidade() ou $model->unidade
    $model->getEstado() ou $model->estado
    $model->getRegiao() ou $model->regiao
    

    6.2 - Dados informados errados, (*14)

    6.2.1 - No Cep o valor informado deve possuir um desses formatos:, (*15)

  • 01010000, ou
  • 01010-000, (*16)

    para uma resposta satisfatória, se não um exceção será lançada., (*17)

    6.2.2 - No Endereco os valores informados segue essas regras, (*18)

  • Uf com 2 letras, (*19)

  • Cidade com no minimo 3 letras
  • Logradouro com no minimo 3 letras, (*20)

    se não uma exceção será lançada., (*21)

2) Qualquer código que usa o composer.phar:
λ php composer.phar require canducci/cep

logo após isso, inclua no seu código o autoload.php que está dentro da pasta vendor, exemplo:, (*22)

<?php

  require_once 'vendor/autoload.php';

  $cepResponse = cep('01010000');
  $data = $cepResponse->getCepModel();
  echo json_encode($data);

The Versions

13/11 2017

dev-master

9999999-dev https://github.com/netdragoon/canduccicep

CEP do Brasil

  Sources   Download

MIT

The Requires

  • php >=5.3.0
  • ext-fileinfo *

 

The Development Requires

by Avatar netdragoon

laravel cep

13/11 2017

v2.0.2

2.0.2.0 https://github.com/netdragoon/canduccicep

CEP do Brasil

  Sources   Download

MIT

The Requires

  • php >=5.3.0
  • ext-fileinfo *

 

The Development Requires

by Avatar netdragoon

laravel cep

20/12 2016

v2.0.1

2.0.1.0 https://github.com/netdragoon/canduccicep

CEP do Brasil

  Sources   Download

MIT

The Requires

  • php >=5.3.0
  • ext-fileinfo *

 

The Development Requires

by Avatar netdragoon

laravel cep

10/12 2015

v2.0.0

2.0.0.0 https://github.com/netdragoon/canduccicep

CEP do Brasil

  Sources   Download

MIT

The Requires

  • php >=5.3.0
  • ext-fileinfo *

 

The Development Requires

by Avatar netdragoon

laravel cep

17/11 2015

v1.0.1

1.0.1.0 https://github.com/netdragoon/canduccicep

Laravel CEP (Zip Code)

  Sources   Download

MIT

The Requires

  • php >=5.3.0
  • ext-fileinfo *

 

The Development Requires

by Avatar netdragoon

laravel cep

28/10 2015

dev-oldversions

dev-oldversions https://github.com/diasfulvio/cep

Laravel CEP (Zip Code)

  Sources   Download

MIT

The Requires

  • php >=5.3.0
  • ext-fileinfo *

 

by Fúlvio Cezar Canducci Dias

laravel cep

28/10 2015

0.0.1

0.0.1.0 https://github.com/diasfulvio/cep

Laravel CEP (Zip Code)

  Sources   Download

MIT

The Requires

  • php >=5.3.0
  • ext-fileinfo *

 

by Fúlvio Cezar Canducci Dias

laravel cep

28/10 2015

v0.1.0

0.1.0.0 https://github.com/diasfulvio/cep

Laravel CEP (Zip Code)

  Sources   Download

MIT

The Requires

  • php >=5.3.0
  • ext-fileinfo *

 

by Fúlvio Cezar Canducci Dias

laravel cep

17/10 2015

v1.0.0

1.0.0.0 https://github.com/netdragoon/canduccicep

Laravel CEP (Zip Code)

  Sources   Download

MIT

The Requires

  • php >=5.3.0
  • ext-fileinfo *

 

by Avatar netdragoon

laravel cep