« WeakMap::offsetUnset
Stringable::__toString »

Stringable インターフェイス

(PHP 8)

はじめに

Stringable インターフェイスは、 特定のクラスが __toString() メソッドを実装していることを示します。 ほとんどのインターフェイスと異なり、 Stringable は、マジックメソッド __toString() が定義されているあらゆるクラスで 暗黙のうちに存在すると見なされますが、 明示的に宣言することもできますし、宣言すべきです。

このインターフェイスの一番の存在意義は、 文字列プリミティブや、 文字列にキャストできるオブジェクトを受け入れる union型 string|Stringable に対する型チェックを、関数ができるようにすることです。

インターフェイス概要

interface Stringable {
/* メソッド */
public function __toString(): string
}

Stringable インターフェイスの例

例1 基本的な Stringable インターフェイスの使い方

以下は、コンストラクタのプロモーション を使っています。

<?php
class IPv4Address implements Stringable {
    public function __construct(
        private string $oct1,
        private string $oct2,
        private string $oct3,
        private string $oct4,
    ) {}

    public function __toString(): string {
        return "$this->oct1.$this->oct2.$this->oct3.$this->oct4";
    }
}

function showStuff(string|Stringable $value) {
    // Stringable を渡した場合、以下は暗黙のうちに __toString() をコールします。
    print $value;
}

$ip = new IPv4Address('123', '234', '42', '9');

showStuff($ip);
?>

上の例の出力は、 たとえば以下のようになります。

123.234.42.9

目次

関連キーワード:
Stringable   インターフェイス   toString   private   暗黙   宣言   Address   showStuff   WeakMap   offsetUnset   特定   実装   マジック   明示   意義   キャスト   union   チェック   概要   interface   基本的   使い方   コンストラクタ   プロモーション   implements
関連する関数・ページ:
stringable.tostring   class.throwable   class.reflector   reserved.interfaces   spl.interfaces   migration74.new-classes