__set_stateメソッド

メソッド __set_state は静的なメソッドであり、オブジェクトに対して関数 var_export を使用したときに自動的に呼び出されます。このメソッドは、復元されたプロパティを持つ新しいクラスのインスタンスを返す必要があります。このメソッドはオブジェクトのシリアライズとデシリアライズに役立ちます。

構文

phppublic static function __set_state(array $properties): object

例

クラスを作成し、その中にメソッド __set_state を実装してみましょう:

php<?php
class MyClass {
  public $prop1;
  public $prop2;
  
  public function __construct($val1, $val2) {
    $this->prop1 = $val1;
    $this->prop2 = $val2;
  }
  
  public static function __set_state($array) {
    return new self($array['prop1'], $array['prop2']);
  }
}

$obj = new MyClass('a', 'b');
$exported = var_export($obj, true);
eval('$newObj = ' . $exported . ';');

var_dump($newObj);
?>

コードの実行結果:

phpobject(MyClass)#2 (2) {
  ["prop1"]=> string(1) "a"
  ["prop2"]=> string(1) "b"
}

例

プライベートプロパティでの __set_state の使用:

php<?php
class PrivateClass {
  private $secret;
  
  public function __construct($value) {
    $this->secret = $value;
  }
  
  public static function __set_state($array) {
    $obj = new self($array['secret']);
    return $obj;
  }
}

$privateObj = new PrivateClass('12345');
$exported = var_export($privateObj, true);
eval('$newPrivateObj = ' . $exported . ';');

var_dump($newPrivateObj);
?>

コードの実行結果:

phpobject(PrivateClass)#2 (1) {
  ["secret":"PrivateClass":private]=> string(5) "12345"
}

関連項目