jsWeather bietet eine Lösung, allgemein verfügbare Wetterdaten aufzubereiten und benutzerfreundlich anzuzeigen. Dafür wird die einfach und sicher zu nutzende Wetter Anwendungsschnittstelle (API) von "OpenWeatherMap" verwendet.
OpenWeatherMap ist ein kommerzieller Onlinedienst, der eine Schnittstelle für den Abruf von Wetterdaten, Wettervorhersagen sowie historische Wetterdaten für die Entwickler von Webanwendungen und mobilen Geräten bereitstellt. Ein Teil der verfügbaren Daten kann nach Anmeldung kostenlos abgerufen werden.
Mit der Nutzung von OpenWeatherMap konnten drei Programmentwicklungen verwirklicht werden:
- jsWeather php-Klasse für die vereinfachte Nutzung von der OpenWeatherMap API
- jsWeather - ein Module für Joomla Version 4
- Web Anwendung für aktuelle Wetterinformationen und eine Wettervoraussage
jsWeather Joomla Module
jsWeather ist ein einfaches und vielseitiges Joomla-Modul, das Wetterinformationen für jeden Ort anzeigt, einschließlich von Informationen wie, Luftfeuchtigkeit, Luftdruck, Wind, Sicht. Es wurde von jschmidt-systemberatung unter Verwendung der letzten aktuellen Version von openWeatherMap als Wetterdatenquelle entwickelt.Hauptmerkmale von jsWeather sind u.A.:
- Eine einfach zu nutzende und dynamische Anzeige von Wetterdaten
- Nutzt Wetterdaten, die über einen Standortnamen, geographische Koordinaten oder die Geolokation von Besuchern geliefert werden.
- für bessere Performance und System Nutzung können Wetterdaten zwischengespeichert (cached) werden
- OpenWeatherMap API Unterstützung
1. Installation
Sie können das jsWeather Module über die Methode Aus Webkatalog installieren auf Ihre Joomla-Site installieren, da das jsWeather Module in der Extensions-Datenbank von Joomla verfügbar ist. Sie können aber auch die jsWeather Module Installationsdatei von meiner Website herunterladen und via Admin Backend Installieren.2. Konfiguration
Für den Einsatz des Moduls müssen Sie sich den kostenlosen API key von OpenWeatherMap" besorgen. Rufen Sie dann im Joomla admin Backend via "system->site Module" das Einrichtungs-Menu für Module auf. Klicken Sie im Menu den "Neu -Button" und selektieren Sie dann das Module "jsWeather".Damit öffnet sích das HTML-Formular zum Konfigurieren des Moduls. Nutzen sie bitte in dem Formular die notwendigen Informationen für die Konfiguration mit der Option "Inline Hilfe umschalten". Damit werden Hilfetexte zu den jeweilige Moduleeinstellungen eingeblendet. Desweiteren beachten sie die anderen notwendigen Joomla Einstellungen (z. B. "Position", "Status", Menuzuweisung, etc.). Sie können z.B. über die Option "Erweitert" die Modul Layouts "default" oder "horizontal" auswählen.
Diese Anwendung zeigt Wetterinformationen für jeden beliebigen Ort - bitte treffen Sie Ihre Auswahl.
Die Vorhersage stellt die Wetterentwicklung in einem beliebigen Ort für die jeweilige Mittagszeit für 5 Tage dar. Zusätzlich dazu wird in einem Diagramm gezeigt, wie sich die tägliche Temperatur entwickeln wird.
Hinweise zu dieser Anwendung
Die Daten für diese Anwendung werden über einen Webservice von "OpenWeathermap" bereitgestellt. Mit der Web-Anwendung "jsWeather" werden diese Daten aufbereitet und in obigen Format angezeigt.
Installation und Konfiguration
Die Installation ist unkompliziert. Sobald Sie die Installationsdatei "jsweather-v1.0.2.zip" heruntergeladen haben, entpacken Sie sie und laden Sie alle Ordner und Dateien auf Ihre Website in ein zugängliches Verzeichnis hoch. (oder wenn Sie XAMPP verwenden, kopieren Sie Ordner und Dateien in ein zugängliches Verzeichnis. "Zugänglich" bedeutet, dass Sie Zugriff auf alle Dateien über ihren Webserver (z. B. Apache) und den Browser haben. Bitte behalten Sie die Verzeichnisstruktur und die Benennung von Ordnern bei (keine Verzeichniss umbenennen).
Editieren Sie nun die Konfigurationsdatei "sample_settings.php". Konfigurieren sie Folgende php-Variablen:
- $key ihr API Key von openWeatherMap
- $location ihre default Lokation (z. B. Frankfurt")
- $use_ip Benutzung eines Geolocation server (z.B. "false oder true")
- $cachetime / $cachetime2 Speicherzeit für das Cachen von Wetter Daten in Sekunde (z. B. 3600 für 1h)
- $lang Sprache (z. B. "de" für Deutsch)
- $units Temperatureinheit ( "metric" für Celsius "imperial" für Fahrenheit)
In der Datei jsweather.ini sind Nachrichten für die Sprachen "Deutsch, Französisch und English enthalten. Bei Bedarf können sie die Einträge anpassen bzw. neue Spachen hinzufügen
Übrprüfen sie nun, ob mit der url ""installationsverzeichnisjsweather/index.php, ob ihre Installation erfolgreich war.
Unter Joomla nutzen Sie am besten die Anwendung mit den Möglichkeiten der jphpx Komponente oder des jphpx Plugins wie es auch hier in dieser Dokumentation mit dem jphpx plug-tag implementiert ist.
.jsWeather unter Joomla nutzen
Eigenständige Lösungen von Web Anwendungen lassen sich nur eingechränkt in eine Joomla Umgebung integrieren (z.B. nit Joomlas Iframe Warapper Umgebung). So erlaubt Joomla zum Beispiel nicht,
dass php-Code in Inhalten verwendet werden darf.
Mit meiner joomla Erweiterung, jjphpx System Package, ist es aber möglich trotz dieser Einschränkung eigene Web Lösungungen unter dem Dach von Joomla auszuführen und auch alle Möglichkeiten von Joomla zu nutzen. Ich zeige hier, wie dies auch für die Web Anwendung, jsWeather möglich gemacht wird.
In schnellen und einfachen drei Schritten ist dafür eine Lösung erstellt:
1. jphpx Code Entries einrichten
Über den Menupunkt "Komponenten" im Administrator Backend selektiert man die Option "jphpx Anwendung" bzw. "jphpx Code Entry". Damit wird die Komponente aufgerufen und man kann nun mit dem Button "Neu" eine neue jphpx Anwendung definieren. Dafür muss ein Titel der Anwendung, die Quelle (der Pfad und der Filename), der Zugriff und die Aktivierung eingetragen werden. Mit dem Button "Speichern" wird der neue Code Entry nach erfolgreichem Speichern verfügbar.
Erstellen Sie so die Entries für folgende php-Anwendiugs Scripte
- Aktuelles Wetter: "ihr-verzeichnis/jsweather/jphpx/get_current_weather.php"
- Wettervorraussage: "ihr-verzeichnis/jsweather/jphpx/get_weather.php"
- Liniendiagramm: "ihr-verzeichnis/jsweather/phpRGraph/jphpx_line_temperatur.php"
- Cache löschen: "ihr-verzeichnis/jsweather/jphpx/delete_cache.php"
2. jsWeather Konfiguration anpassen
In dere Konfigurations-Datei "settngs.php" im Verzeichnis: "ihr-verzeichnis/jsweather/jphpx" müssen nun die id-Nummern der jphpx code entries eingetragen bzw. aktualisiert werden.
- $jphpx_current=ihre-id1;
- $jphpx_forecast=ihre-id2.;
- $jphpx_rgraph=ihre-id3;
- $jphpx_delete=ihre-id4;
3. jphpx plugin oder jphpx Komponente einsetzen
Hinweis: überprüfen Sie, ob die jphpx plugin Version 1.3.3.4 oder höher installiert ist.
Im letzten Schritt werden Anwendungen für Ihre Joomla Site verfügbar gemacht. Dazu wird ein neuer oder bestehender Joomla Artikel mit z .B. erklärenden oder einführenden Text zu der Wetter Anwendung verwendet. Die gewünschte jsWeather Webanwendung wird mit einem jphpx plugin Tag im Inhalt definiert:
- Für das aktuelle Wetter:
{jphpx [ihr-verzeichnis/jsweather/jphpx/get_current_weather.php]}oder{jphpx [ihr-verzeichnis/jsweather/jphpx/current.php]} - Für die Wettervoraussage:
{jphpx [ihr-verzeichnis/jsweather/jphpx/get_weather.php]}oder{jphpx [ihr-verzeichnis/jsweather/jphpx/forecast.php]} - Für das aktuelle Wetter und Wettervoraussage:
{jphpx [ihr-verzeichnis/jsweather/jphpx/weather_info.php]}
Nun braucht es nur noch einen Link, um zu die neue Seite mit Ihrem Wetterinformation aufrufen zu können. Dies lässt sich z. B. mit dem Einrichten eines neuen Menu Punktes zum Aufruf des Artikels/der Seite erreichen.
Wie man jsWeather mit jphpx-Komponente oder -Modul verwendet, lesen Sie bitte die jphpx-Referenz über jphpx-Komponente und -Modul.
jsWeather Application Klasse
Für Entwickler von php-Web Anwendungen wird hier die jsWeather Application Klasse dokumentiert. Die Schnittstelle dazu wird mit einer php-Klasse erstellt. Diese Klasse "js_weather" unterstützt hauptsächlich das Bereitstellen von Wetterdaten von OpenWeatherMap in Form von JSON-Objekten für die weitere Aufbereitung und Darstellung z B: für eine Wettervoraussage oder eine Anzeige der aktuellen Wetterlage.js_weather Klasse
Über den Konstruktor "js_weather" __construct ($api_key, $forecast = false)
wird ein js_weather Objekt erzeigt. Ein notwendige Parameter ist der API-Key von openWeatherMap, der zweite Parameter definiert ob Daten zur Wettervoraussage oder über das laufende Wetter geliefert werden sollen. Beispiel:
my_weather = new js_weather ($api_key, true);
Mit die Methode "setLocation" setLocation ($location, $use_ip = false) wird der Standort für die Wetterdaten angegeben. Das Format ist entweder ein Ortsname oder eine Angabe von geografischen Koordinaten. Falls der zweite Parameter ($use_ip) auf "true" gesetzt wird, wird versucht die Lokation über einen Geolocation Server zu liefern. Der Rückgabewert ist bei erfolgreicher Ausführung "true". Beispiel:
$rc = my_weather->setLocation("52.3472,14.5506");
Die Wetterdaten werden mit der Methode get_weather_data ($dir = null) geliefert. Wenn der Parameter $dir ein gültiges Verzeichnis angibt, werden bei erfolgreichen Anfrage die Wetterdaten zusätzlich in der File "save_weatherdata.$id" gesichert. Der Suffix "$id" kann mit der Methode "setID($id)". gesetzt weden (default ist "1"). Die Sicherungsdatei wird z.B. beim jsWeather joomla Module für das Caching der Wetterdaten vewendet. Beispiel:
$weather_info = $myweather->get_weather_data());Das Ausgabeformat ist immer ein JSON Objekt. Die Struktur dieses Objekts ist bei openWeatherMap z,B für Wettervoraussagen dokumentiert.
Zusätzlich sind für den Einsatz "getter" und "setter" Methoden verfügbar:
- getUseIP () Prüft ob der Geolocation Server erfolgreich war
- getTag () Liefert den Länder Code des Website Besuchers bei erolgreicher Geolocation Zuordnung
- getLocation () liefert die definierte Lokation
- setLanguage ($tag) setzt die Landessprache (default "de" für Deutsch)
- getLanguage () liefet die Landessprache
- setID ($id) setzt eine id
- getID () liefert eine id
- setUnits ($units) definiert die Temperatureinheit - "metric" bzw. "1" für Celsius oder "imperial" bzw. "2" für Fahrenheit.
- getunits () liefer die Temperatureinheit
Hinweise
Die js_weather Klasse ist unter dem Namespace "js_weather" definiert - d.h. um die Klasse erfolgreich zu nutzen ist eine "use - Anweisung" erforderlich (z. B. "use \myapp\js_weather").Beipiele
Die jsWeather Application Klasse wird zum Beispiel von Joomla jsWeather Module und der hier gezeigten Wettervoraussage verwendet.Hinweise
Beim Einsatz von Geolocation Servern wird versucht, über die Internet Adresse des Website Besuchers die geografischen Koordinaten zu liefern. Diese Ortszuordnung kann aber nur so genau sein, wie sie in den jeweiligen Daten vorliegen, die von den Internet Providern zur Verfügung gestellt wurden. Man kann davon ausgehen, dass IP-basierte Geolokalisierungsdienste eine Genauigkeit von 55 bis 80 Prozent für die Region oder den Staat eines Benutzers bieten.
Wetterdaten sind niemals "punktgenau" sie beziehen sich immer auf eine mehr oder weniger große Region. Deshalb kann es durchaus sein, dass z. B. Regen angezeigt wird, obwohl am gewählten Ort kein Regen in Sicht ist.
Falls bei einer gültigen Eingabe eines Standort ein Fehler "400" auftritt, sollte man den Ortsnamen in Kleinbuchstaben eingeben und dann die Anforderung wiederholen. Sollte dies auch zu dem gleichen Fehler führen, geben Sie die die geografischen Koordinaten des Standorts ein.
Download jsWeather
jsWeather ist freie Software (wie Joomla!) - jedoch müssen Sie die GPL-Linzenzbestimmungen für seinen Einsatz beachten. Mehr über GPL und freie Software kann man bei GNU Org finden.
Zum Download von jsWeather klicken Sie das "download" Bild:
jsWeather module Version 1.1 für Joomla!
jsWeather Web-Anwendung und js_weather class
Noch Fragen? Besuchen Sie das Support Forum oder senden Sie eine Email an den Entwickler, unseren Webmaster.
