Joomla! API Referenz Projekt
Aus Joomla! Dokumentation
Ziel des API Referenz Projekts ist es ein nützliches Handbuch für das Joomla! Framework der aktuellen und kommenden Versionen bereitzustellen, welches die automatisch generierte Dokumentation auf api.joomla.org vervollständigen, nicht ersetzen soll.
Eine Liste der Klassen des Frameworks sowie deren Beschreibung sind auf der gleichnamigen Seite dieser Dokumentation zu finden. Diese stellt den Ausgangspunkt der API Referenz dar.
Wenn Sie uns bei dieser Enormen Arbeit unterstützen wollen, ist dafür nicht mehr nötig als sich zu registrieren und los zulegen. Ein guter Einstieg wäre sich auf der Framework Übersicht für eine Klasse zu entscheiden über die Sie etwas wissen, oder mit der Sie aufgrund eigener Projekte bereits gearbeitet haben. Scheuen Sie nicht davor Beispiele, Verbesserungen oder Erklärungen anzufügen. Dies gilt natürlich auch für vorhandene Seiten. Weitere Informationen hierzu erhalten Sie ebenfalls auf der Seite Mithilfe.
Inhaltsverzeichnis |
Los geht's
Der Startpunkt der API Referenz ist die Frameworkseite, die eine komplette Liste aller Joomla! Klassen enthält. Jede Klasse hat eine eigene Wikiseite, die grundlegende Informationen und Beispiele über diese Klasse enthält. Jede Klassenseite wiederum enthält Links zu Seiten, die für die Methodenbeschreibung zuständig sind.
Wichtig ist als erstes, dass Sie sich über den Speicherort der Seite im klaren sind. Die API befindet sich grundsätzlich immer unter Joomla! Programmierung/Framework/, wobei die Klassen nach dem Slash angefügt werden. Wollen Sie z.b. eine Seite über die Klasse JBeispiel verfassen, würde diese auf Joomla! Programmierung/Framework/JBeispiel erstellt werden. Wollen Sie nun zusätzlich eine Methode getMethode der Klasse JBeispiel beschreiben, würden Sie dies auf Joomla! Programmierung/Framework/JBeispiel/getMethode erstellen.
Am Anfang erscheint dieser Weg ein bisschen verwirrend, aber wir haben diese Vorgehensweise aus zwei Gründen gewählt:
- Es wird automatisch ein schöner Pathway vom Wiki generiert, und man findet sehr schnell zurück.
- Die Seiten sind schnell auffindbar, da klar logisch Strukturiert und die Seiten schwirren nicht wahllos im Wiki herum.
Falls Sie nicht sicher sein sollten, ob Ihre Vorschläge sinnvoll sind, können Sie gerne auf der "Diskussion"-Seite ihre Ideen sammeln.
Nützliche Quellen
Natürlich kann nicht jeder alles Wissen, deshalb sind hier ein paar Quellen, die Sie nutzen können um die Klassen zu erweitern:
- Aktueller Quellcode
- Der beste Weg um Informationen über eine Klasse zu finden ist es einfach im Quellcode zu schauen. Alle Klassen der API befinden sich im Ordner
libraries/joomla. Wichtig ist in diesem Fall aber, dass Sie die aktuellste Joomla! Version besitzen.
- Foren
- Es gibt unzählige Joomla! Foren, die einen Entwicklerbereich haben. Dort werden viele Beispiele aufgeführt, die Sie, nach Anfrage an den original Autor, verwenden können.
- Die docs
- Die Joomla! Docs haben selbst viele Beispiele in ihrer API, die exportiert und hier importiert werden können. Dabei ist es wichtig, die J!EDL zu beachten, d.h. die Autorenliste bzw. der Autor muss immer genannt werden.
- Die API
- Auf api.joomla.org gibt es den aktuellsten Quellcode mit phpDocumentator formatiert. Manchen Usern fällt es leichter Informationen von dort zu holen.
Klassenseiten
Seiten, die Klassen beschreiben sollten wie JDocument aufgebaut sein. Sie können die Struktur kopieren, indem Sie auf Bearbeiten klicken und den Quellcode einfach kopieren und in "Ihre" Klasse einfügen. Danach einfach die relevanten Stellen austauschen. Methoden- und Variablenlisten sollten in alphabetischer Reihenfolge aufgebaut sein.
Methodenseiten
Jede public Methode einer Klasse hat eine extra Seite in der API. Dabei wird einfach der Klassenseite /Methodenname angehängt. Als Vorlage können Sie JDocument/addScript nehmen. Wie auch bei den Klassen können Sie einfach auf Bearbeiten und den Quellcode einfach kopieren. Danach die relevanten Stellen austauschen.
Kategorien
Jede Seite in der API besitzt 4 Kategorien:
- [[Kategorie:Experten|<Name der Seite>]]
- Die API ist etwas für Experten, also werden alle Seiten in diese Kategorie eingegliedert.
- [[Kategorie:Joomla! Programmierung|<Name der Seite>]]
- Die Startseite in diesem Bereich ist Joomla! Programmierung, deshalb sollten alle API Seiten auch in dieser Kategorie auftauchen
- [[Kategorie:Framework|<Name der Seite>]]
- Jede Seite der API befindet sich im Framework, also sollte Sie auch in dieser Kategorie erscheinen.
- [[Kategorie:<Klassenname>|<Name der Seite>]]
- Jede Seite, die etwas mit der Klasse zu tun hat, sollte in die Kategorie der Klasse hinzugefügt werden.
<Klassenname>
Wenn Sie in einer Kategorie <Klassenname> einsetzen sollen, so müssen Sie hier den Namen der Klasse einfügen. Bearbeiten Sie z.B. die Seite Joomla! Programmierung/Framework/JBeispiel/getMethode so wäre dies JBeispiel.
<Name der Seite>
Wenn Sie in einer Kategorie <Name der Seite> einsetzen sollen, so müssen Sie hier das letzte Glied des Seitennamen einfügen. Bearbeiten Sie z.B. die Seite Joomla! Programmierung/Framework/JBeispiel/getMethode so wäre dies getMethode.
Zusammengesetzt
Die Kategorien würde bei Joomla! Programmierung/Framework/JBeispiel/getMethode also folgendermaßen lauten:
[[Kategorie:Experten|getMethode]] [[Kategorie:Joomla! Programmierung|getMethode]] [[Kategorie:Framework|getMethode]] [[Kategorie:JBeispiel|getMethode]]
