الواجهات في 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، فتستطيع الشيفرة نفسها إرسال البريد في بيئة الإنتاج وجمع الرسائل في الاختبار:

<?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; في الواجهة كل صنف بتعريف ذلك التابع الساكن. ولمجموعة ثابتة من القيم المترابطة، كثيرًا ما يكون التعداد أنسب من قائمة ثوابت في واجهة.

الواجهة تستطيع وراثة واجهات أخرى

تستخدم الواجهات 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() فيعمل السكربت. ويمكن لـ الصنف المجرد أن يترك توابع الواجهة دون تعريف، وهذا هو المخرج الذي تقترحه رسالة الخطأ.

الواجهة مقابل الصنف المجرد

كلاهما يعرّف توابع يجب أن يملكها الصنف، وكلاهما يمكن استخدامه تلميحًا بالنوع. والفرق في ما يمكن أن يحتويه كل منهما وفي عدد ما يستطيع الصنف استخدامه:

يجتمعان جيدًا: عرّف الواجهة للتلميح بالنوع، وقدّم صنفًا أساسيًا مجردًا ينفّذها بالشيفرة المشتركة. والأصناف التي تحتاج إلى أساس مختلف تستطيع مع ذلك تنفيذ الواجهة مباشرة.