Serializable インターフェイス

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

はじめに

独自のシリアライズ用のインターフェイスです。

このインターフェイスを実装したクラスは __sleep()__wakeup() をサポートしなくなります。 シリアライズが必要な場合には、自動的に serialize メソッドがコールされます。 このメソッドは __destruct() を実行しません。また、 メソッド内で明示的に書かない限りは一切の副作用を及ぼしません。 アンシリアライズされるときにはそのクラスが自動的に検知し、__construct() メソッドのかわりに適切な unserialize() メソッドがコールされます。 標準のコンストラクタを実行させたい場合は、unserialize() メソッドの中でそれをコールします。

警告

PHP 8.1.0 以降は、 __serialize()__unserialize() がない状態で Serializable を実装したクラスに対しては、推奨されない警告が発生します。

インターフェイス概要

interface Serializable {
/* メソッド */
public serialize(): ?string
public unserialize(string $data): void
}

例1 基本的な使用法

<?php
class obj implements Serializable {
    private 
$data;
    public function 
__construct() {
        
$this->data "My private data";
    }
    public function 
serialize() {
        return 
serialize($this->data);
    }
    public function 
unserialize($data) {
        
$this->data unserialize($data);
    }
    public function 
getData() {
        return 
$this->data;
    }
}

$obj = new obj;
$ser serialize($obj);

var_dump($ser);

$newobj unserialize($ser);

var_dump($newobj->getData());
?>

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

string(38) "C:3:"obj":23:{s:15:"My private data";}"
string(15) "My private data"

目次

関連キーワード:  Serializable, メソッド, unserialize, serialize, クラス, string, コール, data, public, 実行