Download the PHP package yomo/addressfactory without Composer
On this page you can find all versions of the php package yomo/addressfactory. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download yomo/addressfactory
More information about yomo/addressfactory
Files in yomo/addressfactory
Package addressfactory
Short Description Creates real-world street addresses from Google Maps, to use in database seeding, unit tests, or anything else. Supports Laravel 5+, and Faker
License MIT
Homepage https://github.com/nonsapiens/addressfactory
Informations about the package addressfactory
NOTE: This package is for legacy Laravel only! Please use the newer RealAddressFactory for more recent Laravel versions!
RealAddress Generator
About
This Laravel 5 library creates actual, 100% real addresses, with full address details and lat/long coordinates Using the Google Maps API, these addresses can be created using the RealAddress classes, and also supports Faker, so you can use RealAddress in your database seeding!
Installation
Require this package with composer using the following command:
Laravel 7 or higher
Please use the updated package, RealAddressFactory. This specific package is for legacy Laravel only!
Laravel 5.5 or higher
Execute:
Laravel 5.4 or lower
If you are running Laravel 5.4 and below, you need to add the service provider to the providers
array in config/app.php
Then execute:
Google Maps API
As this library relies on Google Maps, your Google Maps API key needs to be defined in your .env
file:
If you don't have an API key (they're free), get one here
Usage
RealAddress offers three different ways of generating real-world addresses. Each of these methods return the \Geocoder\Provider\GoogleMaps\Model\GoogleAddress
class, which takes the Google Maps API response and standardises it in an easy-to-use, easy-to-read manner.
As standard, RealAddress supports the generating of real addresses for the following countries:
- United States of America
- Great Britain
- France
- Germany
- South Africa
- Russia
You can extend RealAddress by adding additional countries in the config/realaddress.php
config file. This config file also defines which cities in a given country addresses can be created for. Additional cities can be defined here.
Faker
RealAddress provides additional functions for Faker's \Faker\Generator
class instance. The code example below shows typical usage in a Factory class:
Similarly, the address can be limited to a specific city: $address = $faker->britishAddress('London');
or can be generated randomly between multiple-defined cities: $address = $faker->britishAddress(['London', 'Manchester']);
... where these cities must be defined in config/realaddress.php
in order to work.
The ready-to-use faker functions include:
britishAddress()
usaAddress()
germanAddress()
frenchAddress()
southAfricanAddress()
russianAddress()
If you have extended config/realaddress.php
to include a new country, you can generate an address for it with:
Using the Facade
Using the Facade allows you to generate real-world addresses at runtime, and also allows multiple addresses to be generated at once. The code examples below show typical RealAddress facade usage:
Using the RealAddress class
Functionally, provides the same methods as the Facade above:
Adding new countries or cities
An example of extending the config/realaddress.php
array to include Kenya, and two cities:
Note that the cities defined here must be identifiable to Google Maps, and should ideally be spelt in their English variant.
About the author
Stuart Steedman is the head of development at Yonder Media, a South African digital media agency operating out of Pretoria. He specialises in PHP and Laravel development, and is a speaker at tech and development related conferences.