Sobrecarga

Sobrecarga em PHP provê recursos para criar dinamicamente propriedades e métodos. Estas entidades dinâmicas são processadas por métodos mágicos fornecendo a uma classe vários tipos de ações.

Os métodos de sobrecarga são invocados ao interagir com propriedades ou métodos que não foram declarados ou não são visíveis no escopo corrente. O resto desta seção usará os termos propriedades inacessíveis e métodos inacessíveis para referir-se a esta combinação de declaração e visibilidade.

Todos os métodos de sobrecarga devem ser definidos como public.

Nota:
Nenhum dos argumentos dos métodos mágicos podem ser passados por referência.

Nota:
A interpretação do PHP de sobrecarga é diferente da maioria das linguagens orientadas a objetos. Sobrecarga, tradicionalmente, provê a habilidade de ter múltiplos métodos com o mesmo nome, mas com quantidades e tipos de argumentos diferentes.

Sobrecarga de propriedades

public __set(string $name, mixed $value): void

public __get(string $name): mixed

public __isset(string $name): bool

public __unset(string $name): void

__set() é executado ao escrever dados em propriedades inacessíveis (private ou protected) ou propriedades inexistentes.

__get() é utilizado para ler dados de propriedades inacessíveis (private ou protected) ou propriedades inexistentes.

__isset() é disparado ao chamar a função isset() ou empty() em propriedades inacessíveis (private ou protected) ou propriedades inexistentes.

__unset() é invocado ao usar o construtor unset() em propriedades inacessíveis (private ou protected) ou propriedades inexistentes.

O argumento $name é o nome da propriedade com o qual se está interagindo. O argumento $value do método __set() especifica o valor para o qual a propriedade $name deveria ser definida.

A sobrecarga de propriedades funciona somente no contexto de objeto. Estes métodos mágicos não são disparados em contexto estático. Portanto estes métodos não podem ser declarados como static. Um aviso é emitido se algum método mágico de sobrecarga é declarado como static.

Nota:
O valor de retorno de __set() é ignorado por causa da forma que o PHP processa o operador de atribuição. Similarmente, o método __get() nunca é chamado em atribuições encadeadas como essa:
 $a = $obj->b = 8; 

Nota:
O PHP não irá chamar métodos sobrecarregados a partir do próprio método sobrecarregado. Isso significa, por exemplo, que escrever return $this->foo dentro de um __get() irá retornar null e lançar um E_WARNING se não houver uma foo propriedade definida, ao invés de chamar __get() uma segunda vez. Entretanto, métodos sobrecarregados podem invocar outros métodos sobrecarregados implicitamente (como um __set() chamando um __get()).

Exemplo #1 Sobrecarregando propriedades com __get(), __set(), __isset() e __unset()

<?php
class PropertyTest
{
    /** Local para dados sobrecarregados. */
    private $data = array();

    /** Sobrecarga não usada em propriedades declaradas. */
    public $declared = 1;

    /** Sobrecarga usada somente neste quando acessada fora da classe. */
    private $hidden = 2;

    public function __set($name, $value)
    {
        echo "Definindo '$name' para '$value'\n";
        $this->data[$name] = $value;
    }

    public function __get($name)
    {
        echo "Obtendo '$name'\n";
        if (array_key_exists($name, $this->data)) {
            return $this->data[$name];
        }

        $trace = debug_backtrace();
        trigger_error(
            'Propriedade indefinida via __get(): ' . $name .
            ' em ' . $trace[0]['file'] .
            ' na linha ' . $trace[0]['line'],
            E_USER_NOTICE);
        return null;
    }

    public function __isset($name)
    {
        echo "'$name' está definido?\n";
        return isset($this->data[$name]);
    }

    public function __unset($name)
    {
        echo "Removendo a definição de '$name'\n";
        unset($this->data[$name]);
    }

    /** Não é um método mágico, está aqui somente para exemplo. */
    public function getHidden()
    {
        return $this->hidden;
    }
}


$obj = new PropertyTest;

$obj->a = 1;
echo $obj->a . "\n\n";

var_dump(isset($obj->a));
unset($obj->a);
var_dump(isset($obj->a));
echo "\n";

echo $obj->declared . "\n\n";

echo "Vamos experimentar com a propriedade privada chamada 'hidden':\n";
echo "Propriedades privadas são visíveis dentro da classe, por isso __get() não é usado...\n";
echo $obj->getHidden() . "\n";
echo "Propriedades privadas não são visíveis fora da classe, por isso __get() é usado...\n";
echo $obj->hidden . "\n";
?>

O exemplo acima produzirá:

Definindo 'a' to '1'
Obtendo 'a'
1

'a' está definido?
bool(true)
Removendo a definição de 'a'
'a' está definido?
bool(false)

1

Vamos experimentar com a propriedade privada chamada 'hidden':
Propriedades privadas são visíveis dentro da classe, por isso __get() não é usado...
2
Propriedades privadas não são visíveis fora da classe, por isso __get() é usado...
Obtendo 'hidden'


Notice:  Propriedade indefinida via __get(): hidden em <file> na linha 70 em <file> na linha 29

Sobrecarga de método

public __call(string $name, array $arguments): mixed

public static __callStatic(string $name, array $arguments): mixed

__call() é disparado ao invocar métodos inacessíveis em um contexto de objeto.

__callStatic() é disparado quando invocando métodos inacessíveis em um contexto estático.

O argumento $name é o nome do método sendo chamado. O argumento $arguments é um array enumerado contendo os parâmetros passados para o método $name.

Exemplo #2 Sobrecarga de métodos instanciados com __call() e __callStatic()

<?php
class MethodTest
{
    public function __call($name, $arguments)
    {
        // Observação: valor de $name é sensível a maiúsculas/minúsculas.
        echo "Chamando método '$name' do objeto "
             . implode(', ', $arguments). "\n";
    }

    public static function __callStatic($name, $arguments)
    {
        // Observação: valor de $name é sensível a maiúsculas/minúsculas.
        echo "Chamando método '$name' estático "
             . implode(', ', $arguments). "\n";
    }
}

$obj = new MethodTest;
$obj->runTest('no contexto do objeto');

MethodTest::runTest('no contexto estático');
?>

O exemplo acima produzirá:

Chamando método 'runTest' do objeto no contexto do objeto
Chamando método 'runTest' estático no contexto estático