Readonly-Eigenschaften (PHP 8.1)

Teil des Abschnitts Objektorientierte Programmierung der PHP-Journey von Coddy — Lektion 19 von 91.

PHP 8.1 führte readonly-Eigenschaften ein, die nur einmal zugewiesen werden können und danach nicht mehr geändert werden können. Im Gegensatz zu Konstanten werden readonly-Eigenschaften während der Objektinitialisierung und nicht zum Zeitpunkt der Klassendefinition gesetzt.

Sie deklarieren eine schreibgeschützte Eigenschaft, indem Sie das Schlüsselwort readonly vor der Typdeklaration hinzufügen:

<?php
class User {
    public readonly string $id;
    public readonly string $name;
    
    public function __construct(string $id, string $name) {
        $this->id = $id;
        $this->name = $name;
    }
}

$user = new User("U001", "Alice");
echo $user->id . "\n";
echo $user->name;

Ausgabe:

U001
Alice

Einmal zugewiesen, führt der Versuch, eine readonly-Eigenschaft zu ändern, zu einem Fehler. Dies macht sie ideal für Werte, die während der gesamten Lebensdauer eines Objekts konstant bleiben sollten, wie IDs oder Erstellungszeitstempel.

Readonly-Eigenschaften müssen eine Typdeklaration haben und können nur einmal initialisiert werden, entweder im Konstruktor oder zum Zeitpunkt der Deklaration. Sie funktionieren mit jedem Sichtbarkeitsmodifikator:

<?php
class Product {
    public function __construct(
        public readonly string $sku,
        private readonly float $cost
    ) {}
    
    public function getCost(): float {
        return $this->cost;
    }
}

$product = new Product("ABC123", 29.99);
echo $product->sku;

Ausgabe:

ABC123

Wichtiger Punkt: Readonly-Eigenschaften bieten Unveränderlichkeit auf Eigenschaftsebene. Sie sind ideal für Daten, die ein Objekt identifizieren oder nach der Erstellung nicht mehr geändert werden sollten, da sie die Flexibilität der Laufzeitinitialisierung mit der Sicherheit kombinieren, versehentliche Änderungen zu verhindern.

Aufgabe

Einfach

Lassen Sie uns ein unveränderliches Konfigurationssystem erstellen, das readonly-Eigenschaften verwendet, um sicherzustellen, dass kritische Einstellungen nach der Initialisierung nicht versehentlich geändert werden können.

Sie werden zwei Dateien erstellen, die zusammenarbeiten, um die Anwendungskonfiguration zu verwalten:

Config.php — Definieren Sie eine Config-Klasse, die die Anwendungskonfiguration mit unveränderlichen Einstellungen darstellt. Die Klasse sollte drei öffentliche readonly-Eigenschaften haben: string $appName, string $version und int $maxConnections. Verwenden Sie Constructor Promotion, um alle drei readonly-Eigenschaften in einer einzigen, sauberen Konstruktordefinition zu deklarieren und zu initialisieren. Fügen Sie eine getInfo()-Methode hinzu, die einen String im Format "[appName] v[version] (max: [maxConnections] connections)" zurückgibt.
main.php — Binden Sie die Config-Klassendatei ein. Sie erhalten drei Eingaben: den App-Namen, die Version und die maximale Anzahl an Verbindungen (als String, der in eine Ganzzahl umgewandelt werden muss). Erstellen Sie ein Config-Objekt unter Verwendung dieser Werte. Geben Sie das Ergebnis von getInfo() in der ersten Zeile aus. Geben Sie dann jede readonly-Eigenschaft in einer eigenen Zeile aus, indem Sie direkt auf sie zugreifen: den App-Namen, die Version und die maximalen Verbindungen.

Die readonly-Eigenschaften stellen sicher, dass die Werte einer Konfiguration nach deren Erstellung festgeschrieben sind – ideal für Einstellungen, die während der Laufzeit Ihrer Anwendung konstant bleiben sollen. Beachten Sie, wie Constructor Promotion in Kombination mit readonly eine sehr prägnante Möglichkeit bietet, unveränderliche Wertobjekte zu definieren.

Ihre Ausgabe sollte den formatierten Info-String gefolgt von jedem einzelnen Eigenschaftswert anzeigen und so demonstrieren, dass readonly-Eigenschaften weiterhin von außerhalb der Klasse gelesen werden können.

Spickzettel

PHP 8.1 hat readonly-Eigenschaften eingeführt, die nur einmal zugewiesen werden können und danach nicht mehr geändert werden können:

<?php
class User {
    public readonly string $id;
    public readonly string $name;
    
    public function __construct(string $id, string $name) {
        $this->id = $id;
        $this->name = $name;
    }
}

$user = new User("U001", "Alice");
echo $user->id; // U001

Readonly-Eigenschaften müssen eine Typdeklaration haben und können nur einmal initialisiert werden. Sie funktionieren mit jedem Sichtbarkeitsmodifikator und können mit Constructor Promotion kombiniert werden:

<?php
class Product {
    public function __construct(
        public readonly string $sku,
        private readonly float $cost
    ) {}
}

$product = new Product("ABC123", 29.99);
echo $product->sku; // ABC123

Readonly-Eigenschaften sind ideal für Werte, die während der gesamten Lebensdauer eines Objekts konstant bleiben sollen, wie IDs, Zeitstempel oder Konfigurationseinstellungen.

Probier es selbst

<?php

require_once 'Config.php';

// Eingaben lesen
$appName = trim(fgets(STDIN));
$version = trim(fgets(STDIN));
$maxConnections = intval(trim(fgets(STDIN)));

// TODO: Erstellen Sie ein Config-Objekt unter Verwendung der Eingabewerte

// TODO: Geben Sie das Ergebnis von getInfo() aus

// TODO: Geben Sie jede schreibgeschützte Eigenschaft in einer eigenen Zeile aus:
// - App-Name
// - Version
// - Maximale Verbindungen

?>