predicthq / address-formatter
Address formatter using country templates from https://github.com/OpenCageData/address-formatting
Installs: 156 452
Dependents: 0
Suggesters: 0
Security: 0
Stars: 28
Watchers: 13
Forks: 7
Open Issues: 4
Requires
- php: >=5.6.0
- mustache/mustache: ~2.0
- predicthq/address-formatter-templates: ~1.0
- symfony/yaml: ^3.0 || ^4.0
Requires (Dev)
- phpunit/phpunit: ^5.3
- satooshi/php-coveralls: ^1.0
This package is not auto-updated.
Last update: 2020-08-19 07:04:19 UTC
README
This library uses the address templates from https://github.com/OpenCageData/address-formatting to format addresses differently depending on the country.
Installation
Install the latest version with
$ composer require predicthq/address-formatter
Examples
You can use either the Address
object or provide an array of address parts.
use PredictHQ\AddressFormatter\Address; $a = new Address(); $a->setCity('Wellington') ->setCountry('New Zealand') ->setCountryCode('NZ') ->setCounty('Wellington City') ->setHouseNumber(53) ->setPostcode(6011) ->setRoad('Pirie Street') ->setState('Wellington') ->setSuburb('Mount Victoria'); $text = $a->format(); /** * Will display as: * * 53 Pirie Street * Mount Victoria * Wellington 6011 * New Zealand */ echo $text;
Or, pass an array of address parts to the Formatter
.
use PredictHQ\AddressFormatter\Formatter; $address = [ 'city' => 'Wellington', 'country' => 'New Zealand', 'country_code' => 'NZ', 'county' => 'Wellington City', 'house_number' => 53, 'postcode' => 6011, 'road' => 'Pirie Street', 'state' => 'Wellington', 'suburb' => 'Mount Victoria', ]; /** * Will display as: * * 53 Pirie Street * Mount Victoria * Wellington 6011 * New Zealand */ $f = new Formatter(); $actual = $f->formatArray($address);
Tests
Run tests using ./vendor/bin/phpunit