Simple address and contact management for Laravel with automatically geocoding to add longitude and latitude

Chantouch Sek

Last update: Apr 4, 2022

Related tags

Laravel laravel-addresses

Overview

Laravel Addresses

Simple address and contact management for Laravel with automatically geocoding to add longitude and latitude.

Installation

Require the package from your composer.json file

"require": {
	"chantouch/laravel-addresses": "^1.0"
}

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

Configuration & Migration

$ php artisan vendor:publish --provider="Chantouch\Addresses\AddressesServiceProvider"

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

$ 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.

Usage

First, add our HasAddresses trait to your model.

 
namespace App\Models;

use Chantouch\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.

 
namespace App\Models;

use Chantouch\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 Chantouch\Addresses\Models\Address;

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

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

use Chantouch\Addresses\Models\Address;

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

use Chantouch\Addresses\Models\Contact;

$contact = Contact::find(1);

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

License

Licensed under MIT license.

Automatically load your helpers in your laravel application.

Laravel AutoHelpers Automatically load your helpers in your laravel application. Installation You can install the package via composer: composer requi

6 Jul 26, 2021

Automatically generate ERD Diagrams from Model's relations in Laravel

Laravel ERD Generator Automatically generate interactive ERD from Models relationships in Laravel. This package provides a CLI to automatically genera

90 Dec 29, 2022

Laravel Migrations Generator: Automatically generate your migrations from an existing database schema.

Laravel Migrations Generator Generate Laravel Migrations from an existing database, including indexes and foreign keys! This package is cloned from ht

1.4k Jan 1, 2023

Record created by, updated by and deleted by on Eloquent models automatically.

quarks/laravel-auditors Record created by, updated by and deleted by (if SoftDeletes added) on Eloquent models automatically. Installation composer re

3 Jun 13, 2022

Package to optimize your site automatically which results in a 35%+ optimization

Laravel Page Speed Simple package to minify HTML output on demand which results in a 35%+ optimization. Laravel Page Speed was created by Renato Marin

2.2k Dec 28, 2022

A tool to automatically fix PHP Coding Standards issues by Dragon Code.

The Dragon Code Styler Installation Required PHP: ^8.0 Composer: ^2.0 Locally composer global require dragon-code/codestyler Usage When you run the co

24 Aug 27, 2022

Easily add a full Laravel blog (with built in admin panel and public views) to your laravel project with this simple package.

Webdevetc BlogEtc - Complete Laravel Blog Package Quickly add a blog with admin panel to your existing Laravel project. It has everything included (ro

227 Dec 25, 2022

A simple way to add 301/302 redirects within CraftCMS.

Redirector plugin for Craft CMS 3.x A simple way to add 301/302 redirects within CraftCMS. This is the first CraftCMS plugin written by myself so plea

1 Nov 25, 2021

Laravel Breadcrumbs - An easy way to add breadcrumbs to your @Laravel app.

Introduction Breadcrumbs display a list of links indicating the position of the current page in the whole site hierarchy. For example, breadcrumbs lik

269 Dec 21, 2022