PHPのインターフェース：implements、定数と例

PHPのインターフェースは、クラスが提供すると約束するメソッドを、コードなしで宣言します：interface Shape { public function area(): float; }。implements Shapeと書いたクラスはarea()を定義しなければならず、Shapeで型宣言した関数はどれもそのクラスを受け付けます。

<?php
interface Shape
{
    public function area(): float;
}

class Square implements Shape
{
    public function __construct(private float $side) {}

    public function area(): float
    {
        return $this->side ** 2;
    }
}

class Circle implements Shape
{
    public function __construct(private float $r) {}

    public function area(): float
    {
        return round(M_PI * $this->r ** 2, 2);
    }
}

function describe(Shape $s): string
{
    return get_class($s) . ' with area ' . $s->area();
}

echo describe(new Square(3)), "\n";
echo describe(new Circle(2)), "\n";
var_dump(new Circle(1) instanceof Shape);

describe()はどのクラスを受け取るかを知りませんし、気にもしません。インターフェースの約束だけに頼っているので、新しいTriangle implements Shapeも1行も変えずに使えます。

インターフェースに対してプログラムする

インターフェースを書くよくある理由は、コードが特定のクラスではなく能力に依存できるようにすることです。ここでは注文サービスがどんなNotifierでも受け付けるので、同じコードで本番ではメールを送り、テストではメッセージを集められます。

<?php
interface Notifier
{
    public function send(string $to, string $message): bool;
}

class EmailNotifier implements Notifier
{
    public function send(string $to, string $message): bool
    {
        echo "Email to $to: $message\n";
        return true;
    }
}

class FakeNotifier implements Notifier
{
    public array $sent = [];

    public function send(string $to, string $message): bool
    {
        $this->sent[] = [$to, $message];
        return true;
    }
}

class OrderService
{
    public function __construct(private Notifier $notifier) {}

    public function place(string $customer, int $orderId): void
    {
        $this->notifier->send($customer, "Order #$orderId confirmed");
    }
}

(new OrderService(new EmailNotifier()))->place('ada@example.com', 1001);

$fake = new FakeNotifier();
(new OrderService($fake))->place('linus@example.com', 1002);
print_r($fake->sent);

複数のインターフェースを実装する

クラスが継承できる親は1つだけですが、インターフェースは必要なだけ実装できます。implementsのあとにカンマで区切って並べ、そのすべてのメソッドを定義します。

<?php
interface HasName
{
    public function name(): string;
}

interface Exportable
{
    public function toArray(): array;
}

class Product implements HasName, Exportable, JsonSerializable
{
    public function __construct(private string $title, private int $priceCents) {}

    public function name(): string
    {
        return $this->title;
    }

    public function toArray(): array
    {
        return ['title' => $this->title, 'price' => $this->priceCents / 100];
    }

    public function jsonSerialize(): array
    {
        return $this->toArray();
    }
}

$p = new Product('Desk lamp', 3490);
echo $p->name(), "\n";
print_r($p->toArray());
echo json_encode($p), "\n";
print_r(class_implements($p));

JsonSerializableはPHPの組み込みインターフェースの1つで、実装するとそのオブジェクトに対してjson_encode()が何を出力するかを制御できます。

インターフェースの定数

インターフェースは定数を宣言できます。実装するクラスはすべてそれを受け継ぎ、インターフェース名でもクラス名でも読めます。

<?php
interface HttpStatus
{
    const OK = 200;
    const NOT_FOUND = 404;
}

class Response implements HttpStatus
{
    public function __construct(public int $status = self::OK) {}

    public function isError(): bool
    {
        return $this->status >= 400;
    }
}

echo HttpStatus::NOT_FOUND, "\n";
echo Response::OK, "\n";

$r = new Response(Response::NOT_FOUND);
var_dump($r->isError());

PHP 8.3では、インターフェースが持てるのはメソッドと定数だけで、プロパティは持てません。メソッドはstaticでもかまいません。インターフェースにpublic static function fromArray(array $data): static;と書けば、各クラスにその静的メソッドの定義を義務づけられます。関連する決まった値の集合には、インターフェースの定数を並べるよりenumのほうが合っていることがよくあります。

インターフェースはほかのインターフェースを継承できる

インターフェースもextendsを使い、クラスと違って一度に複数を継承できます。子のインターフェースを実装するクラスは、連鎖全体のメソッドを定義しなければなりません。

<?php
interface Readable
{
    public function read(): string;
}

interface Writable
{
    public function write(string $data): void;
}

interface Stream extends Readable, Writable
{
    public function close(): void;
}

class MemoryStream implements Stream
{
    private string $buffer = '';

    public function read(): string { return $this->buffer; }
    public function write(string $data): void { $this->buffer .= $data; }
    public function close(): void { $this->buffer = ''; }
}

$s = new MemoryStream();
$s->write('Hello, ');
$s->write('stream');
echo $s->read(), "\n";
var_dump($s instanceof Readable, $s instanceof Writable);

組み込みインターフェース：Countable、IteratorAggregate、Stringable

PHPには、オブジェクトを言語の機能に結びつけるインターフェースが用意されています。Countableはcount($obj)を、IteratorAggregateはforeachを動くようにし、Stringableは__toString()メソッドを持つすべてのクラスで自動的に実装されます。

<?php
class Playlist implements Countable, IteratorAggregate
{
    private array $songs = [];

    public function add(string $song): static
    {
        $this->songs[] = $song;
        return $this;
    }

    public function count(): int
    {
        return count($this->songs);
    }

    public function getIterator(): Iterator
    {
        return new ArrayIterator($this->songs);
    }

    public function __toString(): string
    {
        return implode(' / ', $this->songs);
    }
}

$list = (new Playlist())->add('Intro')->add('Blue')->add('Outro');

echo count($list), " songs\n";
foreach ($list as $i => $song) {
    echo "$i: $song\n";
}
var_dump($list instanceof Stringable);
echo "$list\n";

メソッドの書き忘れ

インターフェースを実装すると宣言したクラスがメソッドを1つでも欠いていると、PHPは足りないメソッドの名前を示す致命的エラーで止まります。

<?php
// This fails on purpose: Invoice does not define total()
interface Billable
{
    public function total(): float;
    public function currency(): string;
}

class Invoice implements Billable
{
    public function currency(): string
    {
        return 'EUR';
    }
}

echo (new Invoice())->currency();

total()メソッドを加えればスクリプトは動きます。抽象クラスならインターフェースのメソッドを未定義のままにでき、これがエラーメッセージの示す逃げ道です。

インターフェースと抽象クラスの違い

どちらもクラスが持つべきメソッドを定義し、どちらも型宣言に使えます。違いは、ほかに何を含められるかと、1つのクラスがいくつ使えるかです。

2つはうまく組み合わせられます。型宣言用にインターフェースを定義し、共通のコードでそれを実装する抽象基底クラスを用意します。別の基底クラスが必要なクラスは、今まで通りインターフェースを直接実装できます。