Propriétés en lecture seule (PHP 8.1)

Fait partie de la section Programmation Orientée Objet du Journey PHP de Coddy. Leçon 19 sur 91.

PHP 8.1 a introduit les propriétés readonly, qui ne peuvent être affectées qu’une seule fois et ne peuvent pas être modifiées par la suite. Contrairement aux constantes, les propriétés en lecture seule sont définies lors de l’initialisation de l’objet plutôt qu’au moment de la définition de la classe.

Vous déclarez une propriété en lecture seule en ajoutant le mot-clé readonly avant la déclaration du type :

<?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;

Sortie :

U001
Alice

Une fois assignée, toute tentative de modification d’une propriété readonly provoquera une erreur. Cela les rend parfaites pour les valeurs qui doivent rester constantes pendant toute la durée de vie d’un objet, comme les identifiants ou les horodatages de création.

Les propriétés en lecture seule doivent avoir une déclaration de type et ne peuvent être assignées qu’une seule fois, depuis la classe qui les déclare (généralement dans le constructeur). Contrairement aux propriétés normales, elles ne peuvent pas recevoir de valeur par défaut lors de leur déclaration. Elles fonctionnent avec n’importe quel modificateur de visibilité :

<?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;

Sortie :

ABC123

Point clé : Les propriétés en lecture seule assurent l’immutabilité au niveau de la propriété. Elles sont idéales pour les données qui identifient un objet ou qui ne devraient pas changer après sa création, en combinant la flexibilité de l’initialisation à l’exécution avec la sécurité qu’offre la prévention des modifications accidentelles.

Défi

Facile

Construisons un système de configuration immuable qui utilise des propriétés readonly afin de garantir que les paramètres critiques ne puissent pas être modifiés accidentellement après leur initialisation.

Vous allez créer deux fichiers qui fonctionnent ensemble pour gérer la configuration de l’application :

Config.php : définissez une classe Config qui représente la configuration de l’application avec des paramètres immuables. La classe doit posséder trois propriétés publiques readonly : string $appName, string $version et int $maxConnections. Utilisez la promotion du constructeur pour déclarer et initialiser les trois propriétés readonly dans une seule définition de constructeur claire et concise. Ajoutez une méthode getInfo() qui renvoie une chaîne au format "[appName] v[version] (max: [maxConnections] connections)".
main.php : incluez le fichier de la classe Config. Vous recevrez trois entrées : le nom de l’application, la version et le nombre maximal de connexions (sous forme de chaîne à convertir en entier). Créez un objet Config à l’aide de ces valeurs. Affichez le résultat de getInfo() sur la première ligne. Affichez ensuite chaque propriété readonly sur sa propre ligne en y accédant directement : le nom de l’application, la version et le nombre maximal de connexions.

Les propriétés readonly garantissent qu’une fois qu’une configuration est créée, ses valeurs restent définitivement inchangées, ce qui est idéal pour les paramètres qui doivent rester constants pendant toute l’exécution de votre application. Remarquez comment la promotion du constructeur combinée à readonly permet de définir des objets-valeurs immuables de manière très concise.

Votre sortie doit afficher la chaîne d’informations formatée, suivie de la valeur de chaque propriété, afin de démontrer que les propriétés readonly peuvent toujours être lues depuis l’extérieur de la classe.

Essayez vous-même

<?php

require_once 'Config.php';

// Lire les entrées
$appName = trim(fgets(STDIN));
$version = trim(fgets(STDIN));
$maxConnections = intval(trim(fgets(STDIN)));

// TODO: Créer un objet Config en utilisant les valeurs d'entrée

// TODO: Afficher le résultat de getInfo()

// TODO: Afficher chaque propriété en lecture seule sur sa propre ligne :
// - nom de l'application
// - version
// - connexions max

?>