PHP Class Horde_Service_Weather_Owm, horde

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

Public Properties

Property Type Description
$iconMap
$link string
$title string

Protected Properties

Property Type Description
$_key string Owm API key.
$_locationCode

Public Methods

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.

Protected Methods

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 ( array $results ) : [type]
_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 ( stdClass $response ) : array Return an array of location search results.
_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_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

_getCommonElements() protected method

Populates some common data used by forecasts and current conditions.
protected _getCommonElements ( string $location, integer $length = Horde_Service_Weather::FORECAST_5DAY )
$location string The location identifier.
$length integer The forecast length.

_makeRequest() protected method

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

_parseAutocomplete() protected method

protected _parseAutocomplete ( array $results ) : [type]
$results array An array of Horde_Service_Weather_Station objects.
return [type]

_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_Wwo
$forecast stdClass The result of the forecast request.
return Horde_Service_Weather_Forecast_Wwo The forecast.

_parseSearchLocations() protected method

Return an array of location search results.
protected _parseSearchLocations ( stdClass $response ) : array
$response stdClass The results of a find query.
return array An array of Horde_Service_Weather_Station objects.

_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 request result.
See also: Horde_Service_Weather_Base::autocompleteLocation
public autocompleteLocation ( $search )

getCurrentConditions() public method

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

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 )

getSupportedForecastLengths() public method

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

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

$_key protected_oe property

Owm API key.
protected string $_key
return string

$_locationCode protected_oe property

protected $_locationCode

$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
return string