thtroyer/noaa-cap-alerts

Parser for NOAA CAP files.

Maintainers

Details

github.com/thtroyer/noaa-cap-alerts

Homepage

Source

Issues

Installs: 8

Dependents: 0

Suggesters: 0

Security: 0

Stars: 3

Watchers: 3

Forks: 0

Open Issues: 2

0.4.0 2022-06-05 02:55 UTC

Requires

Requires (Dev)

MIT a939a05a0d6fbc18ac292f9b8199ba0cbb2db637

This package is auto-updated.

Last update: 2024-11-05 07:57:24 UTC

README

Build Status Code Coverage Scrutinizer Code Quality Latest Stable Version Latest Unstable Version License

What is this?

This is a PHP 7.3+ library to make it easier to fetch and use weather alerts created by NOAA.

Setup

Include noaa-cap-alerts into your project:

composer require thtroyer/noaa-cap-alerts
composer update

Dependencies

Make sure you have the XML extension installed for PHP.

e.g. sudo apt install php7.4-xml

Usage

Instantiate a new NoaaCapAlerts\NoaaAlerts object. Calling getAlerts() will download the latest alerts from NOAA, parse and return a set of data objects to be consumed.

$noaaAlerts = new NoaaCapAlerts\NoaaAlerts();
$alerts = $noaaAlerts->getAlerts();

foreach ($alerts as $alert) {
    echo $alert->getTitle();
}

See NoaaCapAlerts\Model\NoaaAlert class to see what data is currently available.

Features are still being added, so some changes may not be backwards compatible. Until 1.0, treat new feature versions (0.x) as breaking updates.

More information about NOAA's CAP format is available here.