2017 © Pedro Peláez
 

library laravel-address

Philippines Address Lookup API for Laravel.

image

yajra/laravel-address

Philippines Address Lookup API for Laravel.

  • Thursday, June 7, 2018
  • by yajra
  • Repository
  • 2 Watchers
  • 2 Stars
  • 17 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 1 Forks
  • 0 Open issues
  • 5 Versions
  • 0 % Grown

The README.md

Philippines Address Lookup for Laravel

Latest Version on Packagist Continuous Integration Static Analysis Quality Score ![Total Downloads][ico-downloads] ![Software License][ico-license], (*1)

A package for providing Philippines Address lookup API with Laravel., (*2)

Installation

``` bash composer require yajra/laravel-address, (*3)


### Register service provider (Optional on Laravel 5.5+)

```php
Yajra\Address\AddressServiceProvider::class

Publish config (Optional)

php artisan vendor:publish

Available Config

address.prefix To change the API base route., (*4)

address.middleware Route middleware., (*5)

Required Setup (Migration and Seeder)

  • Run the address migration. 
php artisan migrate
  • Run the address seeder. 
php artisan db:seed Yajra\\Address\\Seeders\\AddressSeeder
````

## Routes

The default prefix for the api routes is `/api/address`. The default can be updated via config `address.php` file.

- Get All Regions `/api/address/regions`.
- Get All Provinces `/api/address/provinces`.
- Get Provinces By Region `/api/address/provinces/{regionId}`.
- Get Cities By Province `/api/address/cities/{provinceId}`.
- Get Barangays By City `/api/address/barangays/{cityId}`.

## Usage / Examples

### Add address migration

Add address migration using `$table->address()`. This will add the following fields:
- street
- barangay_id
- city_id
- province_id
- region_id

### Include built-in form (Requires jQuery)

On your view, include `@include('address::form', ['model' => $modelWithAddress])`

### Add scripts section on your master layout.

Before the end of body tag, include `@stack('scripts')`.

```php
<body>
-- Contents Here ---


@stack('scripts')
</body>

Model with Address Integration

Just use Yajra\Address\HasAddress trait on your model to load address models relationship., (*6)

use Yajra\Address\HasAddress;

class User extends Model {
    use HasAddress;
}

Change log

Please see CHANGELOG for more information what has changed recently., (*7)

Contributing

Please see CONTRIBUTING and CONDUCT for details., (*8)

Security

If you discover any security related issues, please email aqangeles@gmail.com instead of using the issue tracker., (*9)

Credits

License

The MIT License (MIT). Please see License File for more information., (*10)

The Versions

07/06 2018

dev-master

9999999-dev https://github.com/yajra/laravel-address

Philippines Address Lookup API for Laravel.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Arjay Angeles

laravel address yajra

07/06 2018

v0.1.3

0.1.3.0 https://github.com/yajra/laravel-address

Philippines Address Lookup API for Laravel.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Arjay Angeles

laravel address yajra

07/06 2018

v0.1.2

0.1.2.0 https://github.com/yajra/laravel-address

Philippines Address Lookup API for Laravel.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Arjay Angeles

laravel address yajra

07/06 2018

v0.1.1

0.1.1.0 https://github.com/yajra/laravel-address

Philippines Address Lookup API for Laravel.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Arjay Angeles

laravel address yajra

07/06 2018

v0.1.0

0.1.0.0 https://github.com/yajra/laravel-address

Philippines Address Lookup API for Laravel.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Arjay Angeles

laravel address yajra