README

Laravel Addresses

Simple address and contact management for Laravel with automatical geocoding to add longitude and latitude. Uses the famous Countries package by Webpatser.

Installation

Require the package from your composer.json file

"require": {
	"adiazm/laravel-addresses": "^1.2"
}

and run composer update or both in one with composer require adiazm/laravel-addresses.

Configuration & Migration

php artisan vendor:publish --provider="Admsys\Countries\CountriesServiceProvider"
php artisan vendor:publish --provider="Adiazm\Addresses\AddressesServiceProvider"

This will publish a config/countries.php, a config/address-config.php and some migration files, that you'll have to run:

php artisan countries:migration
php artisan migrate

For migrations to be properly published ensure that you have added the directory database/migrations to the classmap in your projects composer.json.

Check out Webpatser\Countries readme to see how to seed their countries data to your database.

Usage

First, add our HasAddresses trait to your model.

<?php namespace App\Models;

use Adiazm\Addresses\Traits\HasAddresses;
use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    use HasAddresses;

    // ...
}
?>

Add an Address to a Model

$post = Post::find(1);
$post->addAddress([
    'street'     => '123 Example Drive',
    'city'       => 'Vienna',
    'post_code'  => '1110',
    'country'    => 'AT', // ISO-3166-2 or ISO-3166-3 country code
    'is_primary' => true, // optional flag
]);

Alternativly you could do...

$address = [
    'street'     => '123 Example Drive',
    'city'       => 'Vienna',
    'post_code'  => '1110',
    'country'    => 'AT', // ISO-3166-2 or ISO-3166-3 country code
    'is_primary' => true, // optional flag
];
$post->addAddress($address);

Available attributes are street, street_extra, city, post_code, state, country, state, notes (for internal use). You can also use custom flags like is_primary, is_billing & is_shipping. Optionally you could also pass lng and lat, in case you deactivated the included geocoding functionality and want to add them yourself.

Check if Model has Addresses

if ($post->hasAddresses()) {
    // Do something
}

Get all Addresses for a Model

$addresses = $post->addresses()->get();

Get primary/billing/shipping Addresses

$address = $post->getPrimaryAddress();
$address = $post->getBillingAddress();
$address = $post->getShippingAddress();

Update an Address for a Model

$address = $post->addresses()->first(); // fetch the address

$post->updateAddress($address, $new_attributes);

Delete an Address from a Model

$address = $post->addresses()->first(); // fetch the address

$post->deleteAddress($address); // delete by passing it as argument

Delete all Addresses from a Model

$post->flushAddresses();

Contacts

First, add our HasContacts trait to your model.

<?php namespace App\Models;

use Adiazm\Addresses\Traits\HasContacts;
use Illuminate\Database\Eloquent\Model;

class Team extends Model
{
    use HasContacts;

    // ...
}
?>

Add a Contact to a Model

$post = Team::find(1);
$post->addContact([
    'first_name' => 'Alex',
    'website'    => 'https://twitter.com/AMPoellmann',
    'is_primary' => true, // optional flag
]);

Relate Addresses with Contacts

Above all, addresses and contacts can be connected with an optional One To Many relationship. Like so you could assign multiple contacts to an address and retrieve them like so:

use Adiazm\Addresses\Models\Address;

$address = Address::find(1);
$contacts = $address->contacts;

foreach ($contacts as $contact) {
    //
}

use Adiazm\Addresses\Models\Address;

$contact = Address::find(1)
                  ->contacts()
                  ->first();

use Adiazm\Addresses\Models\Contact;

$contact = Contact::find(1);

return $contact->address->getHtml();

Changelog

[2021-02-02] v1.0 The geocode configuration option now defaults to false.
[2022-05-16] v1.1 Updated dependencies to PHP 8 and Laravel 8/9 - for older versions please refer to v1.0.

License

Licensed under MIT license.

Author

Handcrafted with love by Alexander Manfred Poellmann in Vienna & Rome.

adiazm / laravel-addresses

Maintainers

Details