WebsiteBaker Documentation

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Sie befinden sich hier: start » dev » all » psr » psr-2
dev:all:psr:psr-2

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen RevisionVorhergehende Überarbeitung
Nächste Überarbeitung		Vorhergehende Überarbeitung
Letzte ÜberarbeitungBeide Seiten der Revision
dev:all:psr-2de [13.08.2014 14:12] – [for] Manuela v.d.Deckendev:all:psr:psr-2 [31.08.2023 01:34] – [Methoden Argumente] Manuela v.d.Decken
Zeile 1: Zeile 1:
 [size=10]im englischen Original von [[http://www.php-fig.org/psr/psr-2/|PHP-FIG PSR-2]][/size] [size=10]im englischen Original von [[http://www.php-fig.org/psr/psr-2/|PHP-FIG PSR-2]][/size]
 ====== Coding Style Guide ====== ====== Coding Style Guide ======
-Diese Anleitung verlängert und erweitert den Basis-Standard [[dev:all:psr-1de|PSR-1]].+Diese Anleitung verlängert und erweitert den Basis-Standard [[dev:all:psr:psr-1|PSR-1]].
  
-Das Ziel dieser Anleitung ist es, dafür zu sorgen dass Code unterschiedlicher Autoren ohne Probleme geleseb und verglichen werden kann. +Das Ziel dieser Anleitung ist es, dafür zu sorgen dass Code unterschiedlicher Autoren ohne Probleme gelesen und verglichen werden kann. 
 Erreicht wird dieses Ziel durch einen gemeinsamen Satz an Regeln und Erwartungen an das Format von PHP-Code. Erreicht wird dieses Ziel durch einen gemeinsamen Satz an Regeln und Erwartungen an das Format von PHP-Code.
  
 ===== Übersicht ===== ===== Übersicht =====
-  * Der Code MUSS [[dev:all:psr-1de|PSR-1]] folgen.+  * Der Code MUSS [[dev:all:psr:psr-1|PSR-1]] folgen.
   * Der Code MUSS 4 Leerzeichen für Einzüge benutzen aber keine Tabulatoren.   * Der Code MUSS 4 Leerzeichen für Einzüge benutzen aber keine Tabulatoren.
-  * Es DARF NICHT ein festes Limit der Zeilenlängen geben. Das Soft-Limit MUSS bei 120 Zeichen liegen und Zeilen SOLLTEN max 80 Zeichen oder weniger haben. +  * Es DARF NICHT ein festes Limit für Zeilenlängen geben. Das Soft-Limit MUSS bei 120 Zeichen liegen und Zeilen SOLLTEN max 80 Zeichen oder weniger haben. 
-  * Es MUSS jeweils eine Leerzeile nach der Namensraum Deklaration und nach dem Block der **use** Deklarationen eingefügt werden.+  * Es MUSS jeweils eine Leerzeile nach der Namespace Deklaration und nach dem Block der **use** Deklarationen eingefügt werden.
   * Bei Klassen MÜSSEN öffnende, geschweifte Klammern in der nächsten Zeile und die schließenden Klammern MÜSSEN in der nächsten Zeile nach dem Klassenkörper stehen.   * Bei Klassen MÜSSEN öffnende, geschweifte Klammern in der nächsten Zeile und die schließenden Klammern MÜSSEN in der nächsten Zeile nach dem Klassenkörper stehen.
   * Bei Methoden MÜSSEN öffnende, geschweifte Klammern in der nächsten Zeile und die schließenden Klammern MÜSSEN in der nächsten Zeile nach dem Methodenkörper stehen.   * Bei Methoden MÜSSEN öffnende, geschweifte Klammern in der nächsten Zeile und die schließenden Klammern MÜSSEN in der nächsten Zeile nach dem Methodenkörper stehen.
Zeile 20: Zeile 20:
 ==== Beispiel ==== ==== Beispiel ====
 Für einen schnelleren Überblick umfasst dieses Beispiel einige der obigen Regeln. Für einen schnelleren Überblick umfasst dieses Beispiel einige der obigen Regeln.
-<PHP>+<code php>
 <?php <?php
 namespace Vendor\Package; namespace Vendor\Package;
Zeile 46: Zeile 46:
     }     }
 } }
-</PHP>+</code>
  
 ===== Allgemein ===== ===== Allgemein =====
 ==== Basic Coding Standard ==== ==== Basic Coding Standard ====
-Der Code MUSS allen in [[dev:all:psr-1de|PSR-1]] aufgezeigten Regeln folgen.+Der Code MUSS allen in [[dev:all:psr:psr-1|PSR-1]] aufgezeigten Regeln folgen.
  
 ==== Dateien ==== ==== Dateien ====
Zeile 67: Zeile 67:
 ==== Einzüge, Einrückungen ==== ==== Einzüge, Einrückungen ====
 Code MUSS eine Einzugsweite von 4 Leerzeichen und DARF NICHT Tabulatoren für Einzüge nutzen. Code MUSS eine Einzugsweite von 4 Leerzeichen und DARF NICHT Tabulatoren für Einzüge nutzen.
-<blockquote>:!: Die ausnahmslose Benutzung von Leerzeichen ohen Vermischung mit Tabulatoren, hilft Probleme mit diffs, patches, history und Anmerkungen zu vermeiden. Die Benutzung von Leerzeichen macht es ebenso einfacher, feiner abgestufte Einzüge für Untereinzüge einzusetzen.</blockquote>+<blockquote>:!: Die ausnahmslose Benutzung von Leerzeichen ohne Vermischung mit Tabulatoren, hilft Probleme mit diffs, patches, history und Anmerkungen zu vermeiden. Die Benutzung von Leerzeichen macht es ebenso einfacher, feiner abgestufte Einzüge für Untereinzüge einzusetzen.</blockquote>
  
 ==== Schlüsselwörter und True/False/Null ==== ==== Schlüsselwörter und True/False/Null ====
Zeile 74: Zeile 74:
  
 ===== Namensräume und USE-Deklarationen ===== ===== Namensräume und USE-Deklarationen =====
-  * Wenn vorhanden, dann MUSS eine Leerzeile nach der Namensraum-Deklaration sein. +  * Wenn vorhanden, dann MUSS eine Leerzeile nach der Namespace Deklaration sein. 
-  * Wenn vorhanden, dann MÜSSEN alle **use** Deklarationen nach der Namensraum Deklaration eingefügt werden.+  * Wenn vorhanden, dann MÜSSEN alle **use** Deklarationen nach der Namespace Deklaration eingefügt werden.
   * Es DARF NICHT mehr als ein **use** Schlüsselwort pro Deklaration benutzt werden.   * Es DARF NICHT mehr als ein **use** Schlüsselwort pro Deklaration benutzt werden.
   * Es MUSS eine Leerzeile nach dem **use** Deklarationsblock eingefügt werden.   * Es MUSS eine Leerzeile nach dem **use** Deklarationsblock eingefügt werden.
 Beispiel Beispiel
-<PHP>+<code php>
 <?php <?php
 namespace Vendor\Package; namespace Vendor\Package;
Zeile 88: Zeile 88:
  
 // ... additional PHP code ... // ... additional PHP code ...
-</PHP>+</code>
  
 ===== Klassen, Eigenschaften und Methoden ===== ===== Klassen, Eigenschaften und Methoden =====
Zeile 97: Zeile 97:
  
 Die öffnende, geschweifte Klammer für die Klasse MUSS alleine in der nächsten freien Zeile stehen. Die zugehörende schließende Klammer exakt darunter in der ersten freien Zeile nach dem Klassenkörper. Die öffnende, geschweifte Klammer für die Klasse MUSS alleine in der nächsten freien Zeile stehen. Die zugehörende schließende Klammer exakt darunter in der ersten freien Zeile nach dem Klassenkörper.
-<PHP>+<code php>
 <?php <?php
 namespace Vendor\Package; namespace Vendor\Package;
Zeile 109: Zeile 109:
     // constants, properties, methods     // constants, properties, methods
 } }
-</PHP>+</code>
 Eine Liste von **implements** KANN über mehrere Zeilen gesplittet werden, wobei jede Unterzeile jeweils einen Schritt eingerückt wird.\\ Eine Liste von **implements** KANN über mehrere Zeilen gesplittet werden, wobei jede Unterzeile jeweils einen Schritt eingerückt wird.\\
 Wird das gemacht, dann MUSS der erste Eintrag in der nächsten Zeile sein und es DARF NICHT mehr als ein Interface pro Zeile angegeben werden. Wird das gemacht, dann MUSS der erste Eintrag in der nächsten Zeile sein und es DARF NICHT mehr als ein Interface pro Zeile angegeben werden.
-<PHP>+<code php>
 <?php <?php
 namespace Vendor\Package; namespace Vendor\Package;
Zeile 127: Zeile 127:
     // constants, properties, methods     // constants, properties, methods
 } }
-</PHP>+</code>
  
 ==== Eigenschaften ==== ==== Eigenschaften ====
Zeile 135: Zeile 135:
   * Eigenschaftennamen DÜRFEN NICHT zur Kennzeichnung von private oder protected einen _ als Vorzeichen erhalten.   * Eigenschaftennamen DÜRFEN NICHT zur Kennzeichnung von private oder protected einen _ als Vorzeichen erhalten.
 Beispiel einer Eigenschaftendeklaration: Beispiel einer Eigenschaftendeklaration:
-<PHP>+<code php>
 <?php <?php
 namespace Vendor\Package; namespace Vendor\Package;
Zeile 143: Zeile 143:
     public $foo = null;     public $foo = null;
 } }
-</PHP>+</code>
  
  
Zeile 174: Zeile 174:
   * In der Argumentenliste DARF NICHT eine Leerstelle vor einem Komma sein, aber es MUSS eine Leerstelle nach jedem Komma folgen.   * In der Argumentenliste DARF NICHT eine Leerstelle vor einem Komma sein, aber es MUSS eine Leerstelle nach jedem Komma folgen.
   * Methodenargumente mit Vorgabewerten(default) MÜSSEN an das Ende der Liste.   * Methodenargumente mit Vorgabewerten(default) MÜSSEN an das Ende der Liste.
-<PHP>+<code php> 
 +<?php
 namespace Vendor\Package; namespace Vendor\Package;
  
Zeile 184: Zeile 185:
     }     }
 } }
-</PHP>+</code>
   * Argumentenlisten KÖNNEN über mehrere Zeilen gesplittet werden, wenn jede Unterzeile um eine Stufe eingerückt wird. Wenn so verfahren wird, MUSS das erste Element in die nächste Zeile und es DARF NICHT mehr als ein Argument je Zeile angegeben werden.   * Argumentenlisten KÖNNEN über mehrere Zeilen gesplittet werden, wenn jede Unterzeile um eine Stufe eingerückt wird. Wenn so verfahren wird, MUSS das erste Element in die nächste Zeile und es DARF NICHT mehr als ein Argument je Zeile angegeben werden.
   * Wenn eine Argumentenliste gesplittet wird, so MUSS die schließende Klammer und die öffnende geschweifte Klammer mit einer Leerstelle dazwischen in eine eigene Zeile.   * Wenn eine Argumentenliste gesplittet wird, so MUSS die schließende Klammer und die öffnende geschweifte Klammer mit einer Leerstelle dazwischen in eine eigene Zeile.
-<PHP>+<code php>
 <?php <?php
 namespace Vendor\Package; namespace Vendor\Package;
Zeile 201: Zeile 202:
     }     }
 } }
-</PHP>+</code>
  
  
Zeile 231: Zeile 232:
  
 ==== Methoden- und Funktionsaufrufe ==== ==== Methoden- und Funktionsaufrufe ====
-Bei einem Methoden- oder Funktionsaufruf DARF NICHT zwischen dem Methoden- oder Funktionsnamen eine Leerstelle sein; Es DARF NICHT eine Leerstelle nach der öffnenden Klammer und es DARF NICHT eine Leerstelle vor der schließenden Klammer eingefügt werden. In der Argumentenliste DARF NICHT vor einem Komma stehen und es MUSS eine Leerstelle nach jedem Komma eingefügt werden.+Bei einem Methoden- oder Funktionsaufruf DARF NICHT zwischen dem Methoden- oder Funktionsnamen und der öffnenden Klammer eine Leerstelle sein; Es DARF NICHT eine Leerstelle __nach__ der öffnenden Klammer und es DARF NICHT eine Leerstelle __vor__ der schließenden Klammer eingefügt werden. In der Argumentenliste DARF NICHT eine Leerstelle __vor__ einem Komma stehen und es MUSS eine Leerstelle __nach__ jedem Komma eingefügt werden.
 <PHP> <PHP>
-<?php 
 bar(); bar();
 $foo->bar($arg1); $foo->bar($arg1);
Zeile 242: Zeile 242:
   * Wenn eine Argumentenliste gesplittet wird, so MUSS die schließende Klammer und das Semikolon ohne eine Leerstelle dazwischen in eine eigene Zeile.   * Wenn eine Argumentenliste gesplittet wird, so MUSS die schließende Klammer und das Semikolon ohne eine Leerstelle dazwischen in eine eigene Zeile.
 <PHP> <PHP>
-<?php 
 $foo->bar( $foo->bar(
     $longArgument,     $longArgument,
Zeile 265: Zeile 264:
 Eine **if**-Struktur sieht wie nachfolgend aus. Beachten Sie die Plazierung von Klammern, Leerstellen und geschweiften Klammern. Die Schlüsselwörter **else** und **elseif** MÜSSEN sich mit einer Leerstelle Abstand auf der selben Zeile befinden, wie die schließende, geschweifte Klammer des vorhergehenden Strukturkörpers. Eine **if**-Struktur sieht wie nachfolgend aus. Beachten Sie die Plazierung von Klammern, Leerstellen und geschweiften Klammern. Die Schlüsselwörter **else** und **elseif** MÜSSEN sich mit einer Leerstelle Abstand auf der selben Zeile befinden, wie die schließende, geschweifte Klammer des vorhergehenden Strukturkörpers.
 <PHP> <PHP>
-<?php 
 if ($expr1) { if ($expr1) {
     // if body     // if body
Zeile 281: Zeile 279:
 Das **case**-Statement MUSS eine Stufe ab **switch** eingerückt werden und das **break** Schlüsselwort (oder ein anderes, abschließendes Schlüsselwort) MUSS auf die selbe Ebene eingerückt werden, wie der **case**-Körper. Es MUSS ein Kommentar wie %%//%%// no break//  eingefügt werden, wenn ein 'durchfallen' zum nächsten **case** erwünscht ist. Das **case**-Statement MUSS eine Stufe ab **switch** eingerückt werden und das **break** Schlüsselwort (oder ein anderes, abschließendes Schlüsselwort) MUSS auf die selbe Ebene eingerückt werden, wie der **case**-Körper. Es MUSS ein Kommentar wie %%//%%// no break//  eingefügt werden, wenn ein 'durchfallen' zum nächsten **case** erwünscht ist.
 <PHP> <PHP>
-<?php 
 switch ($expr) { switch ($expr) {
     case 0:     case 0:
Zeile 305: Zeile 302:
 Ein **while**-Statement sieht wie nachfolgend aus. Beachten Sie die Plazierung von Klammern, Leerstellen und geschweiften Klammern. Ein **while**-Statement sieht wie nachfolgend aus. Beachten Sie die Plazierung von Klammern, Leerstellen und geschweiften Klammern.
 <PHP> <PHP>
-<?php 
 while ($expr) { while ($expr) {
     // structure body     // structure body
Zeile 312: Zeile 308:
 ebenso sieht ein **do while**-Statement wie nachfolgend aus. Beachten Sie die Plazierung von Klammern, Leerstellen und geschweiften Klammern. ebenso sieht ein **do while**-Statement wie nachfolgend aus. Beachten Sie die Plazierung von Klammern, Leerstellen und geschweiften Klammern.
 <PHP> <PHP>
-<?php 
 do { do {
     // structure body;     // structure body;
Zeile 323: Zeile 318:
 Ein **for**-Statement sieht wie nachfolgend aus. Beachten Sie die Plazierung von Klammern, Leerstellen und geschweiften Klammern.  Ein **for**-Statement sieht wie nachfolgend aus. Beachten Sie die Plazierung von Klammern, Leerstellen und geschweiften Klammern. 
 <PHP> <PHP>
-<?php 
 for ($i = 0; $i < 10; $i++) { for ($i = 0; $i < 10; $i++) {
     // for body     // for body
Zeile 331: Zeile 325:
  
 ==== foreach ==== ==== foreach ====
 +Ein **foreach**-Statement sieht wie nachfolgend aus. Beachten Sie die Plazierung von Klammern, Leerstellen und geschweiften Klammern.  
 +<PHP> 
 +foreach ($iterable as $key => $value) { 
 +    // foreach body 
 +} 
 +</PHP>
  
  
 ==== try, catch ==== ==== try, catch ====
 +Ein **try catch**-Statement sieht wie nachfolgend aus. Beachten Sie die Plazierung von Klammern, Leerstellen und geschweiften Klammern.  
 +<PHP> 
 +try { 
 +    // try body 
 +} catch (FirstExceptionType $e) { 
 +    // catch body 
 +} catch (OtherExceptionType $e) { 
 +    // catch body 
 +} 
 +</PHP>
  
  
 ===== Closures ===== ===== Closures =====
 +  * Closures MÜSSEN mit einem Leerzeichen nach denm Schlüsselwort **function** und je einem Leerzeichen vor und nach dem Schlüsselwort **use** deklariert werden.
 +  * Die öffnende, geschweifte Klammer MUSS in der selben Zeile wie das Schlüsselwort **function** sein und die schließende Klammer MUSS in der nächsten Zeile nach dem Funktionskörper sein.
 +  * Nach der öffnenden Klammer der Argumentenliste DARF NICHT ein Leerzeichen stehen und vor der schließenden Klammer DARF NICHT ein Leerzeichen sein.
 +  * In der Argumentenliste und der Variablenliste DARF NICHT ein Leerzeichen vor einem Komma stehen und nach einem Komma MUSS ein Leerzeichen sein.
 +  * Closure Argumente mit Vorgabewerten (default) MÜSSEN an das Ende der Argumentenliste.
 +Eine Closure Deklaration sieht wie nachfolgend aus. Beachten Sie die Plazierung von Klammern, Leerstellen und geschweiften Klammern. 
 +<PHP>
 +$closureWithArgs = function ($arg1, $arg2) {
 +    // body
 +};
  
 +$closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) {
 +    // body
 +};
 +</PHP>
 +  * Argumenten- und Variablenlisten KÖNNEN über mehrere Zeilen gesplittet werden, wenn jede Unterzeile um eine Stufe eingerückt wird. Wenn so verfahren wird, MUSS das erste Element in die nächste Zeile und es DARF NICHT mehr als ein Argument oder Variable je Zeile angegeben werden.
 +  * Wenn eine Argumenten- oder Variablenliste gesplittet wird, so MUSS die schließende Klammer und die öffnende geschweifte Klammer mit einer Leerstelle dazwischen in eine eigene Zeile.
 +Beispiele von Closures mit und ohne Argumentenliste und Variableliste die über mehrere Zeilen gesplittet sind.
 +<PHP>
 +$longArgs_noVars = function (
 +    $longArgument,
 +    $longerArgument,
 +    $muchLongerArgument
 +) {
 +   // body
 +};
  
 +$noArgs_longVars = function () use (
 +    $longVar1,
 +    $longerVar2,
 +    $muchLongerVar3
 +) {
 +   // body
 +};
  
 +$longArgs_longVars = function (
 +    $longArgument,
 +    $longerArgument,
 +    $muchLongerArgument
 +) use (
 +    $longVar1,
 +    $longerVar2,
 +    $muchLongerVar3
 +) {
 +   // body
 +};
 +
 +$longArgs_shortVars = function (
 +    $longArgument,
 +    $longerArgument,
 +    $muchLongerArgument
 +) use ($var1) {
 +   // body
 +};
 +
 +$shortArgs_longVars = function ($arg) use (
 +    $longVar1,
 +    $longerVar2,
 +    $muchLongerVar3
 +) {
 +   // body
 +};
 +</PHP>
 +Beachten Sie, dass die Formatierungsregeln auch greifen, wenn ein  Closure direkt in einem Funktions- oder Methodenaufruf als Argument eingesetzt ist.
 +<PHP>
 +$foo->bar(
 +    $arg1,
 +    function ($arg2) use ($var1) {
 +        // body
 +    },
 +    $arg3
 +);
 +</PHP>
  
  
dev/all/psr/psr-2.txt · Zuletzt geändert: 31.08.2023 01:38 von Manuela v.d.Decken

Seiten-Werkzeuge

Falls nicht anders bezeichnet, ist der Inhalt dieses Wikis unter der folgenden Lizenz veröffentlicht: CC Attribution-Noncommercial-Share Alike 4.0 International
CC Attribution-Noncommercial-Share Alike 4.0 International Donate Driven by DokuWiki Template From SyntaxSeed