A package for providing Philippines Address lookup API with Laravel.
- Via Composer
$ composer require yajra/laravel-address
If you are using Laravel 5.5+ then the steps below are optional.
- Register service provider
Yajra\Address\AddressServiceProvider::class
- Publish config
$ php artisan vendor:publish
address.prefix
To change the API base route.
address.middleware
Route middleware.
- Run the address migration.
php artisan migrate
- Run the address seeder.
php artisan db:seed --class=\\AddressSeeder
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}
.
Add address migration using $table->address()
. This will add the following fields:
- street
- barangay_id
- city_id
- province_id
- region_id
On your view, include @include('address::form', ['model' => $modelWithAddress])
Before the end of body tag, include @stack('scripts')
.
<body>
-- Contents Here ---
<script src="/vendor/jquery.js"></script>
@stack('scripts')
</body>
Just use Yajra\Address\HasAddress
trait on your model to load address models relationship.
use Yajra\Address\HasAddress;
class User extends Model {
use HasAddress;
}
Please see CHANGELOG for more information what has changed recently.
Please see CONTRIBUTING and CONDUCT for details.
If you discover any security related issues, please email aqangeles@gmail.com instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.