rjvandoesburg/laravel-apixu-client

A laravel package to interface with the Apixu API

A laravel package to interface with the Apixu API

This package adds a facade and a dependency injectable class you can use to make easy calls to the api, _(*1)

Install

You can install the package via composer:, _(*2)

``` bash composer require rjvandoesburg/laravel-apixu-client, <sub>(*3)</sub>

You must install the following service provider:

```php
// config/app.php

'providers' => [
    ...
    Rjvandoesburg\Apixu\ApixuServiceProvider::class,
    ...
];

This package requires an API key that can be stored in the .env file. You can get your key here: https://www.apixu.com/ The following settings are available for your .env file:, <sub>(*4)</sub>

APIXU_KEY={your-key-here}
APIXU_URL=https://api.apixu.com/v1
APIXU_CACHE_LENGTH=30

The cache length is how long before new data is fetched from the server, this because you might want to limit the API calls, <sub>(*5)</sub>

These settings are set in a config file that you can edit yourself, should you desire to do so. Execute the following command to get the config file, <sub>(*6)</sub>

php artisan vendor:publish --provider="Rjvandoesburg\Apixu\ApixuServiceProvider"

A file named apixu.php will be created in the config directory., <sub>(*7)</sub>

Usage

The API has 4 endpoint * Current * Forecast * History * Search, <sub>(*8)</sub>

Each request needs certain parameters, read more about those here, <sub>(*9)</sub>

To build op the filters you need to use a FiltersClass and all parameters you can set for the API are defined as properties. To use the facade to get the current weather, use the following:, <sub>(*10)</sub>

$filters = new \Rjvandoesburg\Apixu\Filters([
    'q' => 'London',
]);
$response = \Apixu::current($filters);

This will return a CurrentResponse which contains all properties returned. You can use this response to easily output the response., <sub>(*11)</sub>

The available methods are:, <sub>(*12)</sub>

\Apixu::current($filters);
\Apixu::forecast($filters);
\Apixu::history($filters);
\Apixu::search($filters);

or use the dependency injection method, <sub>(*13)</sub>

public function getWeather(\Rjvandoesburg\Apixu\ApixuClient $apixu)
{
    $filters = new \Rjvandoesburg\Apixu\Filters([
        'q' => 'London',
    ]);

    return $apixu->current($filters)
}

Credits

• Robert-John van Doesburg

License

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