API Documentation
\

\Horde_Service_Weather_Forecast_Taf

Horde_Service_Weather_Forecast_Taf

Summary

Methods
Properties
Constants
__construct()
getForecastDay()
limitLength()
getForecastTime()
getIterator()
getRawData()
$weather
$fields
$detail
No constants found
_parsePeriods()
$_properties
$_periods
$_type
$_maxDays
N/A
No private methods found
No private properties found
N/A

Properties

$fields

$fields : array

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

Type

array

$detail

$detail : integer

Advertise how detailed the forecast period is.

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.

Type

integer

$_properties

$_properties : array

The forecast properties as returned from the forecast request.

Type

array

$_periods

$_periods : array

Local cache of forecast periods

Type

array

$_type

$_type : integer

Forecast type

Type

integer — A Horde_Service_Weather::FORECAST_TYPE_* constant.

$_maxDays

$_maxDays :

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

Type

Methods

__construct()

__construct(array  $properties, \Horde_Service_Weather_base  $weather, integer  $type = \Horde_Service_Weather::FORECAST_TYPE_STANDARD)

Const'r

Parameters

array $properties

Forecast properties.
\Horde_Service_Weather_base $weather

The base driver.
integer $type

The forecast type.

getForecastDay()

getForecastDay(integer  $day) : \Horde_Service_Weather_Period_Base

Return the forecast for the specified ordinal day.

Parameters

integer $day

The forecast day to return.

Returns

\Horde_Service_Weather_Period_Base

limitLength()

limitLength(integer  $days)

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.

Parameters

integer $days

The number of days to return.

getForecastTime()

getForecastTime() : \Horde_Date

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

Returns

\Horde_Date —

The time of the forecast.

getIterator()

getIterator() : \ArrayIterator

Return an ArrayIterator

Returns

\ArrayIterator

getRawData()

getRawData() : array

Compatibility layer for old PEAR/Services_Weather data.

Returns

array —

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.

_parsePeriods()

_parsePeriods()