API Documentation
\

\Horde_Service_Weather_Forecast_Wwov2

Horde_Service_Weather_Forecast_Wwo

Summary

Methods
Properties
Constants
__construct()
getForecastTime()
getForecastDay()
limitLength()
getIterator()
$fields
$weather
$detail
No constants found
_parseStd()
$_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.

getForecastTime()

getForecastTime() : \Horde_Date

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

Returns

\Horde_Date —

The time of the forecast.

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.

getIterator()

getIterator() : \ArrayIterator

Return an ArrayIterator

Returns

\ArrayIterator

_parseStd()

_parseStd()

Parse a stdRequest

Throws

\Horde_Service_Weather_Exception