forecast.io.php

<?php

/**
 * Helper Class for forecast.io webservice
 */
class ForecastIO
{

    private $api_key;
    private $units;
    private $language;
    //const API_ENDPOINT = 'https://api.forecast.io/forecast/';
    const API_ENDPOINT = 'https://api.darksky.net/forecast/';

    /**
     * Create a new instance
     *
     * @param String $api_key
     * @param String $units
     * @param String $language
     */
    function __construct($api_key, $units = 'auto', $language = 'en')
    {

        $this->api_key = $api_key;
        $this->units = $units;
        $this->language = $language;

    }

    /**
     * @return string
     */
    public function getUnits()
    {
        return $this->units;
    }

    /**
     * @param string $units
     */
    public function setUnits($units)
    {
        $this->units = $units;
    }

    /**
     * @return string
     */
    public function getLanguage()
    {
        return $this->language;
    }

    /**
     * @param string $language
     */
    public function setLanguage($language)
    {
        $this->language = $language;
    }


    private function requestData($latitude, $longitude, $timestamp = false, $exclusions = false)
    {

        $validUnits = array('auto', 'us', 'si', 'ca', 'uk');

        if (in_array($this->units, $validUnits)) {

            $request_url = self::API_ENDPOINT .
                $this->api_key . '/' .
                $latitude . ',' . $longitude .
                ($timestamp ? ',' . $timestamp : '') .
                '?units=' . $this->units . '&lang=' . $this->language .

                ($exclusions ? '&exclude=' . $exclusions : '');

            /**
             * Use Buffer to cache API-requests if initialized
             * (if not, just get the latest data)
             *
             * More info: http://git.io/FoO2Qw
             */

            if (class_exists('Buffer')) {
                $cache = new Buffer();
                $content = $cache->data($request_url);
            } else {
                $content = @file_get_contents($request_url);
            }

        } else {

            return false;

        }

        if (!empty($content)) {

            return json_decode($content);

        } else {

            return false;

        }


    }

    /**
     * Will return the current conditions
     *
     * @param float $latitude
     * @param float $longitude
     * @return \ForecastIOConditions|boolean
     */
    public function getCurrentConditions($latitude, $longitude)
    {

        $data = $this->requestData($latitude, $longitude);

        if ($data !== false) {

            return new ForecastIOConditions($data->currently);

        } else {

            return false;

        }

    }

    /**
     * Will return historical conditions for day of given timestamp
     *
     * @param float $latitude
     * @param float $longitude
     * @param int $timestamp
     * @return \ForecastIOConditions|boolean
     */
    public function getHistoricalConditions($latitude, $longitude, $timestamp)
    {

        $exclusions = 'currently,minutely,hourly,alerts,flags';

        $data = $this->requestData($latitude, $longitude, $timestamp, $exclusions);

        if ($data !== false) {

            return new ForecastIOConditions($data->daily->data[0]);

        } else {

            return null;

        }

    }

    /**
     * Will return conditions on hourly basis for today
     *
     * @param type $latitude
     * @param type $longitude
     * @return \ForecastIOConditions|boolean
     */
    public function getForecastToday($latitude, $longitude)
    {

        $data = $this->requestData($latitude, $longitude);

        if ($data !== false) {

            $conditions = array();

            $today = date('Y-m-d');

            foreach ($data->hourly->data as $raw_data) {

                if (date('Y-m-d', $raw_data->time) == $today) {

                    $conditions[] = new ForecastIOConditions($raw_data);

                }

            }

            return $conditions;

        } else {

            return false;

        }

    }


    /**
     * Will return daily conditions for next seven days
     *
     * @param float $latitude
     * @param float $longitude
     * @return \ForecastIOConditions|boolean
     */
    public function getForecastWeek($latitude, $longitude)
    {

        $data = $this->requestData($latitude, $longitude);

        if ($data !== false) {

            $conditions = array();

            foreach ($data->daily->data as $raw_data) {

                $conditions[] = new ForecastIOConditions($raw_data);

            }

            return $conditions;

        } else {

            return false;

        }

    }


}


/**
 * Wrapper for get data by getters
 */
class ForecastIOConditions
{

    private $raw_data;

    function __construct($raw_data)
    {

        $this->raw_data = $raw_data;

    }

    /**
     * Will return the temperature
     *
     * @return String
     */
    function getTemperature()
    {

        return $this->raw_data->temperature;

    }

    /**
     * get the min temperature
     *
     * only available for week forecast
     *
     * @return type
     */
    function getMinTemperature()
    {

        return $this->raw_data->temperatureMin;

    }

    /**
     * get max temperature
     *
     * only available for week forecast
     *
     * @return type
     */
    function getMaxTemperature()
    {

        return $this->raw_data->temperatureMax;

    }

    /**
     * get apparent temperature (heat index/wind chill)
     *
     * only available for current conditions
     *
     * @return type
     */
    function getApparentTemperature()
    {

        return $this->raw_data->apparentTemperature;

    }

    /**
     * Get the summary of the conditions
     *
     * @return String
     */
    function getSummary()
    {

        return $this->raw_data->summary;

    }

    /**
     * Get the icon of the conditions
     *
     * @return String
     */
    function getIcon()
    {

        return $this->raw_data->icon;

    }

    /**
     * Get the time, when $format not set timestamp else formatted time
     *
     * @param String $format
     * @return String
     */
    function getTime($format = null)
    {

        if (!isset($format)) {

            return $this->raw_data->time;

        } else {

            return date($format, $this->raw_data->time);

        }

    }

    /**
     * Get the pressure
     *
     * @return String
     */
    function getPressure()
    {

        return $this->raw_data->pressure;

    }

    /**
     * Get the dew point
     *
     * Available in the current conditions
     *
     * @return String
     */
    function getDewPoint()
    {

        return $this->raw_data->dewPoint;

    }

    /**
     * get humidity
     *
     * @return String
     */
    function getHumidity()
    {

        return $this->raw_data->humidity;

    }

    /**
     * Get the wind speed
     *
     * @return String
     */
    function getWindSpeed()
    {

        return $this->raw_data->windSpeed;

    }

    /**
     * Get wind direction
     *
     * @return type
     */
    function getWindBearing()
    {

        return $this->raw_data->windBearing;

    }

    /**
     * get precipitation type
     *
     * @return type
     */
    function getPrecipitationType()
    {

        return $this->raw_data->precipType;

    }

    /**
     * get the probability 0..1 of precipitation type
     *
     * @return type
     */
    function getPrecipitationProbability()
    {

        return $this->raw_data->precipProbability;

    }

    /**
     * Get the cloud cover
     *
     * @return type
     */
    function getCloudCover()
    {

        return $this->raw_data->cloudCover;

    }


    /**
     * get sunrise time
     *
     * only available for week forecast
     *
     * @param String $format String to format date pph date
     *
     * @return type
     */
    function getSunrise($format = null)
    {

        if (!isset($format)) {

            return $this->raw_data->sunriseTime;

        } else {

            return date($format, $this->raw_data->sunriseTime);

        }

    }

    /**
     * get sunset time
     *
     * only available for week forecast
     *
     * @param String $format String to format date pph date
     *
     * @return type
     */
    function getSunset($format = null)
    {

        if (!isset($format)) {

            return $this->raw_data->sunsetTime;

        } else {

            return date($format, $this->raw_data->sunsetTime);

        }

    }

}