Método __set_state

O método __set_state é estático e é chamado automaticamente ao usar a função var_export em um objeto. Ele deve retornar uma nova instância da classe com as propriedades recuperadas. Este método é útil para serialização e desserialização de objetos.

Sintaxe

phppublic static function __set_state(array $properties): object

Exemplo

Vamos criar uma classe e implementar nela o método __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);
?>

Resultado da execução do código:

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

Exemplo

Usando __set_state com propriedades privadas:

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

Resultado da execução do código:

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

Veja também

  • a função var_export,
    que exporta uma variável para uma string
  • o método __sleep,
    que é chamado antes da serialização de um objeto
  • o método __wakeup,
    que é chamado na desserialização de um objeto