andredebrito/phpviacep

Componente PHP para consumo da API VIA CEP (https://viacep.com.br/)

1.0.5 2020-06-12 00:48 UTC

Requires

• php: ^7.2
• ext-curl: *
• ext-json: *

Requires (Dev)

• phpunit/phpunit: ^7

MIT

• Andre de Brito

• php
• viacep
• consulta cep

README

Este projeto tem por objetivo consumir o webservice ViaCEP. Utilizando o PHP e CURL.

Baseado no webservice https://viacep.com.br/. Através dessa classe é possível consultar e obter dados de endereços com retorno nos formatos JSON, XML, PIPED e QWERT.

Bibliotecas e tecnlogias utiladas

• PHP 7.2
• CURL

Instalação

Via composer:

"andredebrito/phpviacep": "^1.0"

ou execute:

composer require andredebrito/phpviacep

Exemplos de utilização

Pesquisa por CEP

Instancie um novo objeto da classe PhpViaCep e invoque o método findByCep() passando o CEP como parâmentro, utilize uma opção de retorno (json(), json_unicode(), xml(), piped() ou querty()), invoque o método fetch() (no exemplo abaixo foi utilizado o método jsonToObject() para tornar o response e um objeto). Utilize o método getResponse() para exibir os dados.

Retorno em Objeto

require '../vendor/autoload.php;

use AndreDeBrito\PHPViaCep\PhpViaCep;

$findByCep = (new PhpViaCep())->findByCep("01001000")
	      ->json()->fetch()
	      ->jsonToObject();

var_dump($findByCep->getResponse());

Retorno em XML:

$findByCep = (new PhpViaCep())->findByCep("01001000")
	      ->xml()
	      ->fetch();

var_dump($findByCep->getResponse());

Retorno em PIPED:

$findByCep = (new PhpViaCep())->findByCep("01001000")
	      ->piped()
	      ->fetch();

var_dump($findByCep->getResponse());

Retorno em QUERTY:

$findByCep = (new PhpViaCep())->findByCep("01001000")
	      ->querty()
	      ->fetch();

var_dump($findByCep->getResponse());

Pesquisa por Endereço

Instancie um novo objeto da classe PhpViaCep e invoque o método findByAddress() passando UF, Cidade e Endereço como parâmentros, utilize uma opção de retorno (json(), json_unicode() ou xml()), invoque o método fetch() (no exemplo abaixo foi utilizado o método jsonToObject() para tornar o response e um objeto). Utilize o método getResponse() para exibir os dados.

Retorno em Objeto

require '../vendor/autoload.php';

use AndreDeBrito\PHPViaCep\PhpViaCep;

$findByAddress = (new PhpViaCep())->findByAddress("SP", "Poá", "Avenida Brasil")
		  ->json()
		  ->fetch()
		  ->jsonToObject();

var_dump($findByAddress->getResponse());

Retorno em XML

$findByAddress = (new PhpViaCep())->findByAddress("SP", "Poá", "Avenida Brasil")
		  ->xml()
		  ->fetch();

var_dump($findByAddress->getResponse());

Tratamento de Erros

Caso o retorno do método getResponse() seja null utilize o método getError() para visualizar o erro.

Exemplo

if($findByAddress->getError()){
    echo $findByAddress->getError();
}