unicodeveloper/laravel-ngsc
Domaine:
digital infrastructureType de record:
software
Créateur:
uni
Hôte:
:package: :four_leaf_clover: Laravel 5 Package that provides a fluent API for states and cities in Nigeria
# laravel-ngsc
> A Laravel 5 Package for providing a fluent API for states, lgas and cities in Nigeria
## Installation
PHP 5.4+ or HHVM 3.3+, and Composer 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 crew for providing a fluent and awesome API
## Contributing
Please feel free to fork this package and contribute by submitting a …