Provides an intuitive interface to use the NWS REST API in any PHP application.
composer require benjaminhansen/nws-php
Notes
- Requires PHP 8.2 or greater
- All requests can be cached locally to reduce outbound requests to the API endpoint
- All datetime fields are automatically returned as a
Carbon
object - Any timezone fields are automatically returned as a PHP
DateTimeZone
object - A
raw()
method is available on most calls to print out the raw API data
<?php
require 'vendor/autoload.php'; // if your app it not already including this
use NWS\Api;
/*
** We must provide valid contact information so the National Weather Service
** can properly identify our application on their end
*/
$app_domain = "website/url";
$app_contact = "email/phone";
$api = new Api($app_domain, $app_contact);
/*
** The cache is opt-in. To cache results locally make sure to enable the cache.
** Sometimes, you may not want to use the cache at all, so this allows it to be toggled on/off.
*/
$api->useCache();
// $api->setCacheLifetime(3600); // seconds that the cached data should persist
/*
** We can set a timezone for the entire API callstack.
** All datetime objects will be converted to this timestamp.
*/
$timezone = "America/Chicago";
$api->setTimezone($timezone);
/*
** We can provide lat/lon coordinates for a specific location
** Dallas, TX for example
*/
$lat = 32.7767;
$lon = -96.7970;
$location = $api->getLocation(lat: $lat, lon: $lon);
/*
** Get the location's county information
*/
$county = $location->county();
echo $county->name();
echo $county->id();
echo $county->state()->name();
echo $county->state()->abbreviation();
var_dump($county->timezone());
var_dump($county->timezones());
/*
** Get information about the location
*/
echo $location->radarStationId();
echo $location->city();
var_dump($location->state());
/*
** Get any active alerts for the location and loop through them
*/
$alerts = $location->activeAlerts()->get();
foreach($alerts as $alert) {
var_dump($alert);
}
/*
** Get current observations from the nearest observation station to your location
*/
$observations = $location->latestObservations();
$raw_data = $observations->raw();
var_dump($raw_data);
echo $observations->temperature();
echo $observations->dewpoint();
// other methods are available for the other data points as well
/*
** Get the current forecast for the location
*/
$forecast = $location->forecast();
var_dump($forecast->raw());
var_dump($foreast->periods()->get());
/*
** Get the current hourly forecast for the location
*/
$hourly_forecast = $location->hourlyForecast();
var_dump($hourly_forecast->raw());
var_dump($hourly_forecast->periods()->get());
/*
** We can also get a specific forecast office
** Little Rock, Arkansas for example
*/
$office_id = "LZK";
$forecast_office = $api->getLocation(forecast_office: $office_id);
echo $forecast_office->name();
echo $forecast_office->phone();
echo $forecast_office->email();
echo $forecast_office->addresss();
var_dump($forecast_office->counties());
var_dump($forecast_office->forecastZones());
var_dump($forecast_office->observationStations());
var_dump($forecast_office->fireZones());
var_dump($forecast_office->activeAlerts()->get());
/*
** We can also get a specific observation station
** Little Rock, Arkansas Airport KLIT for example
*/
$station_id = "KLIT";
$observation_station = $api->getLocation(observation_station: $station_id);
echo $observation_station->name();
echo $observation_station->id();
var_dump($observation_station->timezone());
var_dump($observation_station->county());
var_dump($observation_station->latestObservations());
var_dump($observation_station->activeAlerts()->get());
guzzlehttp/guzzle
for all HTTP requestsnesbot/carbon
for date/time parsing and formattingphpfastcache/phpfastcache
for local caching of API data to reduce direct calls to the API endpoint