>> Inhaltsverzeichnis >> Anleitung für Entwickler >> Plugins und Anwendungen erstellen

Anleitung für Entwickler

Plugins und Anwendungen erstellen

Allgemeines

YANA (diese Anwendung) ist ein Komponenten-Framework. Es erlaubt das Schreiben verschiedener Plugins, welche Hand in Hand arbeiten.

Auf diese Weise bleiben dem Programmierer viele Arbeiten erspart. Sie müssen sich beispielsweise keine Sorgen um die Passwortabfrage machen. Es gibt bereits Plugins, welche das zuverlässig für Sie erledigen. Auch das Administrationsmenü ist bereits fix und fertig. Sie müssen es nicht neu schreiben, sondern sie brauchen es einfach nur verwenden. Falls eine Komponente nicht gefällt, kann sie ausgetauscht oder entfernt werden. Falls eine Funktion fehlt, kann sie hinzugefügt werden, ohne andere Plugins verändern zu müssen.

Das Schreiben eines neuen Plugins wird einfacher unter Verwendung des YANA-SDK. Dabei handelt es sich um einen Assistenten, welcher alle erforderlichen Informationen abfragt und dann vollautomatisch eine neue Anwendung für Sie erstellt. Diese müssen Sie lediglich noch Ihren Bedürfnissen anpassen.

Installation des YANA-SDK

Es wird dringend empfohlen, das SDK nur auf Webservern zu installieren, welche für den öffentlichen Zugriff gesperrt sind. Beispielsweise auf einer lokalen Arbeitsstation, welche nicht über Netzwerk erreichbar ist. Das SDK dient ausschließlich dem Zweck der Entwicklung neuer Anwendungen für das Framework. Um es sinnvoll einsetzen zu können, ist es erforderlich, dass der Benutzer lokal an dem jeweiligen Rechner arbeiten kann und Lese- sowie Schreibrechte für die Verzeichnisse und Dateien des Frameworks besitzt, auf dem das SDK installiert ist. Beziehungsweise in der Lage ist, über eine Remote-Verbindung mit diesen Rechten wie ein lokaler Nutzer zu arbeiten. Das SDK ist daher nicht gegen unbefugten Zugriff geschützt.

Bei unsachgemäßer Nutzung können lokal gespeicherte Anwendungen für das Framework gelöscht oder überschrieben werden. Es wird daher dringend empfohlen, regelmäßig Sicherheitskopien der gespeicherten Dateien anzulegen.

Um das SDK zu installieren gehen Sie wie folgt vor:

  1. Installieren und konfigurieren sie das YANA-Framework wie in der Anleitung beschrieben.
  2. Entpacken Sie das Archiv des SDK in das gleiche Verzeichnis wie das soeben installierte Framework. Achten Sie darauf, dass die Verzeichnisstruktur wiederhergestellt wird. Überschreiben Sie bestehende Dateien, falls verlangt.
  3. Rufen Sie die Seite „yana_sdk.php“ in Ihrem Webbrowser auf und folgen Sie den Anweisungen auf dem Bildschirm

Software Developement Kit (YANA-SDK)

Das SDK unterstützt den Entwickler durch eine grafische Oberfläche. Die grafische Oberfläche führt dabei durch vier Schritte, in denen Aussehen, Verhalten und allgemeine Informationen zur Anwendung und zum Urheber bereitgestellt werden können.

Schritt 1: allgemeine Informationen

Formular 1

Vorbereitend müssen zunächst allgemeine Informationen gegeben werden. Siehe Abbildung oben.

Formular 2

Anschliessend können Sie einige Informationen zu Ihrer Person eintragen

Formular 3

Dieser Wert bestimmt, in welcher Reihenfolge Plugins ausgeführt werden. Sicherheitsrelevante Plugins (Passwortabfragen etc.) sollten eine höhere Priorität haben, dadurch werden sie ausgeführt, bevor andere Plugins an der Reihe sind.  Andere Plugins (Log-Files etc.) sollten eine niedrigere Priorität haben.

Gültige Werte für den Typ der Anwendung sind:
„default“, „primary“, „config“, „read“, „write“,  „security“.

Schritt 2: Schnittstelle editieren

Der zweite Schritt erlaubt dem Entwickler eigene Aktionen zur die Schnittstelle hinzuzufügen.

Falls Sie nur eine einfache Datenbankanwendung erstellen wollen, können Sie diesen Schritt übergehen. Die meisten Standardaktionen, wie das Anzeigen von Datenbankeinträgen, Suche, Editieren, Löschen oder Einfügen, müssen nicht von Hand geschrieben werden. Diese Aktionen erzeugt das SDK automatisch.

Wenn Sie andere Aktionen festlegen möchten, können Sie hier deren Schnittstelle definieren. Dazu können Vorlagen verwendet werden, welche das SDK vorgibt. Ein händische Erstellung ist ebenfalls möglich. Die Schnittstellen können auch nachträglich von Hand verändert werden.

Formular 4

Für einige Standardaktionen gibt es Vorlagen, welche benutzt werden können. Schauen Sie in die Auswahlliste. Wenn eine Option ausgewählt wurde, erscheint zum Vergleich eine Liste der erzeugten Aktionen. Sie können sich die gesamte Schnittstelle anschauen, indem Sie die Option "Schnittstelle von Hand nachbearbeiten" auswählen.

Formular 5

Eine Schnittstelle enthält folgende Informationen:

Formular 6

Diese Option dient zur Kontrolle, beziehungsweise als Alternative Eingabeoberfläche für erfahrene Nutzer. Sie sehen alle definierten Aktionen und können Änderungen vornehmen.

Vorsicht! Fehler können dazu führen, dass das Plugin nicht korrekt erzeugt werden kann.

Schritt 3: GUI generieren

Es kann für Datenbankanwendungen automatisch eine GUI generiert werden. Dazu wird eine Strukturdatei benötigt, welche die Datenbank beshreibt. Aus den Informationen dieser Datei erzeugt das SDK für jede Tabelle automatisch passende Template-Dateien, sowie die dazu passenden Aktionen und erzeugt zudem die erforderlichen Ergänzungen für die Schnittstelle der Anwendung.

Für andere Anwendungen, kann dieser Schritt übergangen werden.

Die folgenden Aktionen und Templates werden erzeugt: zwei alternative Aktionen und Templates zum Anzeigen von Datenbankinhalten, ein Template zum Editieren und Löschen von Einträgen, sowie drei dazu gehörende Aktionen, zum Anzeigen, Speichern und Löschen von Einträgen. Außerdem zwei alternative Templates und passende Aktionen zum Suchen nach Einträgen. Abschliessend ein Template zum Erstellen neuer Einträge, sowie zwei passende Aktionen zum Anzeigen des Formulars und Speichern des neuen Eintrags.

Formular 7

Sollten Sie noch keine Strukturdatei geschrieben haben, können Sie eine solche Datei erzeugen. Geben Sie Namen und Pfad der Datei ein (Dateiendung sollte ".config" sein) und klicken Sie auf die Schaltfläche "abschicken".

Formular 8

Wenn Sie eine Strukturdatei erzeugt oder von Hand geschrieben haben, geben Sie hier bitte den Pfad dieser Datei an. Klicken Sie auf "Durchsuchen", wenn Sie sich nicht sicher sind, wo sich diese befindet.

Schritt 4: Installationsroutine erstellen

In diesem Schritt wird eine SQL-Datei benötigt, welche zuvor erstellt wurde. Das SDK kann automatisch eine Installationsroutine erstellen, welche bei bestehender Datenbankverbindung den Inhalt der SQL-Datei zur Ausführung an das DBMS sendet. Dadurch werden die für die Anwendung erforderlichen Tabellen installiert und initialsiert. Das SDK erstellt diese SQL-Datei NICHT für Sie. Sie können ein externes Programm, beispielsweise "PHPmyAdmin" verwenden um diese Datei zu erzeugen.

Formular 9

Wählen Sie die Quelldatei im SQL-Format aus, welche die Informationen zur Installation der Datenbank enthält.

Erzeugen der Anwendung

Zum Abschliessen der Konfiguration klicken Sie bitte auf die Schaltfläche "Fertigstellen".

Das SDK produziert als Ausgabe ein Skelett der Anwendung, alle erforderlichen Templates, sowie alle notwendigen Konfigurationsdateien. Diese beinhalten insbesondere: Meta-Informationen des Plugins inklusive Beschreibung der Schnittstelle, Meta-Informationen der verwendeten Dateien, Meta-Informationen der verwendeten Templates.

Das soeben generierte Plugin ist sofort lauffähig. Sie finden die entsprechenden Dateien im Verzeichnis "plugins" beziehungsweise "skins/default", unter der ID-Kennung des Plugins.

Plugin installieren

Um das soeben erzeugte Plugin zu testen:

  1. Öffnen Sie die Datei "index.php" in Ihrem Browser
  2. Öffnen Sie das Administrationsmenü. Sie müssen Administratorrechte besitzen. Achten Sie darauf, dass der Expertenmodus gewählt ist.
  3. Wählen Sie im rechten Menü die Schaltfläche "Liste neu laden".
  4. Suchen Sie Ihr Plugin in der Liste und aktivieren Sie es, durch Klick auf den Radiobutton neben dem Namen des Plugins (links=an, rechts=aus)
  5. Speichern Sie Ihre Änderungen.
  6. Melden Sie sich ab.
  7. Der Name der Anwendung erscheint in der Index-Liste. Klicken Sie darauf um die Anwendung zu starten. (der Eintrag in der Index-Liste erscheint nur dann, wenn Sie in der Schnittstelle mindestens 1 Aktion definiert haben, welche den Typ "read" oder "default" und die Zugriffsbeschränkung "0" (=öffentlich) besitzt. Falls nicht, müssen Sie den Namen der gewünschten Aktion über die Adressleiste des Browsers eingeben: index.php?action=my_action. Dieser Mechanismus ist dazu gedacht zu verhindern, dass Plugins, die allein nicht lauffähig sind, oder Adminrechte benötigen, in der öffentlich zugänglichen Index-Liste erscheinen)

© 2001, 2002, 2003, 2004, 2005, 2006Homepage: Thomas Meyer, www.all-community.de