PSR-3 ist eine Empfehlung der PHP-FIG (PHP Framework Interoperability Group), die ein standardisiertes Interface für Logging-Bibliotheken in PHP-Anwendungen festlegt. Das Ziel ist es, Entwicklern eine einheitliche und flexible Schnittstelle für das Logging bereitzustellen, die unabhängig von der verwendeten Bibliothek funktioniert. Dadurch können Log-Bibliotheken leicht ersetzt oder geändert werden, ohne dass bestehender Code angepasst werden muss.
Standardisiertes Logger-Interface: PSR-3 definiert das Interface Psr\Log\LoggerInterface mit verschiedenen Methoden für unterschiedliche Log-Level wie emergency(), alert(), critical(), error(), warning(), notice(), info() und debug().
Log-Level: Die acht vordefinierten Log-Level (z. B. emergency, alert, error) basieren auf dem weit verbreiteten Syslog-Protokoll RFC 5424, was die Kompatibilität mit vielen Logging-Systemen sicherstellt.
Nachrichteninterpolation: PSR-3 erlaubt es, Platzhalter in Log-Nachrichten (z. B. {platzhalter}) durch tatsächliche Werte zu ersetzen. Beispiel:$logger->error("Benutzer {username} nicht gefunden", ['username' => 'johndoe']);Dadurch werden Log-Nachrichten konsistent und lesbar formatiert, ohne dass aufwendige String-Manipulation nötig ist.
Flexible Implementierung: Jede Logging-Bibliothek, die LoggerInterface implementiert, kann in PSR-3-kompatiblem Code verwendet werden, wie etwa die weit verbreitete Bibliothek Monolog.
Dynamische Log-Level: Mit der log()-Methode kann man Nachrichten auch dynamisch auf jedem gewünschten Log-Level protokollieren, indem der Level als Parameter übergeben wird.
Hier ein Beispiel, wie ein PSR-3-konformer Logger verwendet wird:
use Psr\Log\LoggerInterface;
class UserService
{
private $logger;
public function __construct(LoggerInterface $logger)
{
$this->logger = $logger;
}
public function findUser($username)
{
$this->logger->info("Suche nach Benutzer {username}", ['username' => $username]);
// ...
}
}Mehr Informationen und Details finden sich auf der offiziellen PHP-FIG-Seite zur PSR-3-Spezifikation.
PSR-2 ist eine Richtlinie für den Programmierstil in PHP, die von der PHP-Fig (Framework Interop Group) als Empfehlung erstellt wurde. Die Abkürzung „PSR“ steht für „PHP Standards Recommendation“. PSR-2 wurde speziell entwickelt, um den Code lesbarer und einheitlicher zu machen, sodass verschiedene Entwicklerteams besser zusammenarbeiten können.
{ für Klassen und Methoden gehört in die nächste Zeile, die für Kontrollstrukturen wie if oder for in dieselbe Zeile.=, +, etc., wird ein Leerzeichen verwendet.Hier ist ein einfaches Beispiel, das die Richtlinien zeigt:
<?php
namespace Vendor\Package;
class ExampleClass
{
public function exampleMethod($arg1, $arg2 = null)
{
if ($arg1 === $arg2) {
throw new \Exception('Arguments cannot be equal');
}
return $arg1;
}
}PSR-2 wurde inzwischen von PSR-12 erweitert und ersetzt, das zusätzliche Regeln zur Verbesserung der Code-Konsistenz einführt.
PSR-1 ist eine PHP-Standards-Empfehlung (PHP Standards Recommendation), die von der PHP-FIG (Framework Interop Group) erstellt wurde. Sie definiert grundlegende Codierungsstandards für PHP, um die Interoperabilität zwischen verschiedenen PHP-Projekten und -Frameworks zu gewährleisten. Das Ziel von PSR-1, auch als "Basic Coding Standard" bezeichnet, ist es, eine konsistente Grundlage für PHP-Code zu schaffen, was die Lesbarkeit und Zusammenarbeit bei Projekten im PHP-Ökosystem erleichtert. Die Hauptpunkte von PSR-1 umfassen:
Dateiformatierung:
<?php oder <?= Tags verwenden.Namensräume und Klassennamen:
StudlyCaps-Stil (PascalCase) deklariert werden.Konstanten-, Eigenschaften- und Methodennamen:
CONST_VALUE).camelCase-Stil geschrieben werden.Autoloading:
include- oder require-Anweisungen zu vermeiden.PSR-1 gilt als grundlegender Standard und ergänzt PSR-2 und PSR-12, die detailliertere Codeformatierungsrichtlinien festlegen. Zusammen verbessern diese Standards die Lesbarkeit und Konsistenz von PHP-Projekten.
Churn PHP ist ein Tool, das dabei hilft, potenziell riskante oder wartungsintensive Teile in einem PHP-Code zu identifizieren. Es analysiert, wie oft Klassen oder Funktionen geändert wurden (Churn-Rate) und wie komplex sie sind (zyklomatische Komplexität). Das Hauptziel besteht darin, Bereiche im Code zu finden, die sich häufig ändern und schwer zu warten sind, was darauf hinweist, dass sie von einer Überarbeitung profitieren könnten oder genauere Aufmerksamkeit benötigen.
Kurz gesagt, Churn PHP hilft Entwicklern, technischen Schulden vorzubeugen, indem es problematische Codebereiche markiert, die in Zukunft potenziell Probleme verursachen könnten. Es lässt sich gut in Git-Repositories integrieren und kann als Teil einer CI/CD-Pipeline ausgeführt werden.
PHPmetrics ist ein Tool zur statischen Analyse von PHP-Code, das Entwicklern hilft, die Qualität und Komplexität ihres Codes zu messen. Es bietet eine Vielzahl von Metriken, die Einblicke in die Wartbarkeit, Komplexität und Struktur einer PHP-Codebasis geben. PHPmetrics erstellt dabei umfassende Berichte und Visualisierungen, die es einfach machen, Problemstellen zu identifizieren und den Zustand eines Projekts zu bewerten.
Das Tool ist besonders nützlich, um die langfristige Wartbarkeit und Qualität von PHP-Projekten sicherzustellen und kann Teil des Continuous Integration (CI)-Prozesses sein, um die Qualität im Auge zu behalten.
Dephpend ist ein statisches Analysetool für PHP, das sich auf die Analyse und Visualisierung von Abhängigkeiten innerhalb eines Codeprojekts konzentriert. Es bietet Entwicklern Einblicke in die Architektur und Struktur von PHP-Projekten, indem es die Beziehungen zwischen verschiedenen Komponenten wie Klassen und Namespaces identifiziert.
Das Tool ist besonders nützlich in großen Codebasen, um die Architektur sauber zu halten und technische Schulden zu minimieren.
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:
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.
Durch die Verwendung von PHP_CodeSniffer bleibt der Code konsistent und qualitativ hochwertig, was langfristig die Wartbarkeit eines Projekts deutlich erhöht.
Deptrac ist ein statisches Analysewerkzeug für PHP-Anwendungen, das dabei hilft, architektonische Regeln in einem Codebase durchzusetzen. Es analysiert die Abhängigkeiten eines Projekts und überprüft, ob diese den festgelegten architektonischen Vorgaben entsprechen. Das Hauptziel von Deptrac ist es, zu verhindern, dass verschiedene Komponenten zu eng miteinander gekoppelt werden, und somit eine klare, wartbare Struktur zu gewährleisten, besonders in größeren oder wachsenden Projekten.
Deptrac ist besonders nützlich, um Entkopplung und Modularität sicherzustellen, was in skalierenden und umgestaltenden Projekten entscheidend ist. Durch das frühzeitige Erkennen architektonischer Verstöße trägt es dazu bei, technische Schulden zu vermeiden.
Modernizr ist eine Open-Source-JavaScript-Bibliothek, die Entwicklern hilft, die Unterstützung moderner Webtechnologien wie HTML5 und CSS3 in verschiedenen Browsern zu erkennen. Statt sich auf die Version des Browsers zu verlassen, überprüft Modernizr, ob bestimmte Funktionen unterstützt werden, und ermöglicht so das Laden von Polyfills oder Fallbacks, wenn diese Funktionen nicht verfügbar sind.
Modernizr wird häufig verwendet, um Kompatibilität über verschiedene Browser hinweg sicherzustellen, insbesondere wenn moderne Webstandards in älteren Browsern implementiert werden müssen.
Iris
