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.

PHP Mess Detector (PHPMD) ist ein statisches Analysetool für PHP, das potenzielle Probleme im Code aufdeckt. Es hilft, Bereiche zu identifizieren, die schwer wartbar oder fehleranfällig sein könnten. PHPMD überprüft den Code auf:

1. Code-Komplexität: Es erkennt zu komplexe Methoden oder Klassen, die schwer zu verstehen oder zu erweitern sind.
2. Unbenutzter Code: PHPMD spürt Variablen, Parameter oder Methoden auf, die zwar definiert, aber nie verwendet werden.
3. Verstöße gegen Best Practices: Es prüft Verstöße gegen saubere Code-Praktiken wie zu lange Methoden oder tief verschachtelte Bedingungen.
4. Wartbarkeit: Das Tool zeigt Bereiche auf, die langfristig die Wartung erschweren könnten.

PHPMD lässt sich anpassen und kann mit benutzerdefinierten Regeln oder vorgegebenen Regelsets arbeiten. Es ist ähnlich wie PHP_CodeSniffer, konzentriert sich aber mehr auf die Logik und Struktur des Codes, während CodeSniffer sich auf Stil- und Formatierungsprobleme fokussiert.

Zusammenfassend hilft PHPMD, die Codequalität und Wartbarkeit zu verbessern, indem es mögliche „Unsauberkeiten“ im Code aufzeigt.

PHP_CodeSniffer (oft kurz „Codesniffer“ genannt) ist ein Tool, das zur Analyse und Durchsetzung von Coding-Standards in PHP-Code verwendet wird. Es überprüft PHP-Dateien auf Einhaltung bestimmter Regeln und sorgt dafür, dass der Code konsistent und gut strukturiert ist. Codesniffer kann in Projekten genutzt werden, um sicherzustellen, dass alle Entwickler einheitlich programmieren und vorgegebene Standards einhalten, was die Wartbarkeit und Qualität des Codes verbessert.

Hauptfunktionen:

1. Überprüfung von Coding-Standards: PHP_CodeSniffer kann den Code auf Einhaltung von Standards wie PSR-1, PSR-2, PSR-12 oder benutzerdefinierten Regeln überprüfen.
2. Automatische Fehlerkorrektur: Mit PHP_CodeSniffer lassen sich bestimmte Probleme automatisch beheben, wie z.B. das Entfernen unnötiger Leerzeichen oder das Anpassen von Einrückungen.
3. Integration in CI/CD-Pipelines: Codesniffer kann in Continuous-Integration-Systeme integriert werden, um die Code-Qualität in jedem Schritt des Entwicklungsprozesses zu überprüfen.

Einsatzmöglichkeiten:

• Sicherstellung der Code-Qualität in Team-Projekten.
• Automatische Einhaltung von Standards wie PSR-12.
• Integration in Code-Editoren (wie PHPStorm) für Echtzeit-Feedback während des Programmierens.

Durch die Verwendung von PHP_CodeSniffer bleibt der Code konsistent und qualitativ hochwertig, was langfristig die Wartbarkeit eines Projekts deutlich erhöht.