baspa / buienradar-php-api
PHP package to provide fluent syntax for the Buienradar API
Fund package maintenance!
Baspa
Requires
- php: ^8.1
- guzzlehttp/guzzle: ^7.8
Requires (Dev)
- laravel/pint: ^1.0
- pestphp/pest: ^2.15
- phpstan/phpstan: ^1.10
- spatie/ray: ^1.28
README
This framework-agnostic PHP package provides a fluent syntax to interact with the Buienradar API.
Installation
You can install the package via composer:
composer require baspa/buienradar-php-api
Usage
Initialization
Create an instance of the Buienradar class:
use Baspa\Buienradar\Buienradar; $buienradar = new Buienradar();
Get the actual forecast report
$forecast = $buienradar->forecast()->report();
Get the short-term forecast
$forecast = $buienradar->forecast()->shortTerm();
Get the long-term forecast
$forecast = $buienradar->forecast()->longTerm();
Get the forecast for the upcoming 5 days
$forecast = $buienradar->forecast()->forFiveDays();
Get the forecast for one specific day
If you want to get the forecast for a specific day, you can use the forDay method. The parameter is the day you want to get the forecast for, where 0 is today, 1 is tomorrow, and so on. The maximum value is 4.
$forecast = $buienradar->forecast()->forDay(1);
Get the actual forecast for a specific measurement station
Choose either one of the following measuring stations:
- Meetstation Arcen
- Meetstation Arnhem
- Meetstation Berkhout
- Meetstation De Bilt
- Meetstation Den Helder
- Meetstation Eindhoven
- Meetstation Ell
- Meetstation Gilze Rijen
- Meetstation Goes
- Meetstation Groenlo-Hupsel
- Meetstation Groningen
- Meetstation Heino
- Meetstation Herwijnen
- Meetstation Hoek van Holland
- Meetstation Hoogeveen
- Meetstation Hoorn Terschelling
- Meetstation Houtribdijk
- Meetstation IJmuiden
- Meetstation Lauwersoog
- Meetstation Leeuwarden
- Meetstation Lelystad
- Meetstation Lopik-Cabauw
- Meetstation Maastricht
- Meetstation Marknesse
- Meetstation Nieuw Beerta
- Meetstation Rotterdam
- Meetstation Rotterdam Geulhaven
- Meetstation Schiphol
- Meetstation Stavoren
- Meetstation Texelhors
- Meetstation Twente
- Meetstation Vlieland
- Meetstation Vlissingen
- Meetstation Volkel
- Meetstation Voorschoten
- Meetstation Westdorpe
- Meetstation Wijdenes
- Meetstation Wijk aan Zee
- Meetstation Woensdrecht
- Meetstation Zeeplatform F-3
For example, to get the forecast for the Volkel station, use:
use Baspa\Buienradar\Enum\MeasuringStation; $forecast = $buienradar->actualForecastForStation(MeasuringStation::VOLKEL);
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.