Método __serialize

O método mágico __serialize é chamado quando um objeto é serializado pela função serialize. Ele deve retornar um array de dados que serão serializados. Este método foi introduzido no PHP 7.4 como uma alternativa ao método __sleep com controle mais flexível sobre o processo de serialização.

Sintaxe

public function __serialize(): array

Exemplo

Vamos criar uma classe com o método __serialize que definirá quais propriedades do objeto devem ser serializadas:

<?php
class User {
	public $name;
	private $password;
	public $email;
	
	public function __construct($name, $password, $email) {
		$this->name = $name;
		$this->password = $password;
		$this->email = $email;
	}
	
	public function __serialize(): array {
		return [
			'name' => $this->name,
			'email' => $this->email,
			'hash' => md5($this->password)
		];
	}
}

$user = new User('John', 'secret123', 'john@example.com');
echo serialize($user);
?>

Resultado da execução do código:

'O:4:"User":3:{s:4:"name";s:4:"John";s:5:"email";s:15:"john@example.com";s:4:"hash";s:32:"e5e9fa1ba31ecd1ae84f75caaa474f3a";}'

Exemplo

Vamos demonstrar a diferença entre __serialize e __sleep:

<?php
class Product {
	public $id;
	protected $price;
	private $discount;
	
	public function __sleep() {
		return ['id', 'price'];
	}
	
	public function __serialize(): array {
		return [
			'id' => $this->id,
			'price' => $this->price * (1 - $this->discount)
		];
	}
}

$product = new Product();
$product->id = 100;
$product->price = 50;
$product->discount = 0.1;

echo "Sleep: " . serialize($product) . "\n";
echo "Serialize: " . serialize($product);
?>

Resultado da execução do código:

'Sleep: O:7:"Product":2:{s:2:"id";i:100;s:5:"price";i:50;}'
'Serialize: O:7:"Product":2:{s:2:"id";i:100;s:5:"price";d:45;}'

Veja também

a função serialize,
que converte um valor em uma string armazenável