Propriedades Somente para Leitura (PHP 8.1)

Parte da seção Programação Orientada a Objetos do Journey de PHP da Coddy. Lição 19 de 91.

O PHP 8.1 introduziu propriedades readonly, que só podem ser atribuídas uma vez e não podem ser modificadas posteriormente. Diferentemente das constantes, as propriedades readonly são definidas durante a inicialização do objeto, e não no momento da definição da classe.

Você declara uma propriedade somente leitura adicionando a palavra-chave readonly antes da declaração do tipo:

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

Saída:

U001
Alice

Uma vez atribuída, tentar alterar uma propriedade somente leitura causará um erro. Isso as torna perfeitas para valores que devem permanecer constantes durante toda a vida útil de um objeto, como IDs ou carimbos de data e hora de criação.

Propriedades somente leitura devem ter uma declaração de tipo e só podem ser atribuídas uma vez, dentro da classe que as declara (normalmente no construtor). Diferentemente das propriedades normais, elas não podem receber um valor padrão na declaração. Elas funcionam com qualquer modificador de visibilidade:

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

Saída:

ABC123

Ponto principal: Propriedades somente leitura fornecem imutabilidade no nível da propriedade. Elas são ideais para dados que identificam um objeto ou que não devem mudar após a criação, combinando a flexibilidade da inicialização em tempo de execução com a segurança de impedir modificações acidentais.

Desafio

Fácil

Vamos criar um sistema de configuração imutável que usa propriedades readonly para garantir que configurações críticas não possam ser alteradas acidentalmente após a inicialização.

Você criará dois arquivos que trabalham juntos para gerenciar a configuração da aplicação:

Config.php: Defina uma classe Config que represente a configuração da aplicação com configurações imutáveis. A classe deve ter três propriedades públicas readonly: string $appName, string $version e int $maxConnections. Use a promoção do construtor para declarar e inicializar as três propriedades readonly em uma única definição de construtor simples e limpa. Adicione um método getInfo() que retorne uma string no formato "[appName] v[version] (max: [maxConnections] connections)".
main.php: Inclua o arquivo da classe Config. Você receberá três entradas: o nome da aplicação, a versão e o número máximo de conexões (como uma string que precisa ser convertida em um inteiro). Crie um objeto Config usando esses valores. Imprima o resultado de getInfo() na primeira linha. Em seguida, imprima cada propriedade readonly em sua própria linha, acessando-as diretamente: o nome da aplicação, a versão e o número máximo de conexões.

As propriedades readonly garantem que, depois que uma configuração é criada, seus valores permaneçam fixos, o que é perfeito para configurações que devem permanecer constantes durante toda a execução da sua aplicação. Observe como a promoção do construtor combinada com readonly cria uma maneira muito concisa de definir objetos de valor imutáveis.

Sua saída deve exibir a string de informações formatada, seguida pelo valor individual de cada propriedade, demonstrando que as propriedades readonly ainda podem ser lidas de fora da classe.

Experimente você mesmo

<?php

require_once 'Config.php';

// Ler entradas
$appName = trim(fgets(STDIN));
$version = trim(fgets(STDIN));
$maxConnections = intval(trim(fgets(STDIN)));

// TODO: Crie um objeto Config usando os valores de entrada

// TODO: Imprima o resultado de getInfo()

// TODO: Imprima cada propriedade readonly em sua própria linha:
// - nome do app
// - versão
// - conexões máximas

?>