Download the PHP package kabudu/forecast-tools without Composer

On this page you can find all versions of the php package kabudu/forecast-tools. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of kabudu/forecast-tools

Informations about the package forecast-tools

ForecastTools

Wrapper for Forecast.io API that supports many simultaneous API calls, substantially reducing wait time for any applications needing to look up weather conditions en masse.

Note: If you will never want to make more than one request at a time or cache the results, you might want to try Guilherm Uhelski’s simpler forecast-php project.

About the Forecast API

The easiest, most advanced, weather API on the web
The same API that powers Forecast.io and Dark Sky for iOS can provide accurate short and long­ term weather predictions to your business, application or crazy idea.

Power of Multi cURL

The included example.php was used to demonstrate various combinations of numbers of total requests and numbers of simultaneous threads. This table shows the results in seconds, where each value is an average of three trials. 

              Total Requests      
Threads    10    100    250     500
      1  3.25  31.39  75.19  155.73
      5  1.00   9.49  23.02   43.05
     10  0.65   5.36  14.61   27.04
     25  0.49   5.02   9.90   18.20
     50  0.59   2.93   6.97   14.74
    100  0.50   2.35   7.23   12.14

This shows more than a tenfold speed increase using ForecastTools with 100 threads over using the single execution available in other projects. Note: The Dark Sky Company recommends 10 threads due to server load concerns, so that is the current default. Please use discretion in changing this value.

Requirements

PHP configuration

To handle multiple simultaneous API calls, this wrapper requires cURL and relies on libcurl-multi. If you have cURL installed, you likely have what you need.

For single API calls, this wrapper uses cURL if available and falls back on the PHP function file_get_contents, which itself requires allow_url_fopen On in your php.ini file, which enables URL-aware fopen wrappers.

API key

You need an API key, which is available after signing up for Forecast for Developers.

Installation

FTP program

  1. Download ForecastTools
  2. Extract the ZIP file
  3. Rename ForecastTools-master to ForecastTools
  4. Upload ForecastTools to your web server using an FTP program

Console (advanced)

Here is how you could copy the files to your server if your web root is /var/www/html:

$ cd /var/www/html
$ wget -O ForecastTools.zip https://github.com/CNG/ForecastTools/archive/master.zip
$ unzip ForecastTools.zip
$ rm -f ForecastTools.zip
$ mv ForecastTools-master ForecastTools

Composer (advanced)

Structure

This project is a series of classes that implement the various branches of the API response. The PHP files in lib are thoroughly documented to the point you can rely on them and not need to refer to the official API documentation.

Here is the basic structure:

Forecast objects make requests to the API and can return ForecastResponse objects that wrap the JSON response. ForecastResponse objects can return ForecastDataPoint objects for accessing weather conditions, as well as ForecastAlert and ForecastFlags objects for accessing metadata.

Usage

Current conditions, single request

Here is how you could get the current temperature given some GPS coordinates:

You can disregard the getter methods of the ForecastDataPoint, ForecastAlerts and ForecastFlags classes and deal directly with the API response. Continuing from above:

Historical conditions, many requests

Here is how you could get the temperature at the current time for every month between now and 75 years ago:

Documentation

The PHP files in lib are thoroughly documented to the point you can rely on them and not need to refer to the official API documentation.

There is also documentation generated by phpDocumentor available on my website, or you can generate your own from source with the command:

phpdoc -d /path/to/ForecastTools/lib -t docs --template abstract

In general, anything can return false if the data is not available or if there is an error, so code defensively.

Forecast

Instantiate:

$forecast  = new Forecast('YOUR_API_KEY_HERE');

Single request:

$response  = $forecast->getData(float, float[, int]);

Multiple simultaneous requests:

$requests = array(
  array('latitude' => float, 'longitude' => float, 'time' => int),
  array('latitude' => float, 'longitude' => float, 'time' => int),
  array('latitude' => float, 'longitude' => float, 'time' => int),
);
$responses = $forecast->getData($requests);

Using the redis cache handler:

$predisClient = new \Predis\Client();
$cacheHandler = new \ForecastTools\Cache\RedisCacheHandler($predisClient);

$requests = array(
      array('latitude' => float, 'longitude' => float, 'time' => int, 'cache_enabled' => true, 'cache_handler' => $cacheHandler, 'cache_timeout' => int),          
    );

$responses = $forecast->getData($requests);

ForecastResponse

A ForecastResponse object is used to access the various data blocks returned from Forecast.io for a given request. In general, to determine the weather at a given point in time, one should examine the highest-precision data block defined (minutely, hourly, and daily respectively), taking any data available from from it and falling back to the next-highest precision data block for any properties that are missing for the point in time desired.

It is returned by Forecast->getData()

Single request:

$response->getRawData();

Multiple requests:

foreach ($responses as $response) {
  $response->getRawData();
}

Other methods

Properties of the location of time requested:

Forecast or historical conditions around location and time requested:

The previous three methods take an optional zero based integer argument to return a specific ForecastDataPoint object in the set. Can be used in conjunction with getCount(string).

ForecastDataPoint

A ForecastDataPoint object represents the various weather phenomena occurring at a specific instant of time, and has many varied methods. All of these methods (except time) are optional, and will only be set if we have that type of information for that location and time. Please note that minutely data points are always aligned to the nearest minute boundary, hourly points to the top of the hour, and daily points to midnight of that day. Data points in the daily data block (see below) are special: instead of representing the weather phenomena at a given instant of time, they are an aggregate point representing the weather phenomena that will occur over the entire day. For precipitation fields, this aggregate is a maximum; for other fields, it is an average. The following are not implemented as get functions due to lack of documentation: All of the data oriented methods may have an associated error value defined, representing our system’s confidence in its prediction. Such properties represent standard deviations of the value of their associated property; small error values therefore represent a strong confidence, while large error values represent a weak confidence. These properties are omitted where the confidence is not precisely known (though generally considered to be adequate).

ForecastAlert

An alert object represents a severe weather warning issued for the requested location by a governmental authority (for a list of which authorities we currently support, please see data sources at https://developer.forecast.io/docs/v2

ForecastFlags

The flags object contains various metadata information related to the request.

Notes

I have run into some inconsistent errors when testing many (1000+) requests over and over (10+ times), such as cURL coming back with an error like:

Unknown SSL protocol error in connection to api.forecast.io:443

The errors do not happen when doing fewer requests in a short period, so I attributed it to a service limitation. This needs to be explored more if you intend to use ForecastTools to do massive numbers of requests.

Changelog

Improvements to come

I wrote another layer for use in my own app, Weatherbit, that caches requests to a MySQL database to prevent redundant queries to the API. This is especially useful for applications that are likely to make repeated requests for the same information, such as a Weatherbit user checking his 30 day chart every day. I plan to abstract this a bit and include with this wrapper eventually. If you want to see what I did sooner, feel free to send me a message.

All versions of forecast-tools with dependencies

PHP Build Version
Package Version
Requires php Version >=5.3.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package kabudu/forecast-tools contains the following files

Loading the files please wait ....