Klasy i obiekty w PHP: właściwości, metody i $this

Klasę w PHP deklaruje się przez class Name { ... }; zawiera właściwości (zmienne) i metody (funkcje). new Name() tworzy z niej obiekt, a -> czyta właściwość lub wywołuje metodę: $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";

Klasa to szablon, a obiekt to jedna rzecz z niego zbudowana. Z jednej klasy możesz utworzyć tyle obiektów, ile potrzebujesz, a każdy ma własne wartości właściwości.

Właściwości i metody

Właściwość deklaruje się słowem kluczowym widoczności, opcjonalnym typem i opcjonalną wartością domyślną. Metoda to funkcja wewnątrz klasy. W metodzie $this to obiekt, na którym ją wywołano, więc $this->balance czyta saldo tego obiektu.

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

Każdy obiekt ma własne $balance: wpłata na $a nie rusza $b. Ustawianie właściwości jedna po drugiej po new szybko staje się męczące; konstruktor przyjmuje wartości początkowe jako argumenty.

public, private i protected

Widoczność określa, kto może ruszać właściwość lub wywoływać metodę:

Prywatna właściwość i publiczne metody to sposób, w jaki klasa pilnuje własnych zasad. Tutaj saldo może zmienić się tylko przez deposit() i withdraw(), które odrzucają złe kwoty:

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

Odczyt prywatnej właściwości spoza klasy to nie ostrzeżenie, tylko Error:

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

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

Właściwości typowane i niezainicjowane wartości

Właściwość typowana bez wartości domyślnej zaczyna jako niezainicjowana, co różni się od null. Odczyt przed przypisaniem czegokolwiek rzuca Error. Daj jej wartość domyślną, przypisz ją w konstruktorze albo uczyń ją nullable przez ?Type i = 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";

Typy są wymuszane przy przypisaniu. W domyślnym (nieścisłym) trybie $p->stock = '7' zamienia string liczbowy na 7, a $p->stock = 'many' rzuca TypeError.

Właściwości readonly

Właściwość readonly (PHP 8.1) można zapisać raz, z wnętrza klasy, a potem już nigdy. To zwykły sposób budowania obiektów wartości, takich jak kwoty pieniężne czy identyfikatory. PHP 8.2 dodało readonly class, które czyni readonly każdą właściwość.

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

Właściwość readonly musi mieć typ i nie może mieć wartości domyślnej. Jeśli potrzebujesz zmienionej kopii, utwórz nowy obiekt (new Order('B-2002')) zamiast edytować stary.

Wypisywanie obiektu przez __toString

echo $object działa tylko wtedy, gdy klasa definiuje __toString(). Metoda zwraca string, którego PHP używa zawsze, gdy obiekt jest traktowany jak tekst: w echo, przy łączeniu stringów, w "{$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));

Bez __toString echo $object rzuca Error („Object of class Money could not be converted to string”). Do debugowania print_r() i var_dump() działają na każdym obiekcie i pokazują też właściwości prywatne; zobacz var_dump i print_r.

Przypisanie obiektu go nie kopiuje

To błąd, na który najczęściej nadziewają się osoby przyzwyczajone do tablic. Przypisanie tablicy ją kopiuje. Przypisanie obiektu kopiuje tylko uchwyt: obie zmienne wskazują wtedy ten sam obiekt.

<?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 robi płytką kopię: jeśli właściwość zawiera inny obiekt, obie kopie nadal współdzielą ten wewnętrzny obiekt. === daje prawdę tylko dla tego samego obiektu, a == porównuje wartości właściwości dwóch obiektów tej samej klasy. Przekazanie obiektu do funkcji działa tak samo jak przypisanie, więc funkcja może zmienić otrzymany obiekt.