- Entwickler-Doku
- Zum Einstieg: Stud.IP-Entwicklungs-HOWTO
- Überblick
- Fehler berichten
- Entwicklungssystem aufsetzen
- Orientierung im Verzeichnisbaum
- Dateitypen und Coding-Style
- API-Dokumentation
- Die wichtigsten Klassen und Funktionen
- Datenbankzugriffe
- HTML-Ausgaben erzeugen
- Lokalisierung (L10N)
- Rechtestufen
- Asset-Bundling (≥4.2)
- JavaScript in Stud.IP
- Sicherheitsaspekte
- Gute Tipps für den Einstieg
- Was sind Lifters?
- Automatisierte Tests
- HowToResponsiveDesign
- Utf-8
- Zum Einstieg: Stud.IP-Entwicklungs-HOWTO
- Regeln
- Weitere Themen
- Coding Standard
- Formatierungsfunktionen
- Flexi_Templates
- Trails im Kern
- API-Klassen
- AJAX in Stud.IP
- Glossar - Begriffsdefinitionen
- Visual Style Guide
- Einleitung (Stud.IP Design-Philosophie)
- Vier allgemeine Gestaltungsprinzipien für Stud.IP
- Usability-Prinzipien
- Seitenaufbau allgemein
- Design
- Farbe/Farbraum
- Icons
- Schrift
- CSS (Übersicht)
- Interaktionselemente
- Informationspräsentation
- Sprache (Schreibstil)
- Terminologie
- geschlechtergerechte Sprache
- Meldungen
- Sonstiges
- Suche
- Einstellungen
- Einleitung (Stud.IP Design-Philosophie)
- Plugin-Schnittstelle
- Spezielle Klassen
Einsteiger
Grundlagen für Einsteiger
Programmieren für Stud.IP
Bevor man beginnt, zur Entwicklung von Stud.IP beizutragen, sollte man wissen, was Stud.IP CoreGroup, StEPs, TICs, Lifters und BIESTs sind.
Ebenfalls wichtig ist es, den Coding-Stil einzuhalten, sodass der geschriebene Code schneller für andere Stud.IP Entwickler verständlich ist. In dem Zusammenhang sind auch die Namenskonventionen und die Regeln für die PHP Dateiformatierung wichtig.
Entwicklungssystem
Zum Entwickeln für Stud.IP sollte ein Computer. auf dem ein Webserver, mindestens PHP 5, eine MySQL-Datenbank, SVN und eine Entwicklungsumgebung installiert ist, verwendet werden. Wie dies alles eingerichtet wird, beschreibt dieser Artikel.
Für die Unix-Shell gibt es auch einige Befehle, welche die Entwicklung in einem großen Softwaresystem wie Stud.IP erleichtern.
Das Stud.IP System
Stud.IP "Seiten"
In Stud.IP werden neue Seiten nicht als PHP-Skript hinzugefügt, sondern über das Framework Trails. In diesem sind Seiten aufgeteilt in Controller, welche die Programmlogik enthalten und Ansichten (views), welche die Darstellung übernehmen. Sie werden durch sogenannte Flexi-Templates erzeugt, wobei es sich um PHP-Dateien handelt, denen Objekte und Variablen aus dem Controller übergeben werden.
Um einen Controller aufrufen zu können, ist es notwendig, diese in die globale Navigation einzuhängen. Das Vorgehen zum Einhängen unterscheidet sich zwischen Controllern in Plugins und Stud.IP-internen Controllern.
Datenbank-Zugriffe
Intern verwendet Stud.IP PDO, um auf Datenbanktabellen zuzugreifen. Diese Zugriffe sind über SORM (SimpleORMap) abstrahiert. Dabei handelt es sich um ein kleines Framework, welches die Überführung von Datenbankeinträgen in Objekte übernimmt.
Übersetzung
Stud.IP ist momentan (Stand Juni 2016) in zwei Sprachen erhältlich: Deutsch und Englisch. Im Quellcode werden deutsche Zeichenketten verwendet, welche mittels gettext ins Englische übersetzt werden. Für PHP- und JavaScript-Code ist die Vorgehensweise unterschiedlich:
Plugins
Plugins sind ein bedeutender Bestandteil von Stud.IP. Mit diesen kann die Funktionsweise von Stud.IP verändert werden oder es können neue Funktionen zu Stud.IP hinzugefügt werden.
Die folgenden Seiten geben eine Einführung in die Plugin-Entwicklung:
