Programmierrichtlinien

Allgemeines

Programmcode ist in strukturierter, möglichst gut lesbarer Form zu erstellen.

Schleifenkörper und Anweisungsblöcke von Verzweigungen sind mindestens 1 (empfohlen 2) Zeichen einzurücken.

PHP, Javascript, CSS und HTML sind möglichst zu trennen.

Sämtlicher erstellter Code muss in den Browsern Internet Explorer 6 und 7 sowie in der jeweils aktuellsten Firefox-Version vollständig lauffähig sein. Auf browserspezifische Funktionen ist soweit wie möglich zu verzichten, ansonsten ist eine Browserweiche einzubauen.

Variablen

Variablennamen sollen möglichst selbsterklärend sein. Auf Bezeichner wie $aa, $rtsp_v11 usw. ist außerhalb sinnvoller Konventionen (z.B. Schleifenzähler) zu verzichten.

Formularfelder die später per GET oder POST ausgelesen werden sollen, fangen immer mit f_[variablenname] an.

Die Turnierid ist immer mit der Varibale $tid, die Spielerid immer mit $sid und die Rundenid immer mit $rid zu übergeben.

Datenbank

Das Datenmodell ist nach gängigen Empfehlungen für relationale Datenbanken zu erstellen. Für die Erstellung kann der fabForce DBDesigner verwendet werden.
http://fabforce.net/dbdesigner4/

Für den DB-Zugriff ist die Klasse ez_sql zu verwenden.
http://www.woyano.com/view/213/Download-ezSQL-Database-Class-203

Bei Strukturänderungen der DB ist in den "Files" bei assembla eine .sql-Skriptdatei mit der vollständigen Struktur, aber ohne Daten, zu speichern. Es ist dort weiterhin jederzeit eine .sql-Skriptdatei mit den bisherigen Produktivdaten (mit vollständigen INSERTs!) zu finden.

Javascript

Für Javascript-Operationen ist, wenn möglich, das prototype-Framework zu verwenden.
http://prototypejs.org/

Javascript-Code ist in eine eigene .js-Datei auszulagern, der Dateiname sollte dem der php-Datei entsprechen (runde_bearbeiten.php -> runde_bearbeiten.js)

Im Ordner js findet sich die komplette Ordnerstruktur der Software wider. Die js - Dateien sind in die gleichen Ordner abzulegen, wie deren php-Pendants.

PHP

Für die Übernahme von URL-Parametern ist die input-Klasse zu verwenden.
Beschreibung der Klasse input

Das Einbinden von nicht wiederverwendbarem Code mit include ist zu vermeiden.

Look&Feel

Zur Formatierung der Ausgabe ist CSS in einer separaten Datei zu verwenden.

Die Definierung und Nutzung zentraler Formate ist anzustreben.

Formatierungen, die nur in einer Datei benötigt werden, sind in eine .css-Datei mit entsprechendem Namen auszulagern (spielerstats.php -> spielerstats.css)

iFrames sind zu vermeiden.

Menüstrukturen:

Für Menüstrukturen, wie z.B. die Statistiken werden Dateien in das Includeverzeichnis angelegt. Somit ist es möglich schnell und einfach neue Menüpunkte hinzuzufügen und diese somit auf allen notwendigen Seiten sichtbar zu machen. Namensformat: [Optional:Turniertyp]_[modulname]_menu.php