https://github.com/unicodeveloper/laravel-ngsc
:package: :four_leaf_clover: Laravel 5 Package that provides a fluent API for states and cities in Nigeria
https://github.com/unicodeveloper/laravel-ngsc
Last synced: 8 months ago
JSON representation
:package: :four_leaf_clover: Laravel 5 Package that provides a fluent API for states and cities in Nigeria
- Host: GitHub
- URL: https://github.com/unicodeveloper/laravel-ngsc
- Owner: unicodeveloper
- License: mit
- Created: 2016-01-26T16:57:41.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-07-29T01:31:47.000Z (over 7 years ago)
- Last Synced: 2025-05-07T17:52:02.581Z (8 months ago)
- Language: PHP
- Homepage:
- Size: 8.79 KB
- Stars: 10
- Watchers: 3
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# laravel-ngsc
[](https://packagist.org/packages/unicodeveloper/laravel-ngsc)
[](LICENSE.md)
[](https://travis-ci.org/unicodeveloper/laravel-ngsc)
[](https://scrutinizer-ci.com/g/unicodeveloper/laravel-ngsc)
[](https://packagist.org/packages/unicodeveloper/laravel-ngsc)
> A Laravel 5 Package for providing a fluent API for states, lgas and cities in Nigeria
## Installation
[PHP](https://php.net) 5.4+ or [HHVM](http://hhvm.com) 3.3+, and [Composer](https://getcomposer.org) are required.
To get the latest version of Laravel Ngsc, simply add the following line to the require block of your `composer.json` file.
```
"unicodeveloper/laravel-ngsc": "1.0.*"
```
You'll then need to run `composer install` or `composer update` to download it and have the autoloader updated.
Once Laravel Ngsc is installed, you need to register the service provider. Open up `config/app.php` and add the following to the `providers` key.
* `Unicodeveloper\Ngsc\NgscServiceProvider::class`
Also, register the Facade like so:
```php
'aliases' => [
...
'Ngsc' => Unicodeveloper\Ngsc\Facades\NgscFacade::class,
...
]
```
## Configuration
To get started, you'll need to publish all vendor assets:
```bash
$ php artisan vendor:publish --provider="Unicodeveloper\Ngsc\NgscServiceProvider"
```
## Usage
You can use it in your controller by using Dependency Injection like so:
```php
ngsc = $ngsc;
}
/**
* Get all states
* @return array
*/
public function getAllStates()
{
return $this->ngsc->getAllStates();
}
}
```
You can also simply use the awesome Facades like so:
```php
/**
* Gets all the states in Nigeria
* @return array
*/
Ngsc::getAllStates()
/**
* Gets the details of just one state, e.g capital, lat, lng
* @param string state or state code
* @return array
*/
Ngsc::getOneState('lagos') OR Ngsc::getOneState('LA')
/**
* Gets the local government areas of just one state
* @param string state or state code
* @return array
*/
Ngsc::getLGAS('lagos') OR Ngsc::getLGAS('LA')
/**
* Gets the cities of just one state
* @param string state or state code
* @return array
*/
Ngsc::getCities('lagos') OR Ngsc::getCities('LA')
```
## Appreciation
Huge thanks go to the [Devcenter.co](http://devcenter.co/square) crew for providing a fluent and awesome API
## Contributing
Please feel free to fork this package and contribute by submitting a pull request to enhance the functionalities.
## How can I thank you?
Why not star the github repo? I'd love the attention! Why not share the link for this repository on Twitter or HackerNews? Spread the word!
Don't forget to [follow me on twitter](https://twitter.com/unicodeveloper)!
Thanks!
Prosper Otemuyiwa.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.