Classi e oggetti in PHP: proprietà, metodi e $this

Una classe PHP si dichiara con class Name { ... } e contiene proprietà (variabili) e metodi (funzioni). new Name() crea un oggetto a partire da essa, e -> legge una proprietà o chiama un metodo: $user->name, $user->greet().

<?php
class User
{
    public string $name = 'Guest';

    public function greet(): string
    {
        return "Hello, {$this->name}";
    }
}

$user = new User();
echo $user->greet(), "\n";

$user->name = 'Ada';
echo $user->greet(), "\n";

La classe è il modello, l'oggetto è una cosa costruita a partire da esso. Puoi creare da una classe tutti gli oggetti che ti servono, e ognuno ha i propri valori delle proprietà.

Proprietà e metodi

Una proprietà si dichiara con una parola chiave di visibilità, un tipo facoltativo e un valore di default facoltativo. Un metodo è una funzione dentro la classe. Dentro un metodo, $this è l'oggetto su cui il metodo è stato chiamato, quindi $this->balance legge il saldo di quell'oggetto.

<?php
class Account
{
    public string $owner = '';
    public float $balance = 0;

    public function deposit(float $amount): void
    {
        $this->balance += $amount;
    }

    public function summary(): string
    {
        return sprintf('%s has %.2f', $this->owner, $this->balance);
    }
}

$a = new Account();
$a->owner = 'Ada';
$a->deposit(50);
$a->deposit(25.5);

$b = new Account();
$b->owner = 'Linus';
$b->deposit(10);

echo $a->summary(), "\n";
echo $b->summary(), "\n";

Ogni oggetto mantiene il proprio $balance: versare in $a non tocca $b. Impostare le proprietà una per una dopo new diventa noioso; un costruttore riceve invece i valori iniziali come argomenti.

public, private e protected

La visibilità controlla chi può accedere a una proprietà o chiamare un metodo:

Rendere una proprietà private ed esporre dei metodi è il modo in cui una classe protegge le proprie regole. Qui il saldo può cambiare solo tramite deposit() e withdraw(), che rifiutano importi non validi:

<?php
class Wallet
{
    private int $cents = 0;

    public function deposit(int $cents): void
    {
        if ($cents <= 0) {
            throw new InvalidArgumentException('Deposit must be positive');
        }
        $this->cents += $cents;
    }

    public function withdraw(int $cents): bool
    {
        if ($cents > $this->cents) {
            return false;
        }
        $this->cents -= $cents;
        return true;
    }

    public function balance(): int
    {
        return $this->cents;
    }
}

$w = new Wallet();
$w->deposit(500);
var_dump($w->withdraw(800));
var_dump($w->withdraw(200));
echo $w->balance(), "\n";

Leggere la proprietà privata dall'esterno della classe non è un warning, è un Error:

<?php
// This throws an Error on purpose: $cents is private
class Wallet
{
    private int $cents = 500;
}

$w = new Wallet();
echo $w->cents;

Proprietà tipizzate e valori non inizializzati

Una proprietà tipizzata senza valore di default parte non inizializzata, che è diverso da null. Leggerla prima che le venga assegnato qualcosa lancia un Error. Dalle un default, assegnala nel costruttore, oppure rendila nullable con ?Type e = null.

<?php
class Product
{
    public string $name;           // no default: uninitialized
    public ?string $sku = null;    // nullable with a default
    public int $stock = 0;
}

$p = new Product();
var_dump($p->sku, $p->stock);

try {
    echo $p->name;
} catch (Error $e) {
    echo $e->getMessage(), "\n";
}

$p->name = 'Keyboard';
echo $p->name, "\n";

I tipi vengono imposti all'assegnazione. Con la modalità di default (non strict), $p->stock = '7' converte la stringa numerica in 7, mentre $p->stock = 'many' lancia un TypeError.

Proprietà readonly

Una proprietà readonly (PHP 8.1) si può scrivere una volta, dall'interno della classe, e poi mai più. È il modo consueto per costruire oggetti valore come importi di denaro o ID. PHP 8.2 ha aggiunto readonly class, che rende readonly ogni proprietà.

<?php
class Order
{
    public readonly string $id;

    public function __construct(string $id)
    {
        $this->id = $id;
    }
}

$order = new Order('A-1001');
echo $order->id, "\n";

try {
    $order->id = 'B-2002';
} catch (Error $e) {
    echo $e->getMessage(), "\n";
}

Una proprietà readonly deve avere un tipo e non può avere un valore di default. Se ti serve una copia modificata, crea un nuovo oggetto (new Order('B-2002')) invece di modificare quello vecchio.

Stampare un oggetto con __toString

echo $object funziona solo quando la classe definisce __toString(). Il metodo restituisce la stringa che PHP deve usare ogni volta che l'oggetto viene trattato come testo: in echo, nella concatenazione di stringhe, in "{$object}".

<?php
class Money
{
    public function __construct(
        private int $cents,
        private string $currency = 'EUR',
    ) {}

    public function __toString(): string
    {
        return number_format($this->cents / 100, 2) . ' ' . $this->currency;
    }
}

$price = new Money(129900);
echo $price, "\n";
echo 'Total: ' . $price . "\n";
echo "Shipping: " . new Money(450, 'USD') . "\n";

// For debugging, print_r and var_dump show the properties
print_r(new Money(5));

Senza __toString, echo $object lancia un Error ("Object of class Money could not be converted to string"). Per il debug, print_r() e var_dump() funzionano su qualsiasi oggetto e mostrano anche le proprietà private; vedi var_dump e print_r.

Assegnare un oggetto non lo copia

È l'errore che colpisce di più chi arriva dagli array. Assegnare un array lo copia. Assegnare un oggetto copia solo l'handle: entrambe le variabili puntano allora allo stesso oggetto.

<?php
class Point
{
    public int $x = 0;
    public int $y = 0;
}

$a = new Point();
$b = $a;          // same object
$b->x = 10;
echo "a->x = {$a->x}\n";

$c = clone $a;    // independent copy
$c->x = 99;
echo "a->x = {$a->x}, c->x = {$c->x}\n";

var_dump($a === $b, $a === $c, $a == $c);
var_dump($a instanceof Point);
echo get_class($c), "\n";

clone fa una copia superficiale: se una proprietà contiene un altro oggetto, entrambe le copie condividono ancora quell'oggetto interno. === è vero solo per lo stesso oggetto, mentre == confronta i valori delle proprietà di due oggetti della stessa classe. Passare un oggetto a una funzione funziona come l'assegnazione, quindi una funzione può modificare l'oggetto che riceve.