PHP Class Horde_Service_Weather_Wwo, horde

Author: Michael J Rubinsky ([email protected])
Inheritance: extends Horde_Service_Weather_Base
Afficher le fichier Open project: horde/horde

Méthodes publiques

Свойство Type Description
$iconMap
$link string
$title string

Protected Properties

Свойство Type Description
$_key string Wwo API key.
$_version integer API Version

Méthodes publiques

Méthode 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.

Méthodes protégées

Méthode 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.

Method Details

__construct() public méthode

Constructor.
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.
Résultat Horde_Service_Weather_Wwo

_getCommonElements() protected méthode

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 ( string $location, integer $length = Horde_Service_Weather::FORECAST_5DAY )
$location string The location identifier.
$length integer The forecast length.

_makeRequest() protected méthode

Make the remote API call.
protected _makeRequest ( Horde_Url $url ) : mixed
$url Horde_Url The endpoint.
Résultat mixed The unserialized results form the remote API call.

_parseAutocomplete() protected méthode

protected _parseAutocomplete ( $results )

_parseCurrent() protected méthode

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

_parseForecast() protected méthode

Parses the forecast data.
protected _parseForecast ( stdClass $forecast ) : Horde_Service_Weather_Forecast_Wwo
$forecast stdClass The result of the forecast request.
Résultat Horde_Service_Weather_Forecast_Wwo The forecast.

_parseSearchLocations() protected méthode

protected _parseSearchLocations ( $response )

_parseStation() protected méthode

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.
Résultat Horde_Service_Weather_Station

_searchLocations() protected méthode

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

autocompleteLocation() public méthode

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

getCurrentConditions() public méthode

Obtain the current observations.
See also: Horde_Service_Weather_Base::getCurrentConditions
public getCurrentConditions ( $location ) : Horde_Service_Weather_Current_Wwo
Résultat Horde_Service_Weather_Current_Wwo

getForecast() public méthode

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 )

getSupportedForecastLengths() public méthode

Return the supported forecast lengths.
See also: Horde_Service_Weather_Base::getSupportedForecastLengths
public getSupportedForecastLengths ( )

searchLocations() public méthode

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

Property Details

$_key protected_oe property

Wwo API key.
protected string $_key
Résultat string

$_version protected_oe property

API Version
protected int $_version
Résultat integer

$iconMap public_oe property

See also: Horde_Service_Weather::$iconMap
public $iconMap

$title public_oe property

See also: Horde_Service_Weather_Base::$title
public string $title
Résultat string