Propriedades
Variáveis membros de classes são chamados de propriedades.
Eles também são conhecidos por outros termos, como campos (field),
mas para propósitos deste manual será utilizado propriedade.
As propriedades podem ser definidas utilizando-se as palavras chave
public, protected ou
private, e opcionalmente a partir do PHP 7.4,
seguido também de uma declaração de tipo, finalizando com um nome de variável comum.
Essa declaração pode ainda incluir uma inicialização, desde que essa inicialização
seja um valor constante.
Veja Visibilidade para mais
informações sobre o significado
de public, protected
e private.
Nota:
Uma forma alternativa e NÃO recomendada de declarar propriedades de classe, existente por conta de compatibilidade
retroativa com o PHP, é atraǘes da palavra chave
var.
Isso declará uma propriedade com as mesmas características de uma
propriedade public.
Internamente às classes, métodos não estáticos podem ser acessados utilizando-se
-> (operador de objeto): $this->property
(onde property é o nome da propriedade).
Propriedades estáticas são acessadas utilizando-se o operador :: (duplo dois pontos), assim:
self::$property. Veja sobre palavra chave static
para mais informações sobre a diferença de propriedades estáticas e não estáticas.
A pseudo-variável $this está disponível dentro
de qualquer classe de método chamada no contexto do objeto.
$this é uma referência ao objeto de contexto do qual o método foi chamado.
Exemplo #1 Declaração de propriedades
<?php
class SimpleClass
{
public $var1 = 'Olá ' . 'mundo';
public $var2 = <<<EOD
Olá mundo
EOD;
public $var3 = 1+2;
// Declaração de propriedade inválida
public $var4 = self::myStaticMethod();
public $var5 = $myVar;
// Declaração de propriedade válida
public $var6 = myConstant;
public $var7 = [true, false];
public $var8 = <<<'EOD'
Olá mundo
EOD;
}
?>
Nota:
Existem várias funções para manipular classes e objetos.
Veja a seção sobre funções sobre classes/objetos
para mais detalhes.
Declaração de propriedades tipadas
A partir do PHP 7.4.0, definições de propriedades podem incluir uma
Type declarations,
com exceção do tipo callable.
Exemplo #2 Exemplo de propriedades tipadas
<?php
class User
{
public int $id;
public ?string $name;
public function __construct(int $id, ?string $name)
{
$this->id = $id;
$this->name = $name;
}
}
$user = new User(1234, null);
var_dump($user->id);
var_dump($user->name);
?>
O exemplo acima irá imprimir:
Propriedades tipadas precisam ser inicializadas antes de serem acessadas, senão um
Error é lançado.
Exemplo #3 Acessando propriedades
<?php
class Forma
{
public int $numeroDeLados;
public string $nome;
public function setnumeroDeLados(int $numeroDeLados): void
{
$this->numeroDeLados = $numeroDeLados;
}
public function setNome(string $nome): void
{
$this->nome = $nome;
}
public function getnumeroDeLados(): int
{
return $this->numeroDeLados;
}
public function getNome(): string
{
return $this->nome;
}
}
$triangle = new Forma();
$triangle->setNome("triângulo");
$triangle->setnumeroDeLados(3);
var_dump($triangle->getNome());
var_dump($triangle->getnumeroDeLados());
$circle = new Forma();
$circle->setNome("cículo");
var_dump($circle->getNome());
var_dump($circle->getnumeroDeLados());
?>
O exemplo acima irá imprimir:
string(9) "triângulo"
int(3)
string(7) "círculo"
Fatal error: Uncaught Error: Typed property Forma::$numeroDeLados must not be accessed before initialization
Propriedades somente leitura
A partir do PHP 8.1.0, uma propriedade pode ser declarada com o modificador readonly, o que previne modificação da propriedade após a inicialização.
Exemplo #4 Exemplo de propriedade somente leitura
<?php
class Test {
public readonly string $prop;
public function __construct(string $prop) {
// Inicialização permitida.
$this->prop = $prop;
}
}
$test = new Test("foobar");
// Legal read.
var_dump($test->prop); // string(6) "foobar"
// Modificação ilegal. Não importa que o valor seja o mesmo.
$test->prop = "foobar";
// Error: Cannot modify readonly property Test::$prop
?>
Nota:
O modificador readonly somente pode ser aplicado a propriedades tipadas.
Uma propriedade somente leitura sem restrições de tipo pode ser declarada utilizando o tipo mixed.
Nota:
Propriedades estáticas não são suportadas.
Uma propriedade somente leitura somente pode ser inicializada uma única vez, e somente do escopo onde ela foi declarada. Quaisquer outras modificações da propriedade resultam em um Error.
Exemplo #5 Inicilização ilegal de propriedades somente leitura.
<?php
class Test1 {
public readonly string $prop;
}
$test1 = new Test1;
// Inicialização ilegal fora do escopo privado.
$test1->prop = "foobar";
// Error: Cannot initialize readonly property Test1::$prop from global scope
?>
Nota:
Especificar um valor default para uma propriedade somente leitura não é permitido, porque uma propriedade com um valor default é essencialmente uma constante, e portanto não tem outro propósito.
<?php
class Test {
// Fatal error: Readonly property Test::$prop cannot have default value
public readonly int $prop = 42;
}
?>
Nota:
Propriedades somente leitura não podem ser unset() depois de inicializadas. Entretanto é possível realizar essa operação antes da inicialização, dentro do escopo onde a variável foi declarada.
Nenhum tipo de modificação é permitido, e o seguintes casos resultarão em um Error:
<?php
class Test {
public function __construct(
public readonly int $i = 0,
public readonly array $ary = [],
) {}
}
$test = new Test;
$test->i += 1;
$test->i++;
++$test->i;
$test->ary[] = 1;
$test->ary[0][] = 1;
$ref =& $test->i;
$test->i =& $ref;
byRef($test->i);
foreach ($test as &$prop);
?>
Entretanto, propriedades somente leitura não proíbem mutação. Objetos ou recursos armazenados em propriedades somente leitura ainda podem ser modificados internamente:
<?php
class Test {
public function __construct(public readonly object $obj) {}
}
$test = new Test(new stdClass);
// Modificação interna permitida
$test->obj->foo = 1;
// Reinicialização proibida.
$test->obj = new stdClass;
?>
