Classes e objetos em PHP: propriedades, métodos e $this

Uma classe PHP é declarada com class Name { ... } e guarda propriedades (variáveis) e métodos (funções). new Name() cria um objeto a partir dela, e -> lê uma propriedade ou chama um método: $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";

A classe é o molde, o objeto é uma coisa construída a partir dele. Você pode criar quantos objetos precisar a partir de uma classe, e cada um tem os próprios valores de propriedades.

Propriedades e métodos

Uma propriedade é declarada com uma palavra-chave de visibilidade, um tipo opcional e um valor padrão opcional. Um método é uma função dentro da classe. Dentro de um método, $this é o objeto em que o método foi chamado, então $this->balance lê o saldo daquele objeto.

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

Cada objeto mantém o próprio $balance: depositar em $a não mexe em $b. Definir propriedades uma por uma depois do new fica cansativo; um construtor recebe os valores iniciais como argumentos.

public, private e protected

A visibilidade controla quem pode mexer numa propriedade ou chamar um método:

Tornar uma propriedade private e expor métodos é como uma classe protege as próprias regras. Aqui o saldo só pode mudar por deposit() e withdraw(), que recusam valores inválidos:

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

Ler a propriedade privada de fora da classe não é um aviso, é um Error:

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

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

Propriedades tipadas e valores não inicializados

Uma propriedade tipada sem valor padrão começa não inicializada, o que é diferente de null. Lê-la antes de qualquer atribuição lança um Error. Dê a ela um padrão, atribua no construtor, ou torne-a nullable com ?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";

Os tipos são verificados na atribuição. No modo padrão (não estrito), $p->stock = '7' converte a string numérica em 7, enquanto $p->stock = 'many' lança um TypeError.

Propriedades readonly

Uma propriedade readonly (PHP 8.1) pode ser escrita uma vez, de dentro da classe, e nunca mais. É o jeito comum de criar objetos de valor, como quantias em dinheiro ou IDs. O PHP 8.2 adicionou readonly class, que torna todas as propriedades readonly.

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

Uma propriedade readonly precisa ter um tipo e não pode ter valor padrão. Se você precisa de uma cópia alterada, crie um novo objeto (new Order('B-2002')) em vez de editar o antigo.

Imprimir um objeto com __toString

echo $object só funciona quando a classe define __toString(). O método retorna a string que o PHP deve usar sempre que o objeto é tratado como texto: no echo, na concatenação de strings, em "{$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));

Sem __toString, echo $object lança um Error ("Object of class Money could not be converted to string"). Para depurar, print_r() e var_dump() funcionam com qualquer objeto e também mostram as propriedades privadas; veja var_dump e print_r.

Atribuir um objeto não o copia

Esse é o erro que mais pega quem vem dos arrays. Atribuir um array o copia. Atribuir um objeto copia só o handle: as duas variáveis passam a apontar para o mesmo objeto.

<?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 faz uma cópia rasa: se uma propriedade guarda outro objeto, as duas cópias continuam compartilhando esse objeto interno. === só é verdadeiro para o mesmo objeto, enquanto == compara os valores das propriedades de dois objetos da mesma classe. Passar um objeto para uma função funciona como a atribuição, então uma função pode alterar o objeto que recebe.