WebsiteBaker Documentation

Diese Seite ist nicht editierbar. Sie können den Quelltext sehen, jedoch nicht verändern. Kontaktieren Sie den Administrator, wenn Sie glauben, dass hier ein Fehler vorliegt.
[size=10]im englischen Original von [[http://www.php-fig.org/psr/psr-1/|PHP-FIG PSR-1]][/size]
====== 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''** 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. 
  * Namespaces und Klassen MÜSSEN [[dev:all:psr:psr-0|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 =====

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

==== Side Effects ====
Eine Datei SOLLTE entweder neue Symbole (Klassen, Funktionen, Konstanten, etc.) deklarieren und keinerlei 'side effects' enthalten, oder aber sie SOLLTE ausführbare Logik mit 'side effects' enthalten, aber sie SOLLTE NICHT 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:
<code php>
// 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
}
</code>
Das zweite Beispiel ist eine Datei, die nur Deklarationen ohne alle 'side effects' enthält. Ein Beispiel, das immer zu bevorzugen ist.
<code php>
// Deklaration
function foo()
{
    // Funktionskörper
}

// bedingte Deklaration ist *kein* side effect!
if (! function_exists('bar')) {
    function bar()
    {
        // Funktionskörper
    }
}
</code>

===== Namespaces und Klassennamen =====

Die Benennung von Namespaces und Klassen MUSS nach [[dev:all:psr:psr-0|PSR-0]] erfolgen.

Das bedeutet, dass jede Klasse in einer eigenen Datei ist und einem Namespace zugewiesen, der wenigstens den Vendor Name als Top-Level hat.

Klassennamen MÜSSEN in **StudlyCaps** deklariert werden.

:!: //Anpassung für WB:// Interfaces und abstrakte Klassen müssen im Namen zusätzlich mit dem Suffix **Interface** oder **Abstract** ergänzt werden.\\


Code der für PHP-5.3 und höher geschrieben wird MUSS formale Namespace nutzen.

Beispiel:
<code php>
<?php
// php 5.3 und später:
namespace Vendor\Model;

class Foo
{
}
</code>
<code php>
<?php
// php 5.3 und später:
namespace Vendor\Model;

class FooInterface
{
}
</code>


===== Klassen- Konstanten, Eigenschaften und Methoden =====
Das Term 'Klasse' bezieht sich auf alle Klassen, Interfaces und Traits.

==== Konstanten ====
Klassenkonstanten MÜSSEN vollständig in Großbuchstaben deklariert werden. Der Unterstrich trennt einzelne Worte.
<code php>
<?php
namespace Vendor\Model;

class Foo
{
    const VERSION = '1.0';
    const DATE_APPROVED = '2014-08-12';
}
</code>

==== Eigenschaften ====
Dieser Leitfaden vermeidet absichtlich jede Empfehlung in Bezug auf die Verwendung von $**StudlyCaps**, $**camelCase** oder $**under_score** Eigenschaftennamen.\\
Welche Namenskonvention auch benutzt wird, sie SOLLTE konsistent in einem vertretbaren Rahmen angewendet werden.

:!: //Anpassung an WB:// Es MUSS durchgehend überall das **StudlyCaps** Format benutzt werden, wobei jedem Bezeichner ein Kleinbuchstabe vorangestellt wird, der den Datentyp der Eigenschaft beschreibt. Derzeit definiert sind folgende Zuweisungen:
>>'**s**' => String, '**i**' => Integer/Ganzzahl, '**f**' => Fließkommazahl, '**b**' => boolean, '**a**' => Array, '**o**' => Objekt, '**c**' => Callback, '**m**' => mixed, '**r**' => Resource

<code php>
$sItemName = 'Something';
$iUserId   = 2;
$fPrice    = 45.25;
</code>

==== Methoden ====
Methodennamen MÜSSEN in **camelCase()** deklariert werden.


 --- //[[manuela@isteam.de|Manuela v.d.Decken]] 12.08.2014 20:35//
WebsiteBaker Documentation

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Seiten-Werkzeuge
