Download the PHP package amwhalen/noaa without Composer
On this page you can find all versions of the php package amwhalen/noaa. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download amwhalen/noaa
More information about amwhalen/noaa
Files in amwhalen/noaa
Package noaa
Short Description Client library for NOAA's forecast and current weather services
License MIT
Homepage https://github.com/amwhalen/noaa
Informations about the package noaa
Overview
This library provides a PHP client for NOAA's forecast and current weather services.
Current weather data is provided by NOAA's XML Feeds of Current Weather Conditions. Forecast data is provided by the NOAA's National Digital Forecast Database (NDFD) REST Web Service. The National Oceanic and Atmospheric Administration (NOAA) is a United States federal agency, so the data they provide is only available for US locations.
Requirements
- PHP 5.3.0+
- PHP cURL
- PHP SimpleXML
Current Weather Conditions
To find your current weather conditions you'll first need to know a local NOAA Weather Observation Station ID. You can search for your local station ID here: http://www.weather.gov/xml/current_obs/. There is also a list of stations in XML if you'd like to do something with the station data: http://www.weather.gov/xml/current_obs/index.xml. Here is some sample code for getting the current weather conditions:
You can find more sample code in the example/current.php file.
Forecast
A latitude and longitude are required to retrieve forecast data. There are many APIs that will convert addresses and zip codes into latitude and longitude, but those conversions are outside the scope of this library. The data provided by the API is 24-hour summarized data from 6am-6pm (local time for the supplied location). The precipitation probabilities provided are 12-hour summaries for day and night, running from 6am-6pm and 6pm-6am respectively. Here is some sample code for getting the 7-day forecast starting from the current time:
You can find more sample code in the example/forecast.php file.
Nightly Forecasts
For forecasts made at night (after 6pm local time), the first day in the forecast result will be for "tomorrow." The doesStartAtNight() method will tell you if a forecast is a "night time" forecast:
There will also be one item of information that's still of value for "today," and that is the precipitation probability from 6pm-6am. That probability can be retrieved like so:
Caching
NOAA suggests that consumers of their API ask for new data only once per hour. This library offers a simple to use FileCache class that only requires a writable directory in which to store the cached data. It will handle cache invalidation on its own based on file modification time. The directory you set must exist and be writable.
If you prefer to use a different cache other than the supplied FileCache it's easy to create your own. Just create a class that implements the \noaa\weather\cache\Cache interface. Use the setCache() Configuration method to set your own custom caching class. See the noaa/weather/cache/ArrayCache.php file for an example.
To instantiate a Forecaster object without a caching mechanism (not recommended!):
License
MIT License
Copyright (c) 2023 Andrew M. Whalen
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
All versions of noaa with dependencies
ext-curl Version *
ext-simplexml Version *