Readonly classes in PHP

Introduction

Readonly classes help keep data safe by making sure once you set values, they cannot be changed later.

When you want to create objects that hold fixed information, like a person's ID or a product code.

When you want to avoid accidental changes to important data in your program.

When you want to make your code easier to understand by showing which data should never change.

Syntax

PHP

readonly class ClassName {
    public function __construct(
        public Type $property1,
        public Type $property2
    ) {}
}

The readonly keyword before class means all properties are readonly.

You must set all properties when creating the object, usually in the constructor.

Examples

This example creates a readonly class User with two properties. Once set, they cannot be changed.

PHP

<?php
readonly class User {
    public function __construct(
        public string $name,
        public int $age
    ) {}
}

$user = new User("Alice", 30);
echo $user->name . " is " . $user->age . " years old.";

This example shows a readonly class Point for fixed coordinates.

PHP

<?php
readonly class Point {
    public function __construct(
        public float $x,
        public float $y
    ) {}
}

$point = new Point(1.5, 2.5);
echo "Point coordinates: (" . $point->x . ", " . $point->y . ")";

Sample Program

This program creates a readonly class Book with title and author. It prints the book details. Trying to change the title after creation will cause an error.

PHP

<?php
readonly class Book {
    public function __construct(
        public string $title,
        public string $author
    ) {}
}

$book = new Book("1984", "George Orwell");
echo "Book: " . $book->title . " by " . $book->author . "\n";

// Trying to change a property will cause an error
// $book->title = "Animal Farm"; // This will fail

Important Notes

Readonly classes were introduced in PHP 8.2.

Once an object of a readonly class is created, you cannot change its properties.

This helps prevent bugs caused by unexpected data changes.

Summary

Readonly classes make all properties unchangeable after creation.

They are useful for fixed data that should not be modified.

Trying to change a readonly property will cause an error.

Practice

1. What does a readonly class in PHP ensure about its properties?

easy

A. Properties are static and shared between all instances.

B. Properties can be changed anytime after creation.

C. All properties cannot be changed after the object is created.

D. Properties are private and cannot be accessed outside the class.

Solution

1. Step 1: Understand the meaning of readonly class

   A readonly class means all its properties are readonly by default, so they cannot be changed after the object is created.

2. Step 2: Compare options with this definition

   Only the option stating "All properties cannot be changed after the object is created." correctly states that properties cannot be changed after creation.

3. Final Answer:

   All properties cannot be changed after the object is created. -> Option C

4. Quick Check:

   Readonly class = immutable properties [OK]

Hint: Readonly means no property changes after creation [OK]

Common Mistakes:

• Thinking readonly means private or static
• Assuming properties can be changed anytime
• Confusing readonly with access modifiers

2. Which of the following is the correct syntax to declare a readonly class in PHP?

easy

A. readonly class User { public readonly string $name; }

B. class readonly User {}

C. class User readonly {}

D. readonly class User {}

Solution

1. Step 1: Recall PHP readonly class syntax

   In PHP, the keyword readonly comes before class to declare a readonly class.

2. Step 2: Check each option

   readonly class User {} correctly uses readonly class User {}. class readonly User {} reverses the order, class User readonly {} places readonly incorrectly, and readonly class User { public readonly string $name; } is invalid syntax.

3. Final Answer:

   readonly class User {} -> Option D

4. Quick Check:

   Keyword readonly before class [OK]

Hint: Put readonly before class keyword [OK]

Common Mistakes:

• Placing readonly after class name
• Using readonly as a property only
• Mixing readonly with access modifiers

3. What will be the output of this PHP code?

readonly class Point {
    public int $x;
    public int $y;
    public function __construct(int $x, int $y) {
        $this->x = $x;
        $this->y = $y;
    }
}

$p = new Point(5, 10);
echo $p->x . ', ' . $p->y;

medium

A. 5, 10

B. Error: Cannot modify readonly property

C. 0, 0

D. 5 10

Solution

1. Step 1: Understand readonly class property initialization

   Readonly properties can be set inside the constructor. Here, $x and $y are set to 5 and 10 respectively.

2. Step 2: Check output of echo statement

   The echo prints 5, 10 as expected because the properties were initialized correctly and not modified later.

3. Final Answer:

   5, 10 -> Option A

4. Quick Check:

   Readonly properties set in constructor output values [OK]

Hint: Readonly properties can be set in constructor only [OK]

Common Mistakes:

• Thinking readonly properties cannot be set at all
• Expecting error on property access
• Confusing output format with space instead of comma

4. Identify the error in this PHP code using a readonly class:

readonly class User {
    public string $name;
    public function __construct(string $name) {
        $this->name = $name;
    }
}

$user = new User('Alice');
$user->name = 'Bob';

medium

A. Cannot assign to readonly property after construction

B. Missing readonly keyword before property declaration

C. Constructor must be static in readonly class

D. No error, code runs fine

Solution

1. Step 1: Understand readonly property behavior

   In a readonly class, properties can only be assigned once during construction. Changing them later causes an error.

2. Step 2: Analyze the code

   The code tries to change $user->name after construction, which is not allowed and causes an error.

3. Final Answer:

   Cannot assign to readonly property after construction -> Option A

4. Quick Check:

   Readonly properties are immutable after construction [OK]

Hint: Readonly properties cannot be changed after constructor [OK]

Common Mistakes:

• Thinking readonly properties can be changed anytime
• Confusing readonly class with readonly property keyword
• Ignoring error on property reassignment

5. Given this readonly class, which code snippet correctly creates an immutable user and tries to update the name without error?

readonly class User {
    public string $name;
    public function __construct(string $name) {
        $this->name = $name;
    }
}

Choose the correct approach:

hard

A. $user = new User('Alice');
$user->name = 'Bob';

B. $user = new User('Alice');
$newUser = new User('Bob');

C. $user = new User('Alice');
$user->name = strtoupper($user->name);

D. $user = new User('Alice');
unset($user->name);

Solution

1. Step 1: Understand immutability of readonly classes

   Readonly class properties cannot be changed after construction, so to 'change' data, create a new object with new values.

2. Step 2: Evaluate each option

   $user = new User('Alice'); $user->name = 'Bob'; tries to change property directly - error. $user = new User('Alice'); $user->name = strtoupper($user->name); tries to modify property - error. $user = new User('Alice'); $newUser = new User('Bob'); creates a new User object with new name - correct. $user = new User('Alice'); unset($user->name); tries to unset property - invalid.

3. Final Answer:

   Create a new User object with updated name -> Option B

4. Quick Check:

   Immutable means create new object for changes [OK]

Hint: Change readonly data by creating new object [OK]

Common Mistakes:

• Trying to modify readonly property directly
• Using unset on readonly properties
• Assuming readonly means properties can be changed