Joomla!-Extensions entwickeln

Eigene Komponenten, Module und Plugins programmieren

Axel Tüting, Christiane Maier-Stadtherr, René Serradeil

• Verlag: Franzis Verlag
• Jahr: 2012
• ISBN:
  9783645221108
• Thema: Computer Science
• Thema: Web Programming

Manchmal muss es eine eigene Erweiterung sein! Und Erweiterungen für Joomla! zu entwickeln, ist gar nicht so schwer. Dieses Buch zeigt, wie Sie eine maßgeschneiderte Lösung für Ihren Bedarf entwickeln. Die Autoren beschreiben Schritt für Schritt das Vorgehen vom Entwurf bis zur fertigen eigenen Komponente für Joomla! 2.5.

1 Bevor es losgeht

1.1 Die GNU General Public License (GPL)

Warum stellen wir dies an den Anfang unseres Buches?

• Weil es weder Joomla in der jetzigen Form noch dieses Buch noch Ihre zukünftigen Erweiterungen geben würde, wenn es diese Lizenz nicht gäbe.
• Weil Sie selbst verpflichtet sind, die Regeln dieser Lizenz einzuhalten.
• Weil diese Lizenz einen Schutz für Sie gegen Gewährleistungsansprüche darstellt.
• Die meisten Benutzer laden sich Software herunter und bestätigen »Ich bin mit den Lizenzbedingungen einverstanden« ohne darüber nachzudenken, dass sie damit einen Vertrag eingehen, den sie gar nicht kennen. Haben Sie die Lizenzbedingungen jemals vollständig gelesen? Dann sind Sie eine Ausnahme. Dabei ist die Geschichte dieser Lizenz hochinteressant. Sie hat die Welt verändert!

Was ist eigentlich GNU GPL?

de.wikipedia.org/wiki/GNU-Projekt :
Das GNU-Projekt wurde von Richard Stallman mit dem Ziel gegründet, ein vollständig freies Betriebssystem, genannt GNU (»GNU’s Not Unix«), zu entwickeln. Bekannt geworden ist das Projekt vor allem auch durch die von ihm eingeführte GNU General Public License (GPL), unter der viele bekannte Softwareprojekte veröffentlicht werden.
Die vom GNU-Projekt veröffentlichte Software wurde unter eigene Lizenzen gestellt, welche die entsprechenden Freiheiten gewährten. Für das Prinzip einer Lizenz, welche die Pflicht zur Offenheit explizit einbaut, nutzte Stallman den Begriff Copyleft […]. Später entschloss sich Stallman, eine einheitliche Lizenz zu schaffen, unter der alle Software veröffentlicht werden konnte. Er entwarf daher mit Hilfe von Jerry Cohen die GNU General Public License […].

Unter http://www.gnu.org/philosophy/free-sw.htmlist eine Präzisierung dieses Begriffs zu finden. Unter http://www.gnu.de finden Sie die inoffizielle deutsche Übersetzung der verschiedenen Versionen/Varianten der GPL und weitere Informationen. Auch die folgende Übersetzung stammt von dieser Seite.

http://www.gnu.de/free-software/index.de.html
Die freie Software, von der hier die Rede sein soll, ist kein »Freibier«, sondern sie gibt Ihnen die Freiheit,

0. die Software für einen beliebigen Zweck auszuführen,

1. die Funktionsweise der Software zu studieren und sie an Ihre eigenen Bedürfnisse anzupassen,

2. Kopien der Software weiterzugeben,

3. sowie die Software zu verbessern und

4. diese Verbesserungen zu veröffentlichen.

Joomla steht unter GNU GPL. Sie haben also die Freiheit, Joomla bzw. die Joomla-Platform und alle ihre Erweiterungen in diesem Sinne zu verwenden. Und Sie sind verpflichtet, die Software, die Sie damit entwickeln, ebenfalls unter der GPL als freie Software weiterzugeben.

Deshalb muss in allen Programmen, die Sie als Erweiterungen von Joomla erstellen, auch der Hinweis auf die GPL stehen. So wie Sie die Freiheit erhalten haben, den Code von Joomla und jeder Erweiterung zu studieren und zu modifizieren, müssen Sie diese Freiheit auch denen gewähren, die Ihre Programme »für einen beliebigen Zweck« nutzen, egal ob kostenlos oder kostenpflichtig.

Die GPL sagt nicht, dass Sie mit Ihrer Arbeit kein Geld verdienen dürfen! Sie können sich den Aufwand und das Wissen bezahlen lassen, etwas zu programmieren. Aber Sie erstellen auf jeden Fall wieder freie Software und gewähren den Benutzern alle Freiheiten gemäß der GPL. Die Lizenz sagt »alles oder nichts«, einschränkende Klauseln gibt es nicht.

Darüber hinaus beinhaltet die GPL, deren Text jeder unter GPL veröffentlichten Software beizulegen ist, auch eine Warnung: Wer Software einsetzt, die unter GPL steht, hat keinen Gewährleistungsanspruch gegenüber dem Autor. Das Risiko liegt also auf den ersten Blick allein beim Anwender, der die Software benutzen und einsetzen darf, wie sie ist (»as is«). Damit sind Sie zunächst einmal gegen Ansprüche Dritter geschützt, falls Ihre Software fehlerhaft ist.

Gleichfalls gibt diese Freiheit aber Ihren Nutzern auch das Recht etwaige Fehler selbst zu beheben oder Dritte mit der Fehlerbehebung zu beauftragen und nicht darauf warten zu müssen, bis Sie Zeit und Muße finden dies zu tun. Bei proprietären Systemen und Programmen wie sie etwa von Microsoft oder Apple angeboten werden, ist dies nicht der Fall, denn die Quelltexte dieser Programme liegen den Anwendern nicht vor ...

Open Source versus GPL

Was noch wichtig ist: Open Source und die GNU GPL haben nichts miteinander zu tun. Open Source heißt: Der Benutzer darf den Quellcode einsehen, sonst nichts. Kopieren, Modifizieren und Veröffentlichen ist auch bei Offenen Quellen nur erlaubt, wenn der Lizenzgeber der betreffenden Software es gestattet. Selbst wenn der Lizenzgeber das gestattet, kann er immer noch den Einsatz der Software einschränken. Unter GPL gibt es das nicht. Wir erinnern uns, dass noch vor dem »ersten« Punkt stand:

0. die Software für einen beliebigen Zweck auszuführen

Um zu illustrieren, wie weit die Freiheiten gehen, welche die GPL gewährt, sei hier exemplarisch das Projekt WikiLeaks genannt, das 2010 für allerlei Aufregung gesorgt hat. Mediawiki[1], die Basis für die Software von WikiLeaks, steht unter GPL. Die Freiheit, die Software für einen beliebigen Zweck auszuführen gab den Betreibern das Recht, WikiLeaks mit dieser Software zu realisieren und ins Netz zu stellen, ohne dass die Wikimedia-Stiftung[2] als Urheber und Lizenzgeber von Mediawiki dies hätte verbieten oder ahnden können.

Was bedeutet das für uns?

Inzwischen gibt es mehrere GPL-Versionen. Dies ist vor allem den unterschiedlichen Rechtssprechungen der verschiedenen Nationen geschuldet und neuere Fassungen der GPL sind i. d. R. »kompatibler«, aber darauf wollen wir hier wirklich nicht eingehen.

Für unsere Absicht, Erweiterungen für Joomla zu schreiben, brauchen wir nur eines berücksichtigen: Wir erzeugen freie Software und stellen sie (mindestens) unter die General Public License Version 2 (GPLv2 or later).

Häufig liest man die Frage: »Darf ich für meine Erweiterung Geld verlangen?« oder umgekehrt »Darf der für seine Erweiterung Geld verlangen?«. Die Antwort ist »ja«. Wenn das Produkt dem Benutzer/Kunden etwas wert ist, wird er den Preis bezahlen. Wenn ein Benutzer/Kunde die gewünschten Änderungen an einem Programm nicht selbst durchführen kann, kann er den Quelltext jemanden geben, der dies gegen entsprechendes Salär für ihn ausführt.

Arbeitszeit, Know-how, Dienstleistung – das gibt es nicht (immer) kostenlos und der Nutzer einer Software unter GPL hat keinerlei Anspruch darauf, etwas kostenlos zu erhalten.

Es gibt aber einen guten Grund, weshalb Joomla und viele Extensions kostenfrei zu haben sind: Marketing! Unter dem Motto:

»Es kann durchaus sinnvoll sein, Lampen
zu verschenken, um Öl zu verkaufen.«
John D. Rockefeller

1.2 Arbeitsumgebung

Lokale Joomla-Installation

Wir setzen voraus, dass Sie Joomla in der Version 2.5.x mit der deutschen Sprachversion lokal installiert haben. Dann können Sie davon ausgehen, dass die richtige PHP-Version im Einsatz ist und auch sonst alle Systemvoraussetzungen erfüllt sind, sodass der Programmierung nichts im Wege steht.

Der geeignete Arbeitsplatz

Auf einem kleinen Notebook zu programmieren ist mitunter eine Strafe. Ein großer Monitor, auf dem mehrere Fenster gleichzeitig sichtbar sind, schont Augen und Nerven – jedenfalls für Entwickler ab einem gewissen Alter …

Auf den nächsten Seiten stellen wir eine kleine Komponente auf die Beine. Es ist überraschend, wie schnell und einfach das unter Joomla geht. Sie können den Code von http://www.buch.cd herunterladen. Wir empfehlen aber, am Anfang alles selbst zu schreiben, es ist nicht viel. Man bekommt beim Selberschreiben doch ein besseres Gespür für die Zusammenhänge.

Der Quellext-Editor

Professionelle Entwicklung verlangt professionelles Werkzeug. Aber man kann auch klein anfangen. Für die ersten Schritte bei der Programmierung mit Joomla reicht ein einfacher Quelltext-Editor. Windows-Anwendern empfehlen wir Notepad++, der kostenlos von der Website des Anbieters[3] heruntergeladen werden kann. Er bietet alles, was man für den Anfang braucht. Mac-User[4] streiten sich gerne über Textmate, BBEdit oder Textwrangler. Linux-Anwendern eine Empfehlung zu geben ist sicher nicht nötig, da das System schon mit guten Code-Editoren ausgestattet ist.

Der Editor sol...

Inhaltsverzeichnis

• Inhaltsübersicht
• Vorwort
• 1  Bevor es losgeht
• 2  Joomla-Grundwortschatz
• 3  Erste Ausgabe im Frontend
• 4  Unser erstes Modul
• 5  Das erste Plugin
• 6  Sprachen
• 7  Standards, Regeln, Konventionen
• 8  Objekte & Co.
• 9  Die Joomla-API – eine Art Einführung
• 10  Unsere Komponente: Backend
• 11  Formulare cleverer: JForm
• 12  Fehlerbehandlung
• 13  Alles bleibt anders – Exkurs Refactoring
• 14  Filter – Sortierung – Pagination
• 15  Kategorien, User und JForms
• 16  Kosmetik fürs Frontend
• 17  Plugins – Arbeiten im Untergrund
• 18  Module: Daten immer anders
• 19  Die Komponente wird konfigurierbar
• 20  Wer darf was? Zugriffsrechte
• 21  Formular im Frontend
• 22  Routing und SEF
• 23  Installer
• A  Anhang A – Nützliche Links
• B  Anhang B – Events (Plugins)
• C  Anhang C – Entwicklungsumgebung
• Stichwortverzeichnis
• Impressum