kseven/phpviacep

ViaCEP PHP SDK

v1.0.1 2023-02-15 02:28 UTC

Requires

• php: ^7.4 || ^8.0
• ext-json: *
• guzzlehttp/guzzle: ~6.2

Requires (Dev)

• codeclimate/php-test-reporter: 0.3.*
• phpunit/phpunit: ~4.0||~5.0
• squizlabs/php_codesniffer: ~2.3

MIT

• KSeven

• address
• zipcode
• brazil
• cep
• viacep
• enderecos
• kSeven

README

Pesquise endereços por CEP usando a API REST ViaCEP.

Instalar

Via Composer

$ composer require kseven/phpviacep

Uso

findByZipCode (Sem retorno de chamada)

Encontre o endereço pelo código postal.

use KSeven\ViaCEP\VCRun AS ViaCEP;

$ViaCEP = new ViaCEP;

$Address = $ViaCEP->findByZipCode('01001-000')->toArray();

/*
Deve retornar algo assim:

[
    'zipCode' => '01001-000',
    'street' => 'Praça da Sé',
    'complement' => 'lado ímpar',
    'neighborhood' => 'Sé',
    'city' => 'São Paulo',
    'state' => 'SP',
    'ibge' => '3550308',
]
*/

$Address = $ViaCEP->findByZipCode('01001-000')->toJson();

/*
Deve retornar algo assim:

{
    "zipCode": "01001-000",
    "street": "Praça da Sé",
    "complement": "lado ímpar",
    "neighborhood": "Sé",
    "city": "São Paulo",
    "state": "SP",
    "ibge": "3550308"
}
*/

findByZipCode (Com retorno de chamada)

Encontre o endereço por código postal, com retorno de chamada.

use KSeven\ViaCEP\VCRun AS ViaCEP;

$ViaCEP = new ViaCEP;

$Address = $ViaCEP->findByZipCode('01001-000', 'callback_name')->withCallback();

/*
Deve retornar algo assim:

callback_name({
    "cep": "01001-000",
    "logradouro": "Praça da Sé",
    "complemento": "lado ímpar",
    "bairro": "Sé",
    "localidade": "São Paulo",
    "uf": "SP",
    "ibge": "3550308",
    "gia": "1004",
    "ddd": "11",
    "siafi": "7107"
});
*/

findByStreetName

Pesquise endereços usando estado, cidade e nome de uma rua.

use KSeven\ViaCEP\VCRun AS ViaCEP;

$ViaCEP = new ViaCEP;

$Addresses = $ViaCEP->findByStreetName('SP', 'São Paulo', 'Gomes de Carvalho');

/*
Deve retornar algo assim:

[
    [
        'zipCode' => '01001-000',
        'street' => 'Praça da Sé',
        'complement' => 'lado ímpar',
        'neighborhood' => 'Sé',
        'city' => 'São Paulo',
        'state' => 'SP',
        'ibge' => '3550308',
    ],
    [
        'zipCode' => '01001-000',
        'street' => 'Praça da Sé',
        'complement' => 'lado ímpar',
        'neighborhood' => 'Sé',
        'city' => 'São Paulo',
        'state' => 'SP',
        'ibge' => '3550308',
    ]
]
*/

Registo de alterações

Consulte CHANGELOG para obter mais informações sobre o que mudou recentemente.

Contribuindos

Consulte CONTRIBUINDO e CONDUTA para obter detalhes.

Segurança

Se você descobrir algum problema relacionado à segurança, envie um e-mail para [e-mail] em vez de usar o rastreador de problemas.

Credits

• K'Seven
• All Contributors

Licença

A licença MIT (MIT). Consulte Arquivo de licença para obter mais informações..