Benutzer-Werkzeuge

Webseiten-Werkzeuge


dev:all:psr:psr-1

Dies ist eine alte Version des Dokuments!


im englischen Original von PHP-FIG PSR-1

Basic Coding Standard

Dieser Abschnitt der Standards umfasst Codierungselemente, die erforderlich sind um einen hohen Grad der Kompatibilität zwischen PHP-Codes aus verschiedensten Quellen zu erreichen.

Übersicht

  • Dateien MÜSSEN ausschließlich <?php (:!: Anpassung für WB: und <?=) Tags verwenden.
  • Dateien MÜSSEN ausschließlich UTF-8 ohne BOM codiert werden.
  • Dateien SOLLTEN entweder Symbole (Klassen, Funktionen, Konstanten etc.) deklarieren ODER direkt ausführbaren Code (side-effects) enthalten. Aber sie SOLLTEN NICHT beides gleichzeitig tun.
  • Namensräume und Klassen MÜSSEN PSR-0 folgen.
  • Klassennamen MÜSSEN in StudlyCaps deklariert werden.
  • Klassenkonstanten MÜSSEN in Großbuchstaben mit _ zwischen einzelnen Worten deklariert werden.
  • Methodennamen MÜSSEN in camelCase deklariert werden

Dateien

PHP Tags

PHP-Code MUSS ausschließlich den langen <?php ?> Tag (:!: Anpassung für WB: oder den kurzen Echo <?= ?> Tag) benutzen. Es DÜRFEN NICHT andere Tag-Variationen benutzt werden.

Zeichensatz-Codierung

PHP-Code MUSS ausschließlich UTF-8 ohne BOM verwenden.

Side Effects

Ene Datei SOLLTE entweder neue Symbole (Klassen, Funktionen, Konstanten, etc.) deklarieren und keinerlei 'side effects' enthalten, oder aber es SOLLTE ausführbare Logik mit 'side effects' enthalten, aber niemals SOLLTE es beides tun.

Die Phrase 'side effects' bedeutet 'ausführbare Logik', die nicht in Klassen oder Funktionen gekapselt ist und in der Regel beim 'Includen' der Datei sofort unkontrolliert ausgeführt wird. 'side effects' bezeichnen unter anderem: erzeugen von Ausgaben, benutzen von include() oder require(), verbinden zu externen Services, verändern von INI-Settings, auslösen von Fehlern und Ausnahmen, verändern von globalen oder statischen Variablen, lesen oder schreiben in Dateien oder Datenbanken, und vieles mehr.
:!: Anpassung für WB: Dateien mit 'side effects' MÜSSEN speziell abgesichert werden, damit sie nicht durch z.B. DeepLinks aufgerufen werden und Schaden anrichten können.

Das Nachfolgende ist ein Beispiel einer Datei, die sowohl Deklarationen als auch 'side effects' enthält. Ein Beispiel, das zeigt, was man NICHT machen SOLLTE:

// side effect: ändert Ini-Settings
ini_set('errot_reporting', E_ALL);
 
// side effect: lädt eine Datei
include('file.php');
 
// side effect: erzeugt eine Ausgabe
echo '<html>'.PHP_EOL;
 
// Deklaration:
function foo()
{
    // Funktionskörper
}

Das zweite Beispiel ist eine Datei, die nur Deklarationen ohne alle 'side effects' enthält. Ein Beispiel, das immer zu bevorzugen ist.

// Deklaration
function foo()
{
    // Funktionskörper
}
 
// bedingte Deklaration ist *kein* side effect!
if (! function_exists('bar')) {
    function bar()
    {
        // Funktionskörper
    }
}
dev/all/psr/psr-1.1407847963.txt.gz · Zuletzt geändert: 03.06.2015 15:54 (Externe Bearbeitung)