yajra/laravel-address
Philippines Address Lookup for Laravel
Requires Laravel 13+
A package for providing Philippines Address lookup API with Laravel.
Version Compatibility
| Laravel | Package |
|---|---|
| 11.x | 11.x |
| 12.x | 12.x |
| 13.x | 13.x |
Installation
composer require yajra/laravel-address
Register service provider (Optional on Laravel 5.5+)
Yajra\Address\AddressServiceProvider::class
Publish config (Optional)
php artisan vendor:publish
Available Config
address.prefix To change the API base route.
address.middleware Route middleware.
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').
<body>
-- Contents Here ---
<script src="/vendor/jquery.js"></script>
@stack('scripts')
</body>
Model with Address Integration
Just use Yajra\Address\HasAddress trait on your model to load address models relationship.
use Yajra\Address\HasAddress;
class User extends Model {
use HasAddress;
}
Change log
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING and CONDUCT for details.
Security
If you discover any security related issues, please email aqangeles@gmail.com instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.