Интерфейсы 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 будет с ней работать без изменения хотя бы одной строки.

Программирование на уровне интерфейса

Обычная причина написать интерфейс это позволить коду зависеть от возможности, а не от конкретного класса. Здесь сервис заказов принимает любой Notifier, поэтому один и тот же код может отправлять email в продакшене и собирать сообщения в тесте:

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

Реализация нескольких интерфейсов

Класс наследует не больше чем от одного родителя, но может реализовать столько интерфейсов, сколько нужно. Перечислите их после 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: его реализация определяет, что выдаст 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 у интерфейсов не может быть свойств, только методы и константы. Методы могут быть статическими: 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";

Забытый метод

Если класс заявляет, что реализует интерфейс, но пропускает метод, 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(), и скрипт заработает. Абстрактный класс может оставить методы интерфейса неопределёнными, и именно этот выход подсказывает сообщение об ошибке.

Интерфейс и абстрактный класс

Оба определяют методы, которые должен иметь класс, и оба можно использовать как подсказку типа. Разница в том, что ещё они могут содержать и сколько их может использовать класс:

Они хорошо сочетаются: определите интерфейс для подсказки типа и предложите абстрактный базовый класс, который реализует его с общим кодом. Классы, которым нужна другая база, по-прежнему могут реализовать интерфейс напрямую.