Documentation

Horde_Service_Weather_Forecast_Taf extends Horde_Service_Weather_Forecast_Base
in package

Horde_Service_Weather_Forecast_Taf

Tags
author

Michael J Rubinsky mrubinsk@horde.org

category

Horde

Table of Contents

$detail  : int
Advertise how detailed the forecast period is.
$fields  : array<string|int, mixed>
Array of supported "detailed" forecast fields. To be populated by concrete classes.
$weather  : Horde_Service_Weather_Base
Parent Weather driver.
$_maxDays  : mixed
Maximum forecast length to return. Defaults to sufficiently high number to ensure all available days returned by default.
$_periods  : array<string|int, mixed>
Local cache of forecast periods
$_properties  : array<string|int, mixed>
The forecast properties as returned from the forecast request.
$_type  : int
Forecast type
__construct()  : mixed
Const'r
getForecastDay()  : Horde_Service_Weather_Period_Base
Return the forecast for the specified ordinal day.
getForecastTime()  : Horde_Date
Return the time of the forecast, in local (to station) time.
getIterator()  : ArrayIterator
Return an ArrayIterator
getRawData()  : array<string|int, mixed>
Compatibility layer for old PEAR/Services_Weather data.
limitLength()  : mixed
Limit the returned number of forecast days. Used for emulating a smaller forecast length than the provider supports or for using one, longer request to supply two different forecast length requests.
_parsePeriods()  : mixed

Properties

$detail

Advertise how detailed the forecast period is.

public int $detail = Horde_Service_Weather::FORECAST_TYPE_STANDARD 
FORECAST_TYPE_STANDARD - Each Period represents a full day
FORECAST_TYPE_DETAILED - Each period represents either day or night.
FORECAST_TYPE_HOURLY   - Each period represents a single hour.

$fields

Array of supported "detailed" forecast fields. To be populated by concrete classes.

public array<string|int, mixed> $fields = array()

$_maxDays

Maximum forecast length to return. Defaults to sufficiently high number to ensure all available days returned by default.

protected mixed $_maxDays = 20

$_periods

Local cache of forecast periods

protected array<string|int, mixed> $_periods = array()

$_properties

The forecast properties as returned from the forecast request.

protected array<string|int, mixed> $_properties = array()

$_type

Forecast type

protected int $_type

A Horde_Service_Weather::FORECAST_TYPE_* constant.

Methods

__construct()

Const'r

public __construct(array<string|int, mixed> $properties, Horde_Service_Weather_base $weather[, int $type = Horde_Service_Weather::FORECAST_TYPE_STANDARD ]) : mixed
Parameters
$properties : array<string|int, mixed>

Forecast properties.

$weather : Horde_Service_Weather_base

The base driver.

$type : int = Horde_Service_Weather::FORECAST_TYPE_STANDARD

The forecast type.

Return values
mixed —

getForecastTime()

Return the time of the forecast, in local (to station) time.

public getForecastTime() : Horde_Date
Return values
Horde_Date —

The time of the forecast.

getIterator()

Return an ArrayIterator

public getIterator() : ArrayIterator
Return values
ArrayIterator —

getRawData()

Compatibility layer for old PEAR/Services_Weather data.

public getRawData() : array<string|int, mixed>
Return values
array<string|int, mixed> —

The raw parsed data array - keyed by descriptors that are compatible with PEAR/Services_Weather. Structure of data: Data is converted into the appropriate units based on the Horde_Service_Weather_Base::units setting at the time or parsing.

  • station: The station identifier.
  • dataRaw: The raw TAF data.
  • update: The update timestamp.
  • updateRaw: The raw TAF encoded update time.
  • validRaw: The raw TAF encoded valid forecast times.
  • validFrom: The valid forecast FROM time.
  • validTo: The valid forecast TO time.
  • time: Array containing an entry for each weather section. Basically each entry contains forcasted changes beginning at the time of the key to the entry.
    • wind: The wind speed.
    • windDegrees: The wind direction in degrees.
    • windDirection: The wind direction in a cardinal compass direction.
    • windGust: The wind gust speed.
    • windProb: Probability of forecast wind.
    • visibility: Visibility distance.
    • visQualifier: Qualifier of visibility. I.e., "AT", "BEYOND", "BELOW"
    • visProb: Probability of forecast visibility.
    • clouds: Array containing cloud layer information:
      • amount: Amount of sky cover. I.e., "BROKEN", "OVERCAST"
      • height: The height of the base of the cloud layer.
      • type: The type of clouds if available.
    • condition: The weather condition. I.e., "RAIN", "MIST"
    • windshear: Windshear delta.
    • windshearHeight: The height of windshear.
    • windshearDegrees: The degrees of windshear.
    • windshearDirection:The compass direction of windshear.
    • temperatureLow: The forecast low temperature.
    • temperatureHigh: The forecast high temperature.
    • fmc: Array containing any FMC changes. I.e, "TEMPO", or "BECMG" lines.
      • from: Horde_Date representing the starting time of the FMC change.
      • to: Horde_Date representing the ending time of the FMC period.

limitLength()

Limit the returned number of forecast days. Used for emulating a smaller forecast length than the provider supports or for using one, longer request to supply two different forecast length requests.

public limitLength(int $days) : mixed
Parameters
$days : int

The number of days to return.

Return values
mixed —

_parsePeriods()

protected _parsePeriods() : mixed
Return values
mixed —

Search results