Propiedades

    Las variables dentro de una clase se denominan propiedades. También pueden encontrarse bajo otros nombres como campos, pero en esta documentación se utilizará propiedad. Se definen utilizando al menos un modificador (como Visibilidad, La palabra reservada 'static', o, a partir de PHP 8.1.0, readonly), seguido opcionalmente (excepto para las propiedades readonly), a partir de PHP 7.4, de una declaración de tipo, seguido de una declaración clásica de variable. Esta declaración puede incluir una inicialización, pero esta debe ser un valor constante

    Nota:

    Una forma obsoleta de declarar una propiedad de clase es utilizar la palabra clave var en lugar de un modificador.

    Nota: Una propiedad declarada sin modificador de Visibilidad será declarada como public.

    Dentro de los métodos de clase, las propiedades no estáticas pueden ser llamadas utilizando la sintaxis -> (operador de objeto) : $this->property (donde property es el nombre de la propiedad). Las propiedades estáticas pueden ser llamadas utilizando la sintaxis :: (dos puntos) : self::$property. Consulte la documentación sobre La palabra reservada 'static' para más información sobre la diferencia entre las propiedades estáticas y no estáticas.

    La pseudo-variable $this está disponible dentro de cualquier método, cuando este método es llamado dentro de un objeto. $this es el valor del objeto que llama.

    Ejemplo #1 Declaraciones de propiedades

    <?php
    class SimpleClass
    {
    public     $var1 = 'hello ' . 'world';
    public     $var2 = <<<EOD
    hello world
    EOD;
    public     $var3 = 1+2;
    // declaración de propiedad inválida :
    public $var4 = self::myStaticMethod();
    public     $var5 = $myVar;

    // Declaraciones válidas de propiedades :
    public $var6 = myConstant;
    public     $var7 = [true, false];
    public     $var8 = <<<'EOD'
    hello world
    EOD;

    // Sin modificador de visibilidad :
    static $var9;
    readonly     int $var10;
    }
    ?>

    Nota:

    Existen diversas funciones que permiten gestionar clases y objetos. Ver la referencia sobre las Funciones Clases/Objetos.

    Declaraciones de tipos

    A partir de PHP 7.4.0, las definiciones de propiedades pueden incluir una Declaraciones de tipo, con la excepción del tipo callable.

    Ejemplo #2 Ejemplo de propiedades 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);

    ?>

    El resultado del ejemplo sería:

    int(1234)
NULL

    Las propiedades tipadas deben ser inicializadas antes de acceder a ellas, de lo contrario, se emitirá un Error.

    Ejemplo #3 Acceso a las propiedades

    <?php

    class Shape
    {
    public     int $numberOfSides;
    public     string $name;

    public function     setNumberOfSides(int $numberOfSides): void
    {
    $this->numberOfSides = $numberOfSides;
    }

    public function     setName(string $name): void
    {
    $this->name = $name;
    }

    public function     getNumberOfSides(): int
    {
    return     $this->numberOfSides;
    }

    public function     getName(): string
    {
    return     $this->name;
    }
    }

    $triangle = new Shape();
    $triangle->setName("triangle");
    $triangle->setNumberofSides(3);
    var_dump($triangle->getName());
    var_dump($triangle->getNumberOfSides());

    $circle = new Shape();
    $circle->setName("circle");
    var_dump($circle->getName());
    var_dump($circle->getNumberOfSides());
    ?>

    El resultado del ejemplo sería:

    string(8) "triangle"
int(3)
string(6) "circle"

Fatal error: Uncaught Error: Typed property Shape::$numberOfSides must not be accessed before initialization

    Propiedades de solo lectura (readonly)

    A partir de PHP 8.1.0, una propiedad puede ser declarada con el modificador readonly, que impide la modificación de la propiedad después de la inicialización. Antes de PHP 8.4.0 una propiedad readonly es implícitamente privada-modificable, y solo puede ser escrita desde la misma clase. A partir de PHP 8.4.0, las propiedades readonly son implícitamente protected(set), por lo que pueden ser definidas desde clases hijas. Esto puede ser reemplazado explícitamente si se desea.

    Ejemplo #4 Ejemplo de propiedades de solo lectura

    <?php

    class Test {
    public readonly     string $prop;

    public function     __construct(string $prop) {
    // Inicialización legal.
    $this->prop = $prop;
    }
    }

    $test = new Test("foobar");
    // Lectura legal.
    var_dump($test->prop); // string(6) "foobar"

    // Reasignación ilegal. No importa que el valor asignado sea idéntico.
    $test->prop = "foobar";
    // Error: Cannot modify readonly property Test::$prop
    ?>

    Nota:

    El modificador de solo lectura solo puede ser aplicado a propiedades tipadas. Una propiedad de solo lectura sin restricción de tipo puede ser creada utilizando el tipo Mixed.

    Nota:

    Las propiedades estáticas de solo lectura no son soportadas.

    Una propiedad de solo lectura solo puede ser inicializada una vez, y solo desde el ámbito en el que fue declarada. Cualquier otra asignación o modificación de la propiedad resultará en una excepción Error.

    Ejemplo #5 Inicialización ilegal de propiedades de solo lectura

    <?php
    class Test1 {
    public readonly     string $prop;
    }

    $test1 = new Test1;
    // Inicialización ilegal fuera del ámbito privado.
    $test1->prop = "foobar";
    // Error: Cannot initialize readonly property Test1::$prop from global scope
    ?>

    Nota:

    Especificar un valor por defecto explícito a una propiedad de solo lectura no está permitido, ya que una propiedad de solo lectura con un valor por defecto es esencialmente idéntica a una constante, y por lo tanto no particularmente útil.

    <?php

    class Test {
    // Fatal error: Readonly property Test::$prop cannot have default value
    public readonly int $prop = 42;
    }
    ?>

    Nota:

    Las propiedades de solo lectura no pueden ser unset() una vez que han sido inicializadas. Sin embargo, es posible unset una propiedad de solo lectura antes de su inicialización, desde el ámbito donde la propiedad fue declarada.

    Las modificaciones no son necesariamente asignaciones simples, todos los ejemplos siguientes resultarán en una excepción 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);
    ?>

    Sin embargo, las propiedades de solo lectura no excluyen la mutabilidad interna. Los objetos (o recursos) almacenados en las propiedades de solo lectura pueden seguir siendo modificados internamente :

    <?php

    class Test {
    public function     __construct(public readonly object $obj) {}
    }

    $test = new Test(new stdClass);
    // Mutación interna legal.
    $test->obj->foo = 1;
    // Reasignación ilegal.
    $test->obj = new stdClass;
    ?>

    A partir de PHP 8.3.0, las propiedades de solo lectura pueden ser reinicializadas al clonar un objeto utilizando el método __clone().

    Ejemplo #6 Propiedades de solo lectura y clonación

    <?php
    class Test1 {
    public readonly ?    string $prop;

    public function     __clone() {
    $this->prop = null;
    }

    public function     setProp(string $prop): void {
    $this->prop = $prop;
    }
    }

    $test1 = new Test1;
    $test1->setProp('foobar');

    $test2 = clone $test1;
    var_dump($test2->prop); // NULL
    ?>

    Propiedades Dinámicas

    Al intentar asignar a una propiedad no existente en un object, PHP creará automáticamente una propiedad correspondiente. Esta propiedad creada dinámicamente estará únicamente disponible en esta instancia de clase.

    Advertencia

    Las propiedades dinámicas están obsoletas a partir de PHP 8.2.0. Se recomienda declarar la propiedad en su lugar. Para manejar nombres de propiedades arbitrarios, la clase debería implementar los métodos mágicos __get() y __set(). Como último recurso, la clase puede ser marcada con el atributo #[\AllowDynamicProperties].

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 3 notes

    up
    88
    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
    69
    Anonymous
    14 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
    28
    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
    To Top