MeteoFlow Laravel

Laravel integration for the MeteoFlow Weather API SDK.

Requirements

• PHP 7.1+
• Laravel 5.5 - 12.x

Installation

composer require meteoflow/laravel

The package uses Laravel's auto-discovery, so the service provider and facade will be registered automatically.

Configuration

Publish the configuration file:

php artisan vendor:publish --tag=meteoflow-config

Add your API key to your .env file:

METEOFLOW_API_KEY=your-api-key-here

Available Configuration Options

Usage

Using the Facade

use MeteoFlow\Laravel\Facades\MeteoFlow;
use MeteoFlow\Location\LocationSlug;
use MeteoFlow\Location\LocationCoords;
use MeteoFlow\Location\Location;

// Get current weather by location slug
$location = new LocationSlug('london-gb');
$weather = MeteoFlow::current($location);

echo $weather->getWeather()->getTemperature(); // 15.5
echo $weather->getWeather()->getDescription(); // "Partly cloudy"

// Get current weather by coordinates
$location = new LocationCoords(51.5074, -0.1278);
$weather = MeteoFlow::current($location);

// Get current weather by IP
$location = Location::fromIp('8.8.8.8');
$weather = MeteoFlow::current($location);

// Get daily forecast
$forecast = MeteoFlow::forecastDaily($location);

foreach ($forecast->getForecasts() as $day) {
    echo $day->getDate() . ': ' . $day->getTemperatureMax() . '°C';
}

Using Dependency Injection

use MeteoFlow\WeatherClientInterface;
use MeteoFlow\Location\LocationSlug;

class WeatherController extends Controller
{
    public function show(WeatherClientInterface $client)
    {
        $location = new LocationSlug('london-gb');
        $weather = $client->current($location);

        return view('weather', [
            'temperature' => $weather->getWeather()->getTemperature(),
            'description' => $weather->getWeather()->getDescription(),
        ]);
    }
}

Available Methods

Weather

// Current weather
MeteoFlow::current(Location $location): CurrentWeatherResponse

// Hourly forecast
MeteoFlow::forecastHourly(Location $location, ?ForecastOptions $options = null): HourlyForecastResponse

// 3-hourly forecast
MeteoFlow::forecast3Hourly(Location $location, ?ForecastOptions $options = null): ThreeHourlyForecastResponse

// Daily forecast
MeteoFlow::forecastDaily(Location $location, ?ForecastOptions $options = null): DailyForecastResponse

// Geomagnetic activity
MeteoFlow::geomagnetic(Location $location): GeomagneticResponse

// Air quality by days
MeteoFlow::airQuality(Location $location, ?AirQualityOptions $options = null): AirQualityResponse

Geography

// List all supported countries
MeteoFlow::countries(): CountriesResponse

// List cities for a country code
MeteoFlow::citiesByCountry(string $countryCode): CitiesResponse

// Search cities by name (limit is optional)
MeteoFlow::searchCities(string $query, ?int $limit = null): CitiesResponse

Geography

use MeteoFlow\Laravel\Facades\MeteoFlow;

// List all countries
$response = MeteoFlow::countries();

foreach ($response->countries as $country) {
    $country->slug;  // e.g. "united-kingdom"
    $country->name;  // e.g. "United Kingdom"
    $country->code;  // ISO 3166-1 alpha-2, e.g. "GB"
}

// Cities by country code
$response = MeteoFlow::citiesByCountry('DE');

foreach ($response->cities as $city) {
    $city->slug;           // e.g. "germany-berlin"
    $city->name;           // City name
    $city->country;        // Country name
    $city->countryCode;    // Country code
    $city->region;         // Region / state name
    $city->lat;            // Latitude
    $city->lon;            // Longitude
    $city->timezoneOffset; // UTC offset in minutes
}

// Search cities by name
$response = MeteoFlow::searchCities('Berlin', 5);

foreach ($response->cities as $city) {
    // Same fields as above
}

Forecast Options

use MeteoFlow\Options\ForecastOptions;
use MeteoFlow\Options\Unit;

$options = ForecastOptions::create()
    ->setDays(14)
    ->setUnit(Unit::IMPERIAL)
    ->setLang('de');

$forecast = MeteoFlow::forecastDaily($location, $options);

Air Quality Options

use MeteoFlow\Options\AirQualityOptions;
use MeteoFlow\Options\Unit;

$options = AirQualityOptions::create()
    ->setDays(5)
    ->setUnit(Unit::METRIC);

$airQuality = MeteoFlow::airQuality($location, $options);

Geomagnetic Activity

use MeteoFlow\Location\Location;

$location = Location::fromSlug('united-kingdom-london');
$geomagnetic = MeteoFlow::geomagnetic($location);

Testing

composer test

License

MIT License. See LICENSE for more information.