Metoden __set_state

Metoden __set_state er statisk og kalles automatisk når funksjonen var_export brukes på et objekt. Den skal returnere en ny forekomst av klassen med gjenopprettede egenskaper. Denne metoden er nyttig for serialisering og deserialisering av objekter.

Syntaks

phppublic static function __set_state(array $properties): object

Eksempel

La oss opprette en klasse og implementere metoden __set_state i den:

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

Resultat av kjøring av koden:

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

Eksempel

Bruk av __set_state med private egenskaper:

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

Resultat av kjøring av koden:

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

Se også

  • funksjonen var_export,
    som eksporterer en variabel til en streng
  • metoden __sleep,
    som kalles før serialisering av et objekt
  • metoden __wakeup,
    som kalles ved deserialisering av et objekt