Edit Report a Bug

    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 o termo propriedade. Elas podem ser definidas com ao menos um modificador opcional (ver Visibilidade, Palavra-Chave 'static', ou, a partir do PHP 8.1.0, readonly), (exceto para propriedades readonly properties), 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.

    Nota:

    Uma forma obsoleta de declarar propriedades de classe é através da instrução var ao invés de um modificador.

    Nota: Uma propriedade declarada sem um modificador de Visibilidade funcionará como 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 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;

    // Sem um modificador de visibilidade:
    static $var9;
    readonly     int $var10;
    }
    ?>

    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 Declarações de tipo, 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 produzirá:

    int(1234)
NULL

    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 produzirá:

    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;
    ?>

    Propriedades dinâmicas

    Ao tentar atribuir uma propriedade inexistente em um object, o PHP irá automaticamente criar a propriedade. Essa propriedade criada dinamicamente será disponível apenas naquela instância específica.

    Aviso

    Propriedades dinâmicas foram descontinuadas a partir do PHP 8.2.0. É recomendado declarar todas as propriedades previamente. Para suportar nomes de propriedades arbitrárias, a classe deve implementar os métodos mágicos __get() e __set(). Como último recurso, a classe pode ser marcada com o atributo #[\AllowDynamicProperties].

    add a note add a note

    User Contributed Notes 5 notes

    up
    338
    Anonymous
    12 years ago
    In case this saves anyone any time, I spent ages working out why the following didn't work:

    class MyClass
    {
        private $foo = FALSE;

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

            echo($this->$foo);
        }
    }

    $bar = new MyClass();

    giving "Fatal error: Cannot access empty property in ...test_class.php on line 8"

    The subtle change of removing the $ before accesses of $foo fixes this:

    class MyClass
    {
        private $foo = FALSE;

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

            echo($this->foo);
        }
    }

    $bar = new MyClass();

    I guess because it's treating $foo like a variable in the first example, so trying to call $this->FALSE (or something along those lines) which makes no sense. It's obvious once you've realised, but there aren't any examples of accessing on this page that show that.
    up
    82
    anca at techliminal dot com
    9 years ago
    You can access property names with dashes in them (for example, because you converted an XML file to an object) in the following way:

    <?php
    $ref     = new StdClass();
    $ref->{'ref-type'} = 'Journal Article';
    var_dump($ref);
    ?>
    up
    65
    Anonymous
    13 years ago
    $this can be cast to array.  But when doing so, it prefixes the property names/new array keys with certain data depending on the property classification.  Public property names are not changed.  Protected properties are prefixed with a space-padded '*'.  Private properties are prefixed with the space-padded class name...

    <?php

    class test
    {
        public     $var1 = 1;
        protected     $var2 = 2;
        private     $var3 = 3;
        static     $var4 = 4;
       
        public function     toArray()
        {
            return (array)     $this;
        }
    }

    $t = new test;
    print_r($t->toArray());

    /* outputs:

    Array
    (
        [var1] => 1
        [ * var2] => 2
        [ test var3] => 3
    )

    */
    ?>

    This is documented behavior when converting any object to an array (see </language.types.array.php#language.types.array.casting> PHP manual page).  All properties regardless of visibility will be shown when casting an object to array (with exceptions of a few built-in objects).

    To get an array with all property names unaltered, use the 'get_object_vars($this)' function in any method within class scope to retrieve an array of all properties regardless of external visibility, or 'get_object_vars($object)' outside class scope to retrieve an array of only public properties (see: </function.get-object-vars.php> PHP manual page).
    up
    1
    kchlin dot lxy at gmail dot com
    2 years ago
    From PHP 8.1
    It's easy to create DTO object with readonly properties and promoting constructor
    which easy to pack into a compact string and covert back to a object.
    <?php
    # Conversion functions.
    # Pack object into a compack JSON string.
    function cvtObjectToJson( object $poObject ): string
    {
      return     json_encode( array_values( get_object_vars( $poObject )));
    }

    # Unpack object from a JSON string.
    function cvtJsonToObject( string $psClass, string $psString ): object
    {
      return new     $psClass( ...json_decode( $psString ));
    }

    # DTO example class.
    final class exampleDto
    {
      final public function     __construct(
        public     readonly int    $piInt,
        public     readonly ?int   $pnNull,
        public     readonly float  $pfFloat,
        public     readonly string $psString,
        public     readonly array  $paArray,
        public     readonly object $poObject,
      ){}
    }

    # Example with export only public properties of given object.
    $exampleDtoO = new exampleDto( 1, null, .3, 'string 4', [], new stdClass() );
    $stringJson  = cvtObjectToJson( $exampleDtoO );// [1,null,0.3,"string 4",[],{}]
    $objectO     = cvtJsonToObject( exampleDto::class, $stringJson );

    # Check and var_dump variables.
    echo $exampleDtoO == $objectO
          ? 'Objects equal, but not identical.'.    PHP_EOL
          : 'Objects not equal neither identical.'. PHP_EOL
    ;
    var_dump($exampleDtoO, $stringJson, $objectO);

    # Output
    /*
      Objects equal, but not identical
      object(exampleDto)#6 (6) {
      ["piInt"]=>
        int(1)
        ["pnNull"]=>
        NULL
        ["pfFloat"]=>
        float(0.3)
        ["psString"]=>
        string(8) "string 4"
      ["paArray"]=>
        array(0) {
      }
        ["poObject"]=>
        object(stdClass)#7 (0) {
        }
      }
      string(29) "[1,null,0.3,"string 4",[],{}]"
      object(exampleDto)#8 (6) {
      ["piInt"]=>
        int(1)
        ["pnNull"]=>
        NULL
        ["pfFloat"]=>
        float(0.3)
        ["psString"]=>
        string(8) "string 4"
      ["paArray"]=>
        array(0) {
      }
        ["poObject"]=>
        object(stdClass)#9 (0) {
        }
      }
    */
    up
    26
    zzzzBov
    14 years ago
    Do not confuse php's version of properties with properties in other languages (C++ for example).  In php, properties are the same as attributes, simple variables without functionality.  They should be called attributes, not properties.

    Properties have implicit accessor and mutator functionality.  I've created an abstract class that allows implicit property functionality.

    <?php

    abstract class PropertyObject
    {
      public function     __get($name)
      {
        if (    method_exists($this, ($method = 'get_'.$name)))
        {
          return     $this->$method();
        }
        else return;
      }
     
      public function     __isset($name)
      {
        if (    method_exists($this, ($method = 'isset_'.$name)))
        {
          return     $this->$method();
        }
        else return;
      }
     
      public function     __set($name, $value)
      {
        if (    method_exists($this, ($method = 'set_'.$name)))
        {
              $this->$method($value);
        }
      }
     
      public function     __unset($name)
      {
        if (    method_exists($this, ($method = 'unset_'.$name)))
        {
              $this->$method();
        }
      }
    }

    ?>

    after extending this class, you can create accessors and mutators that will be called automagically, using php's magic methods, when the corresponding property is accessed.
    add a note add a note
    To Top