torann / address-format
A PHP library to parse street addresses to localized formats
Installs: 3 745
Dependents: 0
Suggesters: 0
Security: 0
Stars: 5
Watchers: 4
Forks: 1
Open Issues: 0
Requires
- php: >=5.5.9
Requires (Dev)
- phpunit/phpunit: ^4.8
This package is auto-updated.
Last update: 2024-10-22 16:17:29 UTC
README
A PHP library to parse street addresses to localized formats. The address formats are based on the formats supplied by Google's libaddressinput.
Installation
Composer
From the command line run:
$ composer require torann/address-format
Usage
Formatting
format(array $data, $html = false)
Arguments:
$data
- An array of address elements$html
- When set to true the address elements will be wrapped withspan
tags.
NOTE: The wrapping span tags contain itemprop attributes that adhere to the PostalAddress schema.
Usage:
$address = \Torann\AddressFormat\Address::format([ 'recipient' => 'Jane Doe', 'organization' => 'Whitworth Institute Inc.', 'street_address' => '20341 Whitworth Institute', 'street_address_2' => '405 N. Whitworth', 'locality' => 'Seattle', 'admin_area' => 'WA', 'postal_code' => '98052', 'country_iso' => 'US', ]);
The above code will produce the following:
Jane Doe
Whitworth Institute Inc.
20341 Whitworth Institute
405 N. Whitworth
Seattle, WA 98052
NOTE: The
country_iso
attribute is used to determine the address's format. The default is set to US.
Custom Country Formats
This allows you to set your own formats.
setFormats(array $countries)
Arguments:
$countries
- An array of country ISO codes and corresponding formats values.
Usage:
\Torann\AddressFormat\Address::setFormats([ 'GB' => '%N%n%O%n%A%n%C%n%Z %R', 'US' => '%N%n%O%n%A%n%C, %S %Z %R', ]);
Available Attributes
Change Log
v1.0.0
- First release