Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alimranahmed/bdlocation
A PHP interface to access Locations of Bangladesh
https://github.com/alimranahmed/bdlocation
bangladesh-location composer php7
Last synced: 3 months ago
JSON representation
A PHP interface to access Locations of Bangladesh
- Host: GitHub
- URL: https://github.com/alimranahmed/bdlocation
- Owner: alimranahmed
- License: mit
- Created: 2018-02-11T18:59:59.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-06-24T18:05:05.000Z (over 5 years ago)
- Last Synced: 2024-11-07T23:05:47.706Z (3 months ago)
- Topics: bangladesh-location, composer, php7
- Language: PHP
- Homepage: https://packagist.org/packages/alimranahmed/bdlocation
- Size: 192 KB
- Stars: 24
- Watchers: 5
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://travis-ci.org/alimranahmed/BDLocation)
[](https://packagist.org/packages/alimranahmed/bdlocation)
[](https://packagist.org/packages/alimranahmed/bdlocation)
# BDLocation
A PHP interface to access Locations of Bangladesh. The data in this project used and slightly modified from [Bangladesh-geolocation](https://github.com/nuhil/bangladesh-geocode)
## Features
1. Can access name, bengali_name etc of divisions, districts, sub districts and unions of Bangladesh
2. Zero configurations
## Requirements
PHP >= 7
## Installation
Execute the following command in the terminal while you are in the root directory of your PHP project:
`composer require alimranahmed/bdlocation`
That's it! you are ready to go!
## Usages
Don't forget to use the BD class:
```
use BDLocation\BD;
```
To get all **divisions** of Bangladesh as an array of Location object:
```
BD::division()->all();
```
To get all **districts** of Bangladesh as an array of Location object:
```
BD::district()->all();
```
To get all **sub-districts/upazilas** of Bangladesh as an array of Location object:
```
BD::subDistrict()->all();
```
To get all **unions** of Bangladesh of Bangladesh as an array of Location object:
```
BD::union()->all();
```
To get all the districts of division that start with 5 character `chatt`(Chattogram), we can use the following code.
Same thing will work for sub-disctrict and union. But in case of sub-district and union we need to pass `district` and `sub_district` respectively.
```
BD::district()->getWhere('division', 'chatt');
BD::subDistrict()->getWhere('district', 'brahm');
BD::union()->getWhere('sub_district', 'sarai');
```
To get the district that has name `Brahmanbaria` we can use the following code. Same thing will work for division, sub-district and union also. Insead of `name` we can pass `short_name`(first 3 letter of the location), `bengali_name` also.
```
BD::district()->getWhere('name', 'brahmanbaria');
or
BD::district()->getWhere('name', '=', 'brahmanbaria');
```
To get all the districts that contains the letter `rahman` in it's name we can use the following code. Same thing will work for division, sub-district and union also. Insead of `name` we can pass `short_name`(first 3 letter of the location), `bengali_name` also.
```
BD::district()->getWhere('name', 'like', 'rahman');
```
**Note:** We have only `=` and `like` as operator here. No other operator will work here.
## Wishlist
- [x] Supporting more operators like `like%` `%like` etc.
### Contribution
**Anyone is always welcome to contribute on the project. If you want to work with:**
1. Just create and issue(even if you want to fix the issue).
2. After fixing any issue or adding any new feature just send a pull request
3. I will be happy to add your code for the betterment of this project.
Thanks.
## Licence
[MIT](https://opensource.org/licenses/MIT)