jsWeather

Installation and Configuration

• $key your API key from openWeatherMap
• $location your default location (e.g. Frankfurt")
• $use_ip Use of a geolocation server (e.g. "false or true")
• $cachetime / $cachetime2 Storage time for caching weather data in seconds (e.g. 3600 for 1h)
• $lang Language (e. g. "en" for English)
• $units Temperature Unit ( "metric" for Celsius or "imperial" for Fahrenheit)

The jsweather.ini file contains messages for the languages ​​"German, French and English. If necessary, you can adapt the entries or add new languages.

Now check whether with the url ""installation directoryjsweather/index.php, whether your installation was successful.

With Joomla, it is best to use the application with the options of the jphpx component or the jphpx Plugins as also implemented here in this documentation with the jphpx plugin-tag.

Use jsWeather on Joomla

Independent web application solutions can only be integrated into a Joomla environment to a limited extent (e.g. with Joomla's Iframe Warapper environment). Also Joomla does not allow that php code may be used in its content. With my joomla extension, jjphpx System Package, it is possible despite this limitation to run your own web solutions under the Joomla umbrella and also to use all the capabilities of Joomla. I will show here how this is also made possible for my web application jsWeather.
A solution is created in three quick and easy steps:

1. Set up jphpx code entries

Select the option "jphpx Application" or "jphpx Code Entry" via the "Components" menu item in the administrator backend. This calls the component and you can now define a new jphpx application with the "New" button. For this, a title of the application, the source (the path and the file name), the access and the activation must be entered. With the "Save" button, the new code entry becomes available after successful saving.
In this way create the entries for the following php application scripts

1. Current weather: "your-directory/jsweather/jphpx/get_current_weather.php"
2. Weather forecast: "your-directory/jsweather/jphpx/get_weather.php"
3. Line graph: "your-directory/jsweather/phpRGraph/jphpx_line_temperatur.php"
4. Delete Cache: "your-directory/jsweather/jphpx/delete_cache.php"

2. Set jsWeather configuration

In the configuration file "settngs.php" in the directory: "your-directory/jsweather/jphpx" update the id numbers of the jphpx code entries.

1. $jphpx_current=your-id1;
2. $jphpx_forecast=your-id2.;
3. $jphpx_rgraph=your-id3;
4. $jphpx_rgraph=your-id4;

3. Use jphpx plugin or jphpx component

Note: Please check that jphpx plugin version 1.3.3.4 or higher has been installed.

In the last step you make the applications available for your Joomla site. Create a new Joomla article with e.g. explanatory or introductory text to your weather application. The respective jsWeather web application is defined with a jphpx plugin tag:

• For the current weather:

  {jphpx [your-directory/jsweather/jphpx/get_current_weather.php]}

  or

  {jphpx [your-directory/jsweather/jphpx/current.php]}

• For the weather forecast:

  {jphpx [your-directory/jsweather/jphpx/get_weather.php]}

  or

  {jphpx [your-directory/jsweather/jphpx/forecast.php]}

• For the current weather and weather forecast:

  {jphpx [your-directory/jsweather/jphpx/weather_info.php]}

How to use jsWeather with jphpx component or module please read jphpx reference about jphpx component and module.

jsWeather Application Class

js_weather class

Via the constructor "js_weather" __construct ($api_key, $forecast = false) a js_weather object is created. A required parameter is the API key of openWeatherMap, the second parameter defines whether data for the weather forecast or about the current weather should be delivered. Example:

my_weather = new js_weather ($api_key, true);

The method "setLocation" setLocation ($location, $use_ip = false) specifies the location for the weather data. The format is either a place name or an indication of geographic coordinates. If the second parameter ($use_ip) is set to "true", an attempt is made to deliver the location via a geolocation server. The return value is "true" if the execution was successful. Example:

$rc = my_weather->setLocation("52.3472,14.5506");

The weather data is returned using the get_weather_data ($dir = null) method. If the $dir parameter specifies a valid directory, the weather data will be saved in the file "save_weatherdata.$id" within directory "$dir". Saving will only be done if the request was successful. The $id suffix can be set using the setID($id) method. set (default is "1"). This function is used e.g. in the jsWeather joomla module for caching the weather data. Example:

$weather_info = $myweather->get_weather_data()); 

In addition, "getter" and "setter" methods are available for use:

• getUseIP () Checks if the geolocation server was successful
• getTag () Returns the country code (e.g. "en") of the website visitor if the geolocation assignment is successful
• getLocation () returns the defined location
• setLanguage ($tag) sets the national language (default "de" for German language)
• getLanguage() returns the local language
• setID ($id) sets an id
• getID () returns an id
• setUnits ($units) defines the temperature unit - "metric" or "1" for Celsius or "imperial" or "2" for Fahrenheit.
• getunits () returns the temperature unit

Notes

Examples