Skip to content

billbarsch/viaCEP-PHP

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

viaCEP PHP

GitHub license GitHub issues GitHub forks GitHub stars Twitter

Faça busca por endereços do Brasil utilizando o ViaCEP REST API.

Instalação

Via Composer

$ composer require josenildols/viacep-php

Como instanciar

use JosenildoLS\viaCEP;

$cep = new viaCEP();
$cep->find('01001-000');

Retorno em Array

$array = $cep->toArray();

/*
O resultado deverá ser algo assim:

Array
(
    [cep] => 01001-000
    [logradouro] => Praça da Sé
    [complemento] => lado ímpar
    [bairro] => Sé
    [localidade] => São Paulo
    [uf] => SP
    [unidade] =>
    [ibge] => 3550308
    [gia] => 1004
)

*/

Retorno JSON

$json = $cep->toJson();

/*
O resultado deverá ser algo assim:

{
    cep: "01001-000",
    logradouro: "Praça da Sé",
    complemento: "lado ímpar",
    bairro: "Sé",
    localidade: "São Paulo",
    uf: "SP",
    unidade: "",
    ibge: "3550308",
    gia: "1004"
}
*/

Retorno Piped

$piped = $cep->toPiped();

/*
O resultado deverá ser algo assim:

cep:01001-000|logradouro:Praça da Sé|complemento:lado ímpar|bairro:Sé|localidade:São Paulo|uf:SP|unidade:|ibge:3550308|gia:1004
*/

Retorno Querty

$querty = $cep->toQuerty();

/*
O resultado deverá ser algo assim:

cep=01001-000&logradouro=Pra%C3%A7a+da+S%C3%A9&complemento=lado+%C3%ADmpar&bairro=S%C3%A9&localidade=S%C3%A3o+Paulo&uf=SP&unidade=&ibge=3550308&gia=1004
*/

Salvar em .XML

$cep->toXML("nome_da_pasta");

/*
O resultado deverá ser algo assim, devo ressaltar que o nome_da_pasta é opcional:

<?xml version="1.0" encoding="UTF-8"?>
<xmlcep>
	<cep>01001-000</cep>
	<logradouro>Praça da Sé</logradouro>
	<complemento>lado ímpar</complemento>
	<bairro>Sé</bairro>
	<localidade>São Paulo</localidade>
	<uf>SP</uf>
	<unidade></unidade>
	<ibge>3550308</ibge>
	<gia>1004</gia>
</xmlcep>

*/

Salvar em .CSV

$cep->toCSV("nome_da_pasta");

/*
O resultado deverá ser algo assim, devo ressaltar que o nome_da_pastaé opcional:

cep,logradouro,complemento,bairro,localidade,uf,unidade,ibge,gia
01001-000,Praça da Sé,lado ímpar,Sé,São Paulo,SP,,3550308,1004

*/

Licença

Sobre a licença MIT (MIT). Por favor, veja License File para mais informações.

Packages

No packages published

Languages

  • PHP 100.0%