README

该项目旨在消费ViaCEP的webservice。使用PHP和CURL。

基于https://viacep.com.br/的webservice。通过这个类，可以查询并获取地址数据，返回格式为JSON、XML、PIPED和QWERT。

使用的库和技术

• PHP 7.2
• CURL

安装

通过composer

"andredebrito/phpviacep": "^1.0"

或者执行

composer require andredebrito/phpviacep

使用示例

通过CEP搜索

实例化一个新的PhpViaCep对象，并传入CEP作为参数，使用返回选项（json()、json_unicode()、xml()、piped()或querty()），调用fetch()方法（在下面的示例中使用了jsonToObject()方法将response转换为对象）。使用getResponse()方法显示数据。

对象返回

require '../vendor/autoload.php;

use AndreDeBrito\PHPViaCep\PhpViaCep;

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

var_dump($findByCep->getResponse());

XML返回

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

var_dump($findByCep->getResponse());

PIPED返回

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

var_dump($findByCep->getResponse());

QUERTY返回

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

var_dump($findByCep->getResponse());

通过地址搜索

实例化一个新的PhpViaCep对象，并传入州、城市和地址作为参数，使用返回选项（json()、json_unicode()或xml()），调用fetch()方法（在下面的示例中使用了jsonToObject()方法将response转换为对象）。使用getResponse()方法显示数据。

对象返回

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

use AndreDeBrito\PHPViaCep\PhpViaCep;

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

var_dump($findByAddress->getResponse());

XML返回

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

var_dump($findByAddress->getResponse());

错误处理

如果getResponse()方法的返回值为null，则使用getError()方法查看错误。

示例

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