• Home
  • Horde_Service_Weather_WeatherUnderground

PHP Class Horde_Service_Weather_WeatherUnderground, horde

Author: Michael J Rubinsky ([email protected])
Inheritance: extends Horde_Service_Weather_Base
Show file Open project: horde/horde

Public Properties

Property Type Description
$iconMap
$logo

Protected Properties

Property Type Description
$_language string Language to request strings from Google in.

Public Methods

Method Description
__construct ( array $params = [] ) : Horde_Service_Weather_WeatherUnderground Constructor.
autocompleteLocation ( $search ) Return an autocomplete search response.
getAlerts ( $location )
getCurrentConditions ( $location ) : Horde_Service_Weather_Current_WeatherUnderground. Obtain the current observations.
getForecast ( $location, $length = Horde_Service_Weather::FORECAST_3DAY, $type = Horde_Service_Weather::FORECAST_TYPE_STANDARD ) : Horde_Service_Weather_Forecast_WeatherUnderground Obtain the forecast for the current location.
getRadarImageUrl ( string $location ) : string | boolean Return the URL to a (possibly animated) radar image.
getSupportedForecastLengths ( ) : array Get array of supported forecast lengths.
searchLocations ( $location, $type = Horde_Service_Weather::SEARCHTYPE_STANDARD ) Search for a valid location code.

Protected Methods

Method Description
_getCommonElements ( $location, $length = null ) Weather Underground allows requesting multiple features per request, and only counts it as a single request against your API key. So we trade a bit of request time/traffic for a smaller number of requests to obtain information for e.g., a typical weather portal display.
_getLocationByIp ( string $ip ) : string Perform an IP location search.
_makeRequest ( $url, $lifetime = 86400 )
_parseAlerts ( $alerts )
_parseAstronomy ( {[type]} $astronomy ) : {[type]} Parses astronomy information. Returned as an array since this will be added to the station information.
_parseAutocomplete ( $results )
_parseCurrent ( stdClass $current ) : Horde_Service_Weather_Current Parse the current_conditions response.
_parseForecast ( stdClass $forecast ) : Horde_Service_Weather_Forecast_WeatherUnderground 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.

Method Details

__construct() public method

Constructor.
public __construct ( array $params = [] ) : Horde_Service_Weather_WeatherUnderground
$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.
return Horde_Service_Weather_WeatherUnderground

_getCommonElements() protected method

Weather Underground allows requesting multiple features per request, and only counts it as a single request against your API key. So we trade a bit of request time/traffic for a smaller number of requests to obtain information for e.g., a typical weather portal display.
protected _getCommonElements ( $location, $length = null )

_getLocationByIp() protected method

Perform an IP location search.
protected _getLocationByIp ( string $ip ) : string
$ip string The IP address to use.
return string The location code.

_makeRequest() protected method

protected _makeRequest ( $url, $lifetime = 86400 )

_parseAlerts() protected method

protected _parseAlerts ( $alerts )

_parseAstronomy() protected method

Parses astronomy information. Returned as an array since this will be added to the station information.
protected _parseAstronomy ( {[type]} $astronomy ) : {[type]}
$astronomy {[type]}
return {[type]}

_parseAutocomplete() protected method

protected _parseAutocomplete ( $results )

_parseCurrent() protected method

Parse the current_conditions response.
protected _parseCurrent ( stdClass $current ) : Horde_Service_Weather_Current
$current stdClass The current_condition request response object
return Horde_Service_Weather_Current

_parseForecast() protected method

Parses the forecast data.
protected _parseForecast ( stdClass $forecast ) : Horde_Service_Weather_Forecast_WeatherUnderground
$forecast stdClass The result of the forecast request.
return Horde_Service_Weather_Forecast_WeatherUnderground The forecast.

_parseSearchLocations() protected method

protected _parseSearchLocations ( $response )

_parseStation() protected method

Parses the JSON response for a location request into a station object.
protected _parseStation ( StdClass $station ) : Horde_Service_Weather_Station
$station StdClass The response from a Location request.
return Horde_Service_Weather_Station

_searchLocations() protected method

Execute a location search.
protected _searchLocations ( string $location ) : string
$location string The location text to search.
return string The location code result(s).

autocompleteLocation() public method

Return an autocomplete search response.
See also: Horde_Service_Weather_Base::autocompleteLocation()
public autocompleteLocation ( $search )

getAlerts() public method

public getAlerts ( $location )

getCurrentConditions() public method

Obtain the current observations.
See also: Horde_Service_Weather_Current_Base::getCurrentConditions()
public getCurrentConditions ( $location ) : Horde_Service_Weather_Current_WeatherUnderground.
return Horde_Service_Weather_Current_WeatherUnderground.

getForecast() public method

Obtain the forecast for the current location.
See also: Horde_Service_Weather_Base::getForecast()
public getForecast ( $location, $length = Horde_Service_Weather::FORECAST_3DAY, $type = Horde_Service_Weather::FORECAST_TYPE_STANDARD ) : Horde_Service_Weather_Forecast_WeatherUnderground
return Horde_Service_Weather_Forecast_WeatherUnderground

getRadarImageUrl() public method

Return the URL to a (possibly animated) radar image.
public getRadarImageUrl ( string $location ) : string | boolean
$location string The location
return string | boolean The Url, or false if not available.

getSupportedForecastLengths() public method

Get array of supported forecast lengths.
public getSupportedForecastLengths ( ) : array
return array The array of supported lengths.

searchLocations() public method

Search for a valid location code.
See also: Horde_Service_Weather_Base::searchLocations()
public searchLocations ( $location, $type = Horde_Service_Weather::SEARCHTYPE_STANDARD )

Property Details

$_language protected property

Language to request strings from Google in.
protected string $_language
return string

$iconMap public property

See also: Horde_Service_Weather::$iconMap
public $iconMap