Os nomes de funções __construct, __destruct, __call, __callStatic, __get, __set, __isset, __unset, __sleep, __wakeup, __toString, __invoke, __set_state and __clone são mágicos nas classes do PHP. Você não pode ter funções com esses nomes em nenhuma de suas classes a não ser que queria que a funcionalidade mágica associada com eles.
PHP reserva todas as funções com nomes começando com __ como mágicas. É recomendado que você não use funções com nomes com __ no PHP a não ser que você queira alguma funcionalidade mágica documentada.
serialize() checa se sua classe tem uma função com
o nome mágico __sleep(). Se tiver, a função é
executa antes de qualquer serialização. Ela pode limpar o objeto
e deve retornar um array com os nomes de todas as variáveis
do objeto que devem ser serializadas. Se o método não retornar nada,
então NULL é serializada e um
E_NOTICE é disparado.
Nota:
Não é possível que __sleep() retorne nomes de propriedades privadas da classe ancestral. Isso causará um erro nível
E_NOTICE. Pode-se ser utilizada a interface Serializable se for o caso.
O intuito do método __sleep() enviar dados pendentes ou realizar tarefas similares de limpeza. Além disso, a função é útil se você tiver objetos muito grandes que não precisarão ser salvos completamente.
Inversamente, unserialize() checa pela presença da função com o nome mágico __wakeup(). Se achar, essa função pode reconstruir qualquer recursos que o objeto pode ter.
O intuito do método __wakeup() é reestabelecer qualquer conexão com banco de dados que podem ter sido perdidas durante a serialização e realizar tarefas de reinicialização.
Exemplo #1 Sleep e wakeup
<?php
class Connection
{
protected $link;
private $server, $username, $password, $db;
public function __construct($server, $username, $password, $db)
{
$this->server = $server;
$this->username = $username;
$this->password = $password;
$this->db = $db;
$this->connect();
}
private function connect()
{
$this->link = mysql_connect($this->server, $this->username, $this->password);
mysql_select_db($this->db, $this->link);
}
public function __sleep()
{
return array('server', 'username', 'password', 'db');
}
public function __wakeup()
{
$this->connect();
}
}
?>
O método __toString() permite que uma classe decida
como se comportar quando for convertida para uma string. Por exemplo,
o que echo $obj; irá imprimir. Este método precisa
retornar uma string, senão um erro nível E_RECOVERABLE_ERROR
é gerado.
Exemplo #2 Exemplo Simples
<?php
// Declare a simple class
class TestClass
{
public $foo;
public function __construct($foo)
{
$this->foo = $foo;
}
public function __toString()
{
return $this->foo;
}
}
$class = new TestClass('Hello');
echo $class;
?>
O exemplo acima irá imprimir:
Hello
Vale lembrar que antes do PHP 5.2.0 o método __toString()
só era chamado quando diretamente combinado com
echo ou print.
Desde o PHP 5.2.0, ele é chamado no contexto de string (e.g. em
printf() com modificador %s) mas não
em outros tipos de contextos (e.g. como modificador %d).
Desde o PHP 5.2.0, convertendo objetos sem o método __toString()
para string causa E_RECOVERABLE_ERROR.
O método __invoke() é chamado quando um script tenta chamar um objeto como uma função.
Nota:
Esta funcionalidade esta disponível desde o PHP 5.3.0.
Exemplo #3 Usando __invoke
<?php
class CallableClass
{
public function __invoke($x)
{
var_dump($x);
}
}
$obj = new CallableClass;
$obj(5);
var_dump(is_callable($obj));
?>
O exemplo acima irá imprimir:
int(5) bool(true)
$properties
)Esse método estático é chamado para classes exportadas por var_export() desde PHP 5.1.0.
O único parâmetro para esse método é um array contendo propriedades exportadas no formato array('property' => value, ...).
Exemplo #4 Usando __set_state() (desde o PHP 5.1.0)
<?php
class A
{
public $var1;
public $var2;
public static function __set_state($an_array) // As of PHP 5.1.0
{
$obj = new A;
$obj->var1 = $an_array['var1'];
$obj->var2 = $an_array['var2'];
return $obj;
}
}
$a = new A;
$a->var1 = 5;
$a->var2 = 'foo';
eval('$b = ' . var_export($a, true) . ';'); // $b = A::__set_state(array(
// 'var1' => 5,
// 'var2' => 'foo',
// ));
var_dump($b);
?>
O exemplo acima irá imprimir:
object(A)#2 (2) {
["var1"]=>
int(5)
["var2"]=>
string(3) "foo"
}