A __set_state metódus

A __set_state metódus statikus, és automatikusan meghívódik, amikor a var_export függvényt használjunk egy objektumon. Egy új osztálypéldányt kell visszaadnia a helyreállított tulajdonságokkal. Ez a metódus hasznos objektumok szerializálásakor és deszerializálásakor.

Szintaxis

phppublic static function __set_state(array $properties): object

Példa

Hozzunk létre egy osztályt és valósítsuk meg benne a __set_state metódust:

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

A kód végrehajtásának eredménye:

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

Példa

A __set_state használata privát tulajdonságokkal:

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

A kód végrehajtásának eredménye:

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

Lásd még

  • a var_export függvényt,
    amely egy változót exportál stringként
  • a __sleep metódust,
    amely az objektum szerializálása előtt hívódik meg
  • a __wakeup metódust,
    amely az objektum deszerializálásakor hívódik meg