Property | Type | Description | |
---|---|---|---|
$iconMap | |||
$link | string | ||
$title | string |
Property | Type | Description | |
---|---|---|---|
$_key | string | Wwo API key. | |
$_version | integer | API Version |
Method | Description | |
---|---|---|
__construct ( array $params = [] ) : Horde_Service_Weather_Wwo | Constructor. | |
autocompleteLocation ( $search ) | Return an autocomplete request result. | |
getCurrentConditions ( $location ) : Horde_Service_Weather_Current_Wwo | Obtain the current observations. | |
getForecast ( $location, $length = Horde_Service_Weather::FORECAST_3DAY, $type = Horde_Service_Weather::FORECAST_TYPE_STANDARD ) | Obtain the forecast for the current location. | |
getSupportedForecastLengths ( ) | Return the supported forecast lengths. | |
searchLocations ( $location, $type = Horde_Service_Weather::SEARCHTYPE_STANDARD ) | Search for a valid location code. |
Method | Description | |
---|---|---|
_getCommonElements ( string $location, integer $length = Horde_Service_Weather::FORECAST_5DAY ) | Populates some common data used by forecasts and current conditions. | |
_makeRequest ( Horde_Url $url ) : mixed | Make the remote API call. | |
_parseAutocomplete ( $results ) | ||
_parseCurrent ( stdClass $current ) : Horde_Service_Weather_Current | Parse the current_conditions response. | |
_parseForecast ( stdClass $forecast ) : Horde_Service_Weather_Forecast_Wwo | Parses the forecast data. | |
_parseSearchLocations ( $response ) | ||
_parseStation ( StdClass $station ) : Horde_Service_Weather_Station | Parses the JSON response for a location request into a station object. | |
_searchLocations ( string $location ) : string | Execute a location search. |
public __construct ( array $params = [] ) : Horde_Service_Weather_Wwo | ||
$params | array | Parameters: - cache: (Horde_Cache) Optional Horde_Cache object. - cache_lifetime: (integer) Lifetime of cached data, if caching. - http_client: (Horde_Http_Client) Required http client object. - apikey: (string) Require api key for Wwo. - apiVersion: (integer) Version of the API to use. Defaults to v1 for BC reasons. |
return | Horde_Service_Weather_Wwo |
protected _getCommonElements ( string $location, integer $length = Horde_Service_Weather::FORECAST_5DAY ) | ||
$location | string | The location identifier. |
$length | integer | The forecast length. |
protected _makeRequest ( Horde_Url $url ) : mixed | ||
$url | Horde_Url | The endpoint. |
return | mixed | The unserialized results form the remote API call. |
protected _parseCurrent ( stdClass $current ) : Horde_Service_Weather_Current | ||
$current | stdClass | The current_condition request response object |
return | Horde_Service_Weather_Current |
protected _parseForecast ( stdClass $forecast ) : Horde_Service_Weather_Forecast_Wwo | ||
$forecast | stdClass | The result of the forecast request. |
return | Horde_Service_Weather_Forecast_Wwo | The forecast. |
protected _parseStation ( StdClass $station ) : Horde_Service_Weather_Station | ||
$station | StdClass | The response from a Location request. |
return | Horde_Service_Weather_Station |
protected _searchLocations ( string $location ) : string | ||
$location | string | The location text to search. |
return | string | The location code result(s). |
public autocompleteLocation ( $search ) |
public getCurrentConditions ( $location ) : Horde_Service_Weather_Current_Wwo | ||
return | Horde_Service_Weather_Current_Wwo |
public getForecast ( $location, $length = Horde_Service_Weather::FORECAST_3DAY, $type = Horde_Service_Weather::FORECAST_TYPE_STANDARD ) |
public getSupportedForecastLengths ( ) |
public searchLocations ( $location, $type = Horde_Service_Weather::SEARCHTYPE_STANDARD ) |