Классы и объекты PHP: свойства, методы и $this

Класс PHP объявляется через class Name { ... } и содержит свойства (переменные) и методы (функции). new Name() создаёт по нему объект, а -> читает свойство или вызывает метод: $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";

Класс это чертёж, объект это одна вещь, собранная по нему. Из одного класса можно создать сколько угодно объектов, и у каждого свои значения свойств.

Свойства и методы

Свойство объявляется с ключевым словом видимости, необязательным типом и необязательным значением по умолчанию. Метод это функция внутри класса. Внутри метода $this это объект, для которого вызван метод, поэтому $this->balance читает баланс этого объекта.

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

Каждый объект хранит свой $balance: пополнение $a не трогает $b. Задавать свойства по одному после new утомительно; конструктор принимает начальные значения аргументами.

public, private и protected

Видимость определяет, кто может обращаться к свойству или вызывать метод:

Сделать свойство private и открыть методы это способ, которым класс защищает собственные правила. Здесь баланс меняется только через deposit() и withdraw(), которые отклоняют неверные суммы:

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

Чтение закрытого свойства снаружи класса это не предупреждение, а Error:

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

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

Типизированные свойства и неинициализированные значения

Типизированное свойство без значения по умолчанию начинается как неинициализированное, а это не то же самое, что null. Чтение до первого присваивания выбрасывает Error. Либо задайте значение по умолчанию, либо присвойте его в конструкторе, либо сделайте свойство nullable через ?Type и = 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";

Типы проверяются при присваивании. В режиме по умолчанию (нестрогом) $p->stock = '7' приводит числовую строку к 7, а $p->stock = 'many' выбрасывает TypeError.

readonly-свойства

Свойство readonly (PHP 8.1) можно записать один раз изнутри класса, и больше никогда. Это обычный способ строить объекты-значения, например денежные суммы или ID. В PHP 8.2 появился readonly class, который делает 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";
}

У readonly-свойства должен быть тип, и значения по умолчанию у него быть не может. Если нужна изменённая копия, создайте новый объект (new Order('B-2002')), а не редактируйте старый.

Вывод объекта через __toString

echo $object работает, только если класс определяет __toString(). Метод возвращает строку, которую PHP использует всякий раз, когда объект трактуется как текст: в echo, при конкатенации строк, в "{$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));

Без __toString echo $object выбрасывает Error ("Object of class Money could not be converted to string"). Для отладки print_r() и var_dump() работают с любым объектом и показывают и закрытые свойства; смотрите var_dump и print_r.

Присваивание объекта его не копирует

На этой ошибке спотыкается большинство тех, кто привык к массивам. Присваивание массива копирует его. Присваивание объекта копирует только дескриптор: обе переменные после этого указывают на один и тот же объект.

<?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 делает поверхностную копию: если свойство хранит другой объект, обе копии по-прежнему разделяют этот внутренний объект. === истинно только для одного и того же объекта, а == сравнивает значения свойств двух объектов одного класса. Передача объекта в функцию работает так же, как присваивание, поэтому функция может изменить полученный объект.