[TIPP] PHP code lesbar gestaltet

Sie befinden sich: Home > Webmaster News

So schreibt man seinen PHP-Code lesbarer

In unseren Scripten haben wir in der Regel Zugriffe auf MySql-Tabellen, aus denen wir Daten auslesen, in die wir Daten eintragen, oder in Daten geändert oder gelöscht werden.

Sql-Befehle werden schnell lang und dadurch später nur schwer lesbar:

<?php
$sql = "SELECT vorname, name, strasse, hausnummer, plz, ort, vorwahl, telefon FROM kunden WHERE ort = '$ort' ORDER BY name LIMIT 0,30";
?>

Das ist auf einen Blick nicht zu erfassen, und wenn wir in ein par Wochen hier etwas ändern wollen, dann verlieren wir Zeit damit, unseren eigenen Code zu analysieren.

Wir können uns zunutze machen, dass zusätzliche Leerzeichen und Zeilenumbrüche von PHP aussortiert werden und schreiben einfach eingerückt:

<?php
$sql = "SELECT 
          vorname,
          name,
          strasse,
          hausnummer,
          plz,
          ort,
          vorwahl,
          telefon           
       FROM 
          kunden 
       WHERE 
          ort = '" . $ort . "' 
       ORDER BY 
          name 
       LIMIT 
          0,30";
?>

Den Variablennamen $ort haben wir aus der Zeichenkette herausgelöst, weil er so im Editor andersfarbig dargestellt wird und man sofort erkennen kann, dass hier eine Programmvariable in den SQL-String eingebaut wurde. Diese Schreibweise nimmt zwar zusätzliche Zeilen im Script in Anspruch, da aber kaum noch jemand ohne 19-Zoll-Monitor und hoher Auflösung arbeitet, und bessere Editoren das Einklappen von Code beherrschen, fällt dies nicht weiter ins Gewicht.

Bei UPDATE-Sql werden die die Vorteile dieser Schreibweise noch deutlicher:

<?php
$sql = "UPDATE
		kunden
	SET
		vorname ='" . $vorname . "',
		name ='" . $name . "',
		strasse ='" . $strasse . "',
		hausnummer ='" . $hausnummer . "',
		plz ='" . $plz . "',
		ort ='" . $ort . "',
		vorwahl ='" . $vorwahl . "',
		telefon ='" . $telefon . "' 
		WHERE kunum ='" . $kunum . "'";
?>

Auch INSERT-Befehle kann man mit dieser Syntax schreiben:

<?php
$sql = "INSERT INTO
		kunden
	SET
		vorname ='" . $vorname . "',
		name ='" . $name . "',
		strasse ='" . $strasse . "',
		hausnummer ='" . $hausnummer . "',
		plz ='" . $plz . "',
		ort ='" . $ort . "',
		vorwahl	='" . $vorwahl . "',
		telefon	='" . $telefon . "'";
?>

Falls sie die Tabelle kunden später einmal erweitern, und neu z.B. noch eine Mobilfunknummer verwalten wollen, dann müssen Sie nur eine Zeile verdoppeln:

<?php
$sql = "INSERT INTO
		kunden
	SET
		vorname ='" . $vorname . "',
		name ='" . $name . "',
		strasse ='" . $strasse . "',
		hausnummer ='" . $hausnummer . "',
		plz ='" . $plz . "',
		ort ='" . $ort . "',
		vorwahl	='" . $vorwahl . "',
		telefon	='" . $telefon . "',
		mobil	='" . $mobil . "'";

?>

Schon ist der Code angepasst.

(Autor: Wolfgang), Eingetragen am 28.08.2008