PSR-12

PSR-12 ist ein Standard der PHP-Fig (PHP Framework Interoperability Group), der Coding-Style-Guidelines für PHP definiert. Es baut auf PSR-1 (Basic Coding Standard) und PSR-2 (Coding Style Guide) auf und erweitert diese, um modernere Anforderungen und Best Practices zu berücksichtigen.

Ziel von PSR-12

PSR-12 zielt darauf ab, einen einheitlichen und lesbaren Code-Stil für PHP-Projekte zu schaffen. Dies erleichtert die Zusammenarbeit zwischen Entwicklern und sorgt für Konsistenz in der Codebasis.

Wichtige Richtlinien von PSR-12

1. Einrückung

• 4 Leerzeichen werden für die Einrückung verwendet (keine Tabs).

2. Zeilenlänge

• Die maximale Zeilenlänge sollte 120 Zeichen nicht überschreiten.
• Code darf für bessere Lesbarkeit auf mehrere Zeilen umgebrochen werden.

3. Namespace und Use-Anweisungen

• Nach der namespace-Deklaration muss eine Leerzeile stehen.
• use-Anweisungen werden nach der namespace-Deklaration gruppiert.
• Importierte Klassen, Funktionen und Konstanten sollten alphabetisch sortiert werden und keine Leerzeilen enthalten.

namespace App\Controller;

use App\Service\MyService;
use Psr\Log\LoggerInterface;

4. Klassen

• Der Öffnungsblock { einer Klasse oder Methode steht in der nächsten Zeile.
• Sichtbarkeiten (public, protected, private) sind bei allen Methoden und Eigenschaften zwingend erforderlich.

class MyClass
{
    private string $property;

    public function myMethod(): void
    {
        // code
    }
}

5. Methoden und Funktionen

• Jeder Parameter einer Methode/Funktion muss auf einer neuen Zeile stehen, wenn sie umgebrochen wird.
• Rückgabetypen sollten explizit angegeben werden.

public function myFunction(
    int $param1,
    string $param2
): string {
    return 'example';
}

6. Control Structures (if, while, for, etc.)

• Der Öffnungsblock { muss in derselben Zeile wie die Kontrollstruktur stehen.
• Zwischen der Kontrollstruktur und der Bedingung steht ein Leerzeichen.

if ($condition) {
    // code
} elseif ($otherCondition) {
    // code
} else {
    // code
}

7. Arrays

• Arrays sollten im kurzen Syntax-Stil ([]) geschrieben werden.
• Bei mehrzeiligen Arrays sollte jedes Element in einer neuen Zeile stehen.

$array = [
    'first' => 'value1',
    'second' => 'value2',
];

8. Typdeklarationen

• Typen für Parameter, Rückgabewerte und Eigenschaften sind zwingend erforderlich (sofern möglich).
• Nullbare Typen werden mit ? vor dem Typ deklariert.

public function getValue(?int $id): ?string
{
    return $id !== null ? (string) $id : null;
}

9. Dateien

• PHP-Dateien müssen mit einem <?php-Tag beginnen und dürfen kein schließendes ?>-Tag enthalten.
• Zwischen der Deklaration von Codeelementen (z. B. Klassen oder Funktionen) sollten Leerzeilen eingefügt werden.

Unterschiede zu PSR-2

PSR-12 erweitert PSR-2 um:

• Unterstützung moderner PHP-Features (z. B. nullable types, declare(strict_types=1), traits, type hinting).
• Mehr Klarheit bei der Zeilenlänge, bei umgebrochenen Methodenparametern und bei Arrays.
• Explizitere Regeln zur Typdeklaration.

Vorteile von PSR-12

• Vereinfachung von Code-Reviews.
• Bessere Lesbarkeit und Wartbarkeit von Code.
• Erhöhte Interoperabilität zwischen verschiedenen PHP-Projekten.
• Einheitlichkeit bei der Verwendung moderner PHP-Features.

Zusammenfassung

PSR-12 ist der Standard für modernen und konsistenten PHP-Code. Es bringt Klarheit und Struktur in PHP-Projekte, besonders bei Teams, die gemeinsam an einer Codebasis arbeiten. Mit Tools wie PHP_CodeSniffer oder PHP-CS-Fixer kannst du PSR-12 problemlos einhalten.