library laravel-dark-sky

naughtonium/laravel-dark-sky

Provides a Wrapper for the DarkSky API

Laravel DarkSky

, _(*1)

This provides a Laravel style wrapper for the DarkSky api. For more information regarding request and response formats, visit: https://darksky.net/dev/docs, _(*2)

Install

Require this package with composer using the following command:, _(*3)

``` bash $ composer require naughtonium/laravel-dark-sky, <sub>(*4)</sub>

After updating composer, add the service provider to the `providers` array in `config/app.php`

```php
Naughtonium\LaravelDarkSky\LaravelDarkSkyServiceProvider::class,

To register a facade accessor, add the following to config/app.php aliases array, <sub>(*5)</sub>

'DarkSky' => \Naughtonium\LaravelDarkSky\Facades\DarkSky::class,

Configuration

Add the following line to the .env file:, <sub>(*6)</sub>

DARKSKY_API_KEY=<your_darksky_api_key>

Usage

For full details of response formats, visit: https://darksky.net/dev/docs/response, <sub>(*7)</sub>

Required

location(lat, lon)

Pass in latitude and longitude coordinates for a basic response ``` php DarkSky::location(lat, lon)->get();, <sub>(*8)</sub>

#### Optional Parameters
For full details of optional parameters, visit: https://darksky.net/dev/docs/forecast

##### excludes([]) / includes([])
Specify which data blocks to exclude/include to reduce data transfer
```php
DarkSky::location(lat, lon)->excludes(['minutely','hourly', 'daily', 'alerts', 'flags'])->get();
DarkSky::location(lat, lon)->includes(['currently'])->get();
// Same output

atTime(t)

Pass in a unix timestamp to get forecast for that time. Note: the timezone is relative to the given location, <sub>(*9)</sub>

``` php DarkSky::location(lat, lon)->atTime(timestamp)->get();, <sub>(*10)</sub>

##### language(l)
Specify a language for text based responses
``` php
DarkSky::location(lat, lon)->language(lang)->get();

units(u)

Specify units for unit based responses ``` php DarkSky::location(lat, lon)->units(units)->get();, <sub>(*11)</sub>

##### extend()
Extend the "hourly" response from 48 to 168 hours.
Note: Does not work if used with an atTime() timestamp.
Please see: https://darksky.net/dev/docs/time-machine
``` php
DarkSky::location(lat, lon)->extend()->get();

Helpers

The following are shorthand helpers to add readability equal to using includes() with only one parameter. Note: only one may be used per query and only temperature specific data is returned, <sub>(*12)</sub>

->currently()
->minutely()
->hourly()
->daily()
->flags()

For example, these two statements are the same, <sub>(*13)</sub>

DarkSky::location(lat, lon)->hourly()
DarkSky::location(lat, lon)->includes(['hourly'])->get()->hourly

Credits

• Jack Naughton
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*14)</sub>