trebla/zipcode

There is no license information available for the latest version (v1.0.0) of this package.

Search for information regarding the zip code from somewhere in Brazil.

v1.0.0 2021-09-06 11:44 UTC

Requires

• php: ^7.2.5|^8.0
• guzzlehttp/guzzle: ^7.3

Requires (Dev)

• orchestra/testbench: ^4.0|^5.0|^6.0
• phpunit/phpunit: ^8.0|^9.0

Unknown License

README

A PHP library to search the address data for a given zip code.

Getting Started

Installation

Using Composer:

composer require trebla/zipcode

How to use

You can search for a zip code passing it as a parameter to find() method:

use Trebla\ZipCode\ZipCode;
use Trebla\ZipCode\Entities\ZipCodeEntity;

public function getAddress(string $zipcode): ZipCodeEntity
{
    return ZipCode::find($zipcode);
}

You also can choose the zip code service passing it as a parameter to find() method:

use Trebla\ZipCode\ZipCode;
use Trebla\ZipCode\Entities\ZipCodeEntity;
use Trebla\ZipCode\Helpers\ZipCodeHelper;

public function getAddress(string $zipcode): ZipCodeEntity
{
    return ZipCode::find($zipcode, ZipCodeHelper::VIA_CEP);
}

Services available

Service	Constant	Default
Pagar me	ZipCodeHelper::PAGAR_ME	X
Repúblic Virtual	ZipCodeHelper::REPUBLICA_VIRTUAL
Via CEP	ZipCodeHelper::VIA_CEP