TimeObjects_Driver_Weather
extends TimeObjects_Driver_Base
in package
TimeObjects driver for exposing weatherunderground information via the listTimeObjects API.
Copyright 2011-2017 Horde LLC (http://www.horde.org/)
Tags
Table of Contents
- $_forecastDays : mixed
- $_location : mixed
- $_params : mixed
- __construct() : mixed
- Constructor
- ensure() : bool
- Ensures that we meet all requirements to use this time object
- factory() : TimeObjects_Driver
- Factory method
- listTimeObjects() : array<string|int, mixed>
- Get a list of TimeObjects.
- _create() : Horde_Service_Weather_Base
- Private factory for weather driver.
- _findLocation() : mixed
Properties
$_forecastDays
protected
mixed
$_forecastDays
= \Horde_Service_Weather::FORECAST_7DAY
$_location
protected
mixed
$_location
$_params
protected
mixed
$_params
= array()
Methods
__construct()
Constructor
public
__construct(array<string|int, mixed> $params) : mixed
Parameters
- $params : array<string|int, mixed>
-
The parameter array.
Return values
mixed —ensure()
Ensures that we meet all requirements to use this time object
public
ensure() : bool
Return values
bool —factory()
Factory method
public
factory( $name[, $params = array() ]) : TimeObjects_Driver
Parameters
Return values
TimeObjects_Driver —listTimeObjects()
Get a list of TimeObjects.
public
listTimeObjects([Horde_Date $start = null ][, Horde_Date $end = null ]) : array<string|int, mixed>
Parameters
- $start : Horde_Date = null
-
The start time of the period
- $end : Horde_Date = null
-
The end time of the period
Return values
array<string|int, mixed> —of listTimeObjects arrays.
_create()
Private factory for weather driver.
protected
_create() : Horde_Service_Weather_Base
Return values
Horde_Service_Weather_Base —_findLocation()
protected
_findLocation() : mixed