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 objeto. 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() and __unset()

<?php
class PropertyTest
{

private $data = array();


public $declared = 1;


private $hidden = 2;

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

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

$trace = debug_backtrace();
trigger_error(
'Undefined property via __get(): ' . $name .
' in ' . $trace[0]['file'] .
' on line ' . $trace[0]['line'],
E_USER_NOTICE);
return
null;
}

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

public function
__unset($name)
{
echo
"Unsetting '$name'\n";
unset(
$this->data[$name]);
}


public function getHidden()
{
return
$this->hidden;
}
}


echo
"<pre>\n";

$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
"Let's experiment with the private property named 'hidden':\n";
echo
"Privates are visible inside the class, so __get() not used...\n";
echo
$obj->getHidden() . "\n";
echo
"Privates not visible outside of class, so __get() is used...\n";
echo
$obj->hidden . "\n";
?>

O exemplo acima produzirá:

 Setting 'a' to '1' Getting 'a' 1 Is 'a' set? bool(true) Unsetting 'a' Is 'a' set? bool(false) 1 Let's experiment with the private property named 'hidden': Privates are visible inside the class, so __get() not used... 2 Privates not visible outside of class, so __get() is used... Getting 'hidden' Notice: Undefined property via __get(): hidden in <file> on line 70 in <file> on line 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)
{
// Note: value of $name is case sensitive.
echo "Calling object method '$name' "
. implode(', ', $arguments). "\n";
}

public static function
__callStatic($name, $arguments)
{
// Note: value of $name is case sensitive.
echo "Calling static method '$name' "
. implode(', ', $arguments). "\n";
}
}

$obj = new MethodTest;
$obj->runTest('in object context');

MethodTest::runTest('in static context');
?>

O exemplo acima produzirá:

 Calling object method 'runTest' in object context Calling static method 'runTest' in static context 
To Top