chuckcms/laravel-addresses

A ChuckCMS module for storing addresses.

v0.1.1 2022-06-11 14:26 UTC

This package is auto-updated.

Last update: 2023-01-11 15:48:30 UTC


README

Latest Version on Packagist Scrutinizer Code Quality StyleCI Total Downloads

An easy way to manage addresses for Eloquent models in Laravel. Inspired by the following packages:

Installation

Require the package by running

composer require chuckcms/laravel-addresses

Publish configuration and migration

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

This command will publish a config/addresses.php and a migration file.

You can modify the default fields and their rules by changing both of these files.

After publishing you can run the migrations

php artisan migrate

Usage

You can use the HasAddresses trait on any model.

<?php

namespace App\Models;

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

class Post extends Model
{
    use HasAddresses;

    // ...
} 

After doing this you can use the following methods.

Add an address to a model

$post = Post::first();
$post->addAddress([
	'label' 				=> 'My address', // required
	'street' 				=> 'Main Street', // defaults to: null
	'housenumber' 				=> '100', // defaults to: null
	'housenumber_postfix' 			=> 'B1', // defaults to: null
	'postal_code'				=> '10001', // defaults to: null
	'city'					=> 'Chuck City', // defaults to: null
	'state'					=> 'New Chuck State', // defaults to: null
	'country'				=> 'Chuckland', // defaults to: null
	'latitude'				=> 51.13128, // defaults to: null
	'longitude'				=> 4.57041, // defaults to: null
	'is_primary'				=> true, // defaults to: false
	'is_billing'				=> false, // defaults to: false
	'is_shipping'				=> false, // defaults to: false
]);

Update an existing address

$post = Post::first();
$address = $post->getPrimaryAddress();

$post->updateAddress($address, ['label' => 'My new address']);

Delete an address from a model

$post = Post::first();
$address = $post->addresses()->first();

if ($post->deleteAddress($address)) {
	//do something
}

Determine if a model has any addresses

$post = Post::first();

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

Determine if a model has (one of) the given address(es).

use Chuckcms\Addresses\Models\Address;

$post = Post::find();
$address = Address::first();

if ($post->hasAddress($address)) {
	//do something
}

//OR
if ($post->hasAddress($address->id)) {
	//do something
}

//OR
$addresses = Address::where('city', 'Chuck City')->get();
if ($post->hasAddress($addresses)) {
	//do something
}

//OR
$addresses = Address::where('state', 'New Chuck State')->pluck('id')->toArray();
if ($post->hasAddress($addresses)) {
	//do something
}

This will return true when one of the given addresses belongs to the model.

Getters

You can use the following methods to retrieve addresses and certain attributes.

Get the primary address of the model.

$post = Post::first();

$primaryAddress = $post->getPrimaryAddress();

Get the billing address of the model.

$post = Post::first();

$billingAddress = $post->getBillingAddress();

Get the shipping address of the model.

$post = Post::first();

$shippingAddress = $post->getShippingAddress();

Get the labels of all addresses of the model.

$post = Post::first();

$labels = $post->getAddressLabels();

License

Licensed under MIT license.

Author

Written by Karel Brijs in Antwerp.