Metoda __sleep

Metoda __sleep jest wywoływana automatycznie podczas serializacji obiektu za pomocą funkcji serialize. Metoda ta powinna zwracać tablicę nazw właściwości, które mają zostać uwzględnione w zserializowanej reprezentacji obiektu.

Składnia

phppublic function __sleep(): array;

Przykład

Stwórzmy klasę i zaimplementujmy metodę __sleep, aby serializować tylko określone właściwości:

php<?php
class User {
  public $name = 'John';
  public $age = 30;
  private $password = '12345';
  
  public function __sleep() {
    return ['name', 'age'];
  }
}

$user = new User();
echo serialize($user);
?>

Wynik wykonania kodu:

php'O:4:"User":2:{s:4:"name";s:4:"John";s:3:"age";i:30;}'

Przykład

Użycie __sleep do wykluczenia poufnych danych z serializacji:

php<?php
class Account {
  public $login = 'admin';
  private $password = 'secret';
  public $email = 'admin@example.com';
  
  public function __sleep() {
    return ['login', 'email'];
  }
}

$account = new Account();
echo serialize($account);
?>

Wynik wykonania kodu:

php'O:7:"Account":2:{s:5:"login";s:5:"admin";s:5:"email";s:17:"admin@example.com";}'

Zobacz też

  • metodę __wakeup,
    która jest wywoływana podczas deserializacji obiektu
  • funkcję serialize,
    która serializuje dane