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

クラスは設計図で、オブジェクトはそこから作られた1つの物です。1つのクラスから必要なだけオブジェクトを作れ、それぞれが独自のプロパティの値を持ちます。

プロパティとメソッド

プロパティは、アクセス修飾子、任意の型、任意のデフォルト値で宣言します。メソッドはクラスの中の関数です。メソッドの中では、$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のあとでプロパティを1つずつ設定するのは面倒なので、コンストラクタで初期値を引数として受け取ります。

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

privateなプロパティをクラスの外から読むのは、警告ではなく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が投げられます。デフォルト値を与えるか、コンストラクタで代入するか、?Typeと= nullで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";

型は代入のときに強制されます。デフォルト（strictでない）モードでは、$p->stock = '7'は数値文字列を7に変換し、$p->stock = 'many'はTypeErrorを投げます。

readonlyプロパティ

readonlyプロパティ（PHP 8.1）は、クラスの中から1回だけ書き込め、そのあとは二度と書き込めません。金額やIDのような値オブジェクトを作るときの定番の方法です。PHP 8.2では、すべてのプロパティをreadonlyにするreadonly classが追加されました。

<?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()を定義しているときだけ動きます。このメソッドは、echo、文字列の連結、"{$object}"など、オブジェクトがテキストとして扱われるときにPHPが使う文字列を返します。

<?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」）を投げます。デバッグには、どんなオブジェクトにも使え、privateなプロパティも表示する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は浅いコピーを作ります。プロパティが別のオブジェクトを持っていれば、両方のコピーがその内側のオブジェクトを共有したままです。===は同じオブジェクトのときだけtrueで、==は同じクラスの2つのオブジェクトのプロパティの値を比べます。オブジェクトを関数に渡すのも代入と同じ動きなので、関数は受け取ったオブジェクトを変更できます。