ernandesrs/viacep

一个用于使用ViaCEP API的简单组件。

1.0 2023-06-16 13:36 UTC

This package is auto-updated.

Last update: 2024-09-16 18:04:53 UTC


README

一个用于使用ViaCEP API的PHP组件。该项目也是为了研究和在Packagist上分享PHP组件而创建的。

安装

composer require ernandesrs/viacep

使用

以下是一些使用示例,如果您愿意,可以查看 app/test 文件夹。

查询一个CEP

所有输入的CEP都会自动验证,如果CEP无效,将返回 null

<?php

use ErnandesRS\ViaCEP\ViaCEP;

require __DIR__ . "/../../vendor/autoload.php";

/**
 * Consultando um CEP válido
 */
echo "Consultando CEP válido\n";
$cep = ViaCEP::consultarCep("01001000");
print_r($cep);

/**
 * Consultando um CEP válido
 */
echo "Consultando CEP válido\n";
$cep = ViaCEP::consultarCep("01001-000");
print_r($cep);

获取一个CEP

所有值(UF,城市,街道)都会自动验证,如果任何一个值无效,将返回 null

- UF: deve possuir 2 caracteres apenas;
- Cidade: deve possuir no mínimo 3 caracteres e
- Logradouro: deve possuir no mínimo 3 caracteres
<?php

use ErnandesRS\ViaCEP\ViaCEP;

require __DIR__ . "/../../vendor/autoload.php";

/**
 * Obtendo um CEP
 */
echo "Obtendo um CEP com endereço\n";
$cep = ViaCEP::obterCep("MS", "Dourados", "Weimar Torres");
print_r($cep);

需求

- PHP 8 ou superior.