* FORECAST_TYPE_STANDARD - Each Period represents a full day
* FORECAST_TYPE_DETAILED - Each period represents either day or night.
* FORECAST_TYPE_HOURLY - Each period represents a single hour.
*
*
* @var integer
*/
public $detail = Horde_Service_Weather::FORECAST_TYPE_STANDARD;
/**
* Const'r
*
* @param array $properties Forecast properties.
* @param Horde_Service_Weather_base $weather The base driver.
* @param integer $type The forecast type.
*/
public function __construct(
$properties,
Horde_Service_Weather_Base $weather,
$type = Horde_Service_Weather::FORECAST_TYPE_STANDARD)
{
$this->_properties = $properties;
$this->weather = $weather;
$this->_type = $type;
}
public function getIterator()
{
return new ArrayIterator(array_slice($this->_periods, 0, $this->_maxDays));
}
public function getForecastDay($day)
{
return $this->_periods[$day];
}
public function getForecastTime()
{
return false;
}
/**
* Limit the returned number of forecast days. Used for emulating a smaller
* forecast length than the provider supports or for using one, longer
* request to supply two different forecast length requests.
*
* @param integer $days The number of days to return.
*/
public function limitLength($days)
{
$this->_maxDays = $days;
}
} Horde_Service_Weather-2.0.5/lib/Horde/Service/Weather/Forecast/WeatherUnderground.php 0000664 0000766 0000024 00000003774 12150174700 025550 0 ustar
* @license http://www.horde.org/licenses/bsd BSD
* @category Horde
* @package Service_Weather
*/
/**
* Horde_Service_Weather_Forecast_WeatherUnderground
*
* @author Michael J Rubinsky
* 'http_client' - Required http client object
* 'apikey' - Required API key for wunderground.
*
*
* @return Horde_Service_Weather_Base
*/
public function __construct(array $params = array())
{
// Check required api key parameters here...
if (empty($params['apikey'])) {
throw new InvalidArgumentException('Missing required API Key parameter.');
}
if (!empty($params['language'])) {
$this->_language = $params['language'];
}
$this->_apiKey = $params['apikey'];
unset($params['apikey']);
parent::__construct($params);
}
/**
* Obtain the current observations.
*
* @return Horde_Service_Weather_Current
*/
public function getCurrentConditions($location)
{
$this->_getCommonElements(rawurlencode($location));
return $this->_current;
}
/**
* Obtain the forecast for the current location.
*
* @see Horde_Service_Weather_Base#getForecast
*/
public function getForecast(
$location,
$length = Horde_Service_Weather::FORECAST_3DAY,
$type = Horde_Service_Weather::FORECAST_TYPE_STANDARD)
{
$this->_getCommonElements(rawurlencode($location), $length);
return $this->_forecast;
}
/**
* Search for a valid location code.
*
* @param string $location A location search string like e.g., Boston,MA
* @param integer $type The type of search being performed.
*
* @return string The search location suitable to use directly in a
* weather request.
* @throws Horde_Service_Weather_Exception
*/
public function searchLocations($location, $type = Horde_Service_Weather::SEARCHTYPE_STANDARD)
{
switch ($type) {
case Horde_Service_Weather::SEARCHTYPE_STANDARD:
case Horde_Service_Weather::SEARCHTYPE_ZIP:
case Horde_Service_Weather::SEARCHTYPE_CITYSTATE:
return $this->_parseSearchLocations($this->_searchLocations(rawurlencode($location)));
case Horde_Service_Weather::SEARCHTYPE_IP:
return $this->_parseSearchLocations($this->_getLocationByIp(rawurlencode($location)));
}
}
public function autocompleteLocation($search)
{
$url = new Horde_Url('http://autocomplete.wunderground.com/aq');
$url->add(array('query' => $search, 'format' => 'JSON'));
return $this->_parseAutocomplete($this->_makeRequest($url));
}
/**
* Get array of supported forecast lengths.
*
* @return array The array of supported lengths.
*/
public function getSupportedForecastLengths()
{
return array(
3 => Horde_Service_Weather::FORECAST_3DAY,
5 => Horde_Service_Weather::FORECAST_5DAY,
7 => Horde_Service_Weather::FORECAST_7DAY,
10 => Horde_Service_Weather::FORECAST_10DAY
);
}
/**
* Perform an IP location search.
*
* @param string $ip The IP address to use.
*
* @return string The location code.
*/
protected function _getLocationByIp($ip)
{
if ($this->_ipIsUnique($ip)) {
return $this->_makeRequest(
self::API_URL . '/api/' . $this->_apiKey
. '/geolookup/q/autoip.json?geo_ip=' . $ip);
} else {
return $this->_makeRequest(
self::API_URL . '/api/' . $this->_apiKey
. '/geolookup/q/autoip.json');
}
}
/**
* Execute a location search.
*
* @param string $location The location text to search.
*
* @return string The location code result(s).
*/
protected function _searchLocations($location)
{
return $this->_makeRequest(self::API_URL . '/api/' . $this->_apiKey
. '/geolookup/q/' . $location . '.json');
}
/**
* 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 function _getCommonElements($location, $length = Horde_Service_Weather::FORECAST_10DAY)
{
if (!empty($this->_current) && $location == $this->_lastLocation
&& $this->_lastLength >= $length) {
if ($this->_lastLength > $length) {
$this->_forecast->limitLength($length);
}
return;
}
$this->_lastLength = $length;
$this->_lastLocation = $location;
switch ($length) {
case Horde_Service_Weather::FORECAST_3DAY:
$l = 'forecast';
break;
case Horde_Service_Weather::FORECAST_5DAY:
case Horde_Service_Weather::FORECAST_7DAY:
$l = 'forecast7day';
break;
case Horde_Service_Weather::FORECAST_10DAY:
$l = 'forecast10day';
break;
}
$url = self::API_URL . '/api/' . $this->_apiKey
. '/geolookup/conditions/' . $l . '/astronomy/q/' . $location . '.json';
$results = $this->_makeRequest($url, $this->_cache_lifetime);
$station = $this->_parseStation($results->location);
$this->_current = $this->_parseCurrent($results->current_observation);
$astronomy = $results->moon_phase;
$date = clone $this->_current->time;
$date->hour = $astronomy->sunrise->hour;
$date->min = $astronomy->sunrise->minute;
$date->sec = 0;
$station->sunrise = $date;
$station->sunset = clone $date;
$station->sunset->hour = $astronomy->sunset->hour;
$station->sunset->min = $astronomy->sunset->minute;
// Station information doesn't include any type of name string, so
// get it from the currentConditions request.
$station->name = $results->current_observation->display_location->full;
$this->_station = $station;
$this->_forecast = $this->_parseForecast($results->forecast);
$this->_forecast->limitLength($length);
$this->link = $results->current_observation->image->link;
$this->title = $results->current_observation->image->title;
}
/**
* Parses the JSON response for a location request into a station object.
*
* @param StdClass $station The response from a Location request.
*
* @return Horde_Service_Weather_Station
*/
protected function _parseStation($station)
{
// @TODO: Create a subclass of Station for wunderground, parse the
// "close stations" and "pws" properties - allow for things like
// displaying other, nearby weather station conditions etc...
$properties = array(
'city' => $station->city,
'state' => $station->state,
'country' => $station->country_iso3166,
'country_name' => $station->country_name,
'tz' => $station->tz_long,
'lat' => $station->lat,
'lon' => $station->lon,
'zip' => $station->zip,
'code' => str_replace('/q/', '', $station->l)
);
return new Horde_Service_Weather_Station($properties);
}
/**
* Parses the forecast data.
*
* @param stdClass $forecast The result of the forecast request.
*
* @return Horde_Service_Weather_Forecast_WeatherUnderground The forecast.
*/
protected function _parseForecast($forecast)
{
return new Horde_Service_Weather_Forecast_WeatherUnderground(
(array)$forecast, $this);
}
/**
* Parses astronomy information. Returned as an array since this will be
* added to the station information.
*
* @param {[type]} $astronomy [description]
* @return {[type]}
*/
protected function _parseAstronomy($astronomy)
{
// For now, just cast to array and pass back, we need to normalize
// at least the moon data. (Given in percent illumindated and age -
// need to parse that into phases.)
return (array)$astronomy;
}
/**
* Parse the current_conditions response.
*
* @param stdClass $current The current_condition request response object
*
* @return Horde_Service_Weather_Current
*/
protected function _parseCurrent($current)
{
// The Current object takes care of the parsing/mapping.
return new Horde_Service_Weather_Current_WeatherUnderground((array)$current, $this);
}
protected function _parseSearchLocations($response)
{
if (!empty($response->response->error)) {
throw new Horde_Service_Weather_Exception($response->response->error->description);
}
if (!empty($response->response->results)) {
$results = array();
foreach ($response->response->results as $location) {
$results[] = $this->_parseStation($location);
}
return $results;
} else {
return $this->_parseStation($response->location);
}
}
protected function _parseAutocomplete($results)
{
$return = array();
foreach($results->RESULTS as $result) {
$new = new stdClass();
$new->name = $result->name;
$new->code = $result->l;
$return[] = $new;
}
return $return;
}
protected function _makeRequest($url, $lifetime = 86400)
{
$cachekey = md5('hordeweather' . $url);
if ((!empty($this->_cache) && !$results = $this->_cache->get($cachekey, $lifetime)) ||
empty($this->_cache)) {
$url = new Horde_Url($url);
$response = $this->_http->get($url);
if (!$response->code == '200') {
Horde::logMessage($response->getBody());
throw new Horde_Service_Weather_Exception($response->code);
}
$results = $response->getBody();
if (!empty($this->_cache)) {
$this->_cache->set($cachekey, $results);
}
}
$results = Horde_Serialize::unserialize($results, Horde_Serialize::JSON);
if (!($results instanceof StdClass)) {
throw new Horde_Service_Weather_Exception('Error, unable to decode response.');
}
return $results;
}
} Horde_Service_Weather-2.0.5/lib/Horde/Service/Weather/WeatherUnderground_Strings.php 0000664 0000766 0000024 00000007053 12150174700 025505 0 ustar
* @license http://www.horde.org/licenses/bsd BSD
* @category Horde
* @package Service_Weather
*/
/**
* Horde_Service_Weather_Wwo
*
* @author Michael J Rubinsky
* 'http_client' - Required http client object
* 'apikey' - Required API key for wunderground.
*
*
* @return Horde_Service_Weather_Base
*/
public function __construct(array $params = array())
{
// Check required api key parameters here...
if (empty($params['apikey'])) {
throw new InvalidArgumentException('Missing required API Key parameter.');
}
$this->_key = $params['apikey'];
unset($params['apikey']);
parent::__construct($params);
}
/**
* Obtain the current observations.
*
* @return Horde_Service_Weather_Current
*/
public function getCurrentConditions($location)
{
$this->_getCommonElements($location);
return $this->_current;
}
/**
* Obtain the forecast for the current location.
*
* @see Horde_Service_Weather_Base#getForecast
*/
public function getForecast(
$location,
$length = Horde_Service_Weather::FORECAST_3DAY,
$type = Horde_Service_Weather::FORECAST_TYPE_STANDARD)
{
$this->_getCommonElements($location);
return $this->_forecast;
}
/**
* Search for a valid location code.
*
* @param string $location A location search string like e.g., Boston,MA
* @param integer $type The type of search being performed.
*
* @return string The search location suitable to use directly in a
* weather request.
*/
public function searchLocations($location, $type = Horde_Service_Weather::SEARCHTYPE_STANDARD)
{
switch ($type) {
case Horde_Service_Weather::SEARCHTYPE_STANDARD:
case Horde_Service_Weather::SEARCHTYPE_IP:
return $this->_parseSearchLocations($this->_searchLocations($location));
}
}
public function autocompleteLocation($search)
{
$url = new Horde_Url(self::SEARCH_URL);
$url->add(array(
'q' => $search,
'format' => 'json',
'num_of_results' => 25));
return $this->_parseAutocomplete($this->_makeRequest($url));
}
/**
* Get array of supported forecast lengths.
*
* @return array The array of supported lengths.
*/
public function getSupportedForecastLengths()
{
return array(
3 => Horde_Service_Weather::FORECAST_3DAY,
5 => Horde_Service_Weather::FORECAST_5DAY
);
}
/**
* 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 function _getCommonElements($location, $length = Horde_Service_Weather::FORECAST_5DAY)
{
if (!empty($this->_current) && $location == $this->_lastLocation
&& $this->_lastLength == $length) {
return;
}
$this->_lastLength = $length;
$this->_lastLocation = $location;
$url = new Horde_Url(self::API_URL);
// Not sure why, but Wwo chokes if we urlencode the location?
$url->add(array(
'q' => $location,
'num_of_days' => $length,
'includeLocation' => 'yes',
'localObsTime' => 'yes'));
$results = $this->_makeRequest($url);
$station = $this->_parseStation($results->data->nearest_area[0]);
// Current conditions
$this->_current = $this->_parseCurrent($results->data->current_condition);
// Sunrise/Sunset
$date = $this->_current->time;
$station->sunset = new Horde_Date(
date_sunset(
$date->timestamp(),
SUNFUNCS_RET_TIMESTAMP,
$station->lat,
$station->lon)
);
$station->sunrise = new Horde_Date(
date_sunrise(
$date->timestamp(),
SUNFUNCS_RET_TIMESTAMP,
$station->lat,
$station->lon)
);
$station->time = (string)$date;
$this->_station = $station;
$this->_forecast = $this->_parseForecast($results->data->weather);
}
/**
* Parses the JSON response for a location request into a station object.
*
* @param StdClass $station The response from a Location request.
*
* @return Horde_Service_Weather_Station
*/
protected function _parseStation($station)
{
$properties = array(
// @TODO: can we parse cith/state from results?
'name' => $station->areaName[0]->value . ', ' . $station->region[0]->value,
'city' => $station->areaName[0]->value,
'state' => $station->region[0]->value,
'country' => $station->country[0]->value,
'country_name' => '',
'tz' => '', // Not provided, can we assume it's the location's local?
'lat' => $station->latitude,
'lon' => $station->longitude,
'zip' => '',
'code' => $station->latitude . ',' . $station->longitude
);
return new Horde_Service_Weather_Station($properties);
}
/**
* Parses the forecast data.
*
* @param stdClass $forecast The result of the forecast request.
*
* @return Horde_Service_Weather_Forecast_Wwo The forecast.
*/
protected function _parseForecast($forecast)
{
$forecast = new Horde_Service_Weather_Forecast_Wwo($forecast, $this);
return $forecast;
}
/**
* Parse the current_conditions response.
*
* @param stdClass $current The current_condition request response object
*
* @return Horde_Service_Weather_Current
*/
protected function _parseCurrent($current)
{
// The Current object takes care of the parsing/mapping.
$current = new Horde_Service_Weather_Current_Wwo($current[0], $this);
return $current;
}
protected function _parseAutocomplete($results)
{
$return = array();
if (!empty($results->search_api->result)) {
foreach($results->search_api->result as $result) {
if (!empty($result->region[0]->value)) {
$new = new stdClass();
$new->name = $result->areaName[0]->value . ', ' . $result->region[0]->value;
$new->code = $result->latitude . ',' . $result->longitude;
$return[] = $new;
}
}
}
return $return;
}
/**
* Execute a location search.
*
* @param string $location The location text to search.
*
* @return string The location code result(s).
*/
protected function _searchLocations($location)
{
$url = new Horde_Url(self::SEARCH_URL);
$url = $url->add(array(
'timezone' => 'yes',
'q' => $location,
'num_of_results' => 10));
return $this->_makeRequest($url);
}
protected function _parseSearchLocations($response)
{
if (!empty($response->error)) {
throw new Horde_Service_Weather_Exception($response->error->msg);
}
// Wwo's location search is pretty useless. It *always* returns multiple
// matches, even if you pass an explicit identifier. We need to ignore
// these, and hope for the best.
if (!empty($response->search_api->result)) {
$results = array();
return $this->_parseStation($response->search_api->result[0]);
}
return array();
}
/**
* Make the remote API call.
*
* @param Horde_Url $url The endpoint.
*
* @return mixed The unserialized results form the remote API call.
* @throws Horde_Service_Weather_Exception
*/
protected function _makeRequest(Horde_Url $url)
{
$url->add(
array(
'format' => 'json',
'key' => $this->_key)
)->setRaw(true);
$cachekey = md5('hordeweather' . $url);
if ((!empty($this->_cache) && !$results = $this->_cache->get($cachekey, $this->_cache_lifetime)) ||
empty($this->_cache)) {
$response = $this->_http->get($url);
if (!$response->code == '200') {
Horde::logMessage($response->getBody());
throw new Horde_Service_Weather_Exception($response->code);
}
$results = $response->getBody();
if (!empty($this->_cache)) {
$this->_cache->set($cachekey, $results);
}
}
$results = Horde_Serialize::unserialize($results, Horde_Serialize::JSON);
if (!($results instanceof StdClass)) {
throw new Horde_Service_Weather_Exception('Error, unable to decode response.');
}
return $results;
}
} Horde_Service_Weather-2.0.5/lib/Horde/Service/Weather/Wwo_Strings.php 0000664 0000766 0000024 00000002605 12150174700 022443 0 ustar
* @license http://www.horde.org/licenses/bsd BSD
* @category Horde
* @package Service_Weather
*/
/**
* Horde_Service_Weather class
*
* @author Michael J Rubinsky ;;{{{宮N3./=~t}NFF466m yllLv8 瓇䓓.Kp}}} `())A[%*P]]+,*J`gZ[Dyy9'ezģGVE}}=N#$Ih4n 8iz$dDUcbZZZhӃv"MMMP [=;5p*zwph8eaX
2.-hDCC`xP?5b\˅z
l0#LMMIb ̲}}}e? v uuu1uGwxeg&3~bh ̠?8 m w~/oo㻼R! lvV/z