Métodos Mágicos

Os nomes de funções __construct, __destruct (veja Construtores e Destrutores), __call, __get, __set, __isset, __unset (veja Sobrecarga), __sleep, __wakeup, __toString, __set_state, __clone and __autoload 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.

Cuidado

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.

__sleep and __wakeup

serialize() checa se sua classe tem uma função com o nome mágico __sleep. Se tiver, a função é executa antes de qualqer 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.

O intuito do método __sleep é fechar qualquer conexão com bancos de dados que o objeto possa ter, enviando 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 daos que podem ter sido perdidas durante a serialização e realizar tarefas de reinicialização.

Exemplo 19-26. 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()
    {
        
mysql_close($this->link);
    }

    
public function __wakeup()
    {
        
$this->connect();
    }
}
?>

__toString

O método __toString permite que uma classe decida como se comportar quando for convertida para uma string.

Exemplo 19-27. Exemplo Simples

<?php
// Declara uma classe simples
class ClasseTeste
{
    
public $foo;

    
public function __construct($foo) {
        
$this->foo = $foo;
    }

    
public function __toString() {
        return
$this->foo;
    }
}

$classe = new ClasseTeste('Olá');
echo
$classe;
?>

O exemplo acima irá imprimir:

Olá

Vale lembrar que o método __toString só será chamado quando diretamente combinado com echo() ou print().

Exemplo 19-28. Casos onde __toString é chamado

<?php
// __toString chamado
echo $classe;

// __toString chamado (ainda um parâmetro normal para o echo)
echo 'texto', $classe;

// __toString não é chamado (operador de concatenação usado primeiro)
echo 'text' . $class;

// __toString não é chamado (converte para string primeiro)
echo (string) $class;

// __toString não é chamado (converte para string primeiro)
echo "text $class";
?>

__set_state

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, ...).