PHP: Propriétés

Propriétés

Les variables au sein d'une classe sont appelées propriétés. On peut également les retrouver sous d'autres dénominations tel que champs, mais pour cette documentation propriété sera utilisé. Elles sont définies en utilisant au moins un modificateur (tel que Visibilité, Statique, ou, à partir de PHP 8.1.0, readonly), suivi optionnellement (sauf pour les propriétés readonly), à partir de PHP 7.4, d'une déclaration de type, suivi d'une déclaration classique de variable. Cette déclaration peut comprendre une initialisation, mais celle-ci doit être une valeur constante

Note:
Une manière obsolète de déclarer une propriété de classe est d'utiliser le mot-clé var au lieu d'un modificateur.

Note: Une propriété déclarée sans modificateur de Visibilité sera déclarée comme public.

Au sein des méthodes de classes, les propriétés non statiques peuvent être appelées en utilisant la syntaxe -> (opérateur de l'objet) : $this->property (où property est le nom de la propriété). Les propriétés statiques peuvent être appelées en utilisant la syntaxe :: (deux doubles points) : self::$property. Reportez-vous à la documentation sur Statique pour plus d'informations sur la différence entre les propriétés statiques et non statiques.

La pseudo-variable $this est disponible au sein de n'importe quelle méthode, lorsque cette méthode est appelée au sein d'un objet. $this est la valeur de l'objet appelant.

Exemple #1 Déclarations de propriétés


<?php
class SimpleClass
{
   public $var1 = 'hello ' . 'world';
   public $var2 = <<<EOD
hello world
EOD;
   public $var3 = 1+2;
   // déclaration de propriété invalide :
   public $var4 = self::myStaticMethod();
   public $var5 = $myVar;

   // Déclarations valides de propriétés :
   public $var6 = myConstant;
   public $var7 = [true, false];
   public $var8 = <<<'EOD'
hello world
EOD;

   // Sans modificateur de visibilité :
   static $var9;
   readonly int $var10;
}
?>

Note:
Il existe des fonctions diverses qui permettent de gérer des classes et des objets. Voir la référence sur les Fonctions Classes/Objets.

Déclarations des types

À partir de PHP 7.4.0, les définitions de propriétés peuvent inclure une Déclarations de type, avec l'exception du type callable.

Exemple #2 Exemple de propriétés typées


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

?>

L'exemple ci-dessus va afficher :

int(1234)
NULL

Les propriétés typées doivent être initialisées avant d'y accéder, sinon, une Error sera émise.

Exemple #3 Accès aux propriétés


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

L'exemple ci-dessus va afficher :

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

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

Propriétés en lecture seule (readonly)

À partir de PHP 8.1.0, une propriété peut être déclarée avec le modificateur readonly, qui empêche la modification de la propriété après l'initialisation.

Exemple #4 Exemple de propriétés en lecture seule


<?php

class Test {
   public readonly string $prop;

   public function __construct(string $prop) {
       // Initialization légale.
       $this->prop = $prop;
   }
}

$test = new Test("foobar");
// Lecture légale.
var_dump($test->prop); // string(6) "foobar"

// Réaffectation illégal. Ce n'importe pas que la valeur assigné soit identique.
$test->prop = "foobar";
// Error: Cannot modify readonly property Test::$prop
?>

Note:
Le modificateur de lecture seule ne peut être appliqué qu'aux propriétés typées. Une propriété en lecture seule sans contrainte de type peut être créée en utilisant le type mixed.

Note:
Les propriétés statiques en lecture seule ne sont pas supportées.

Une propriété en lecture seule ne peut être initialisée qu'une seule fois, et seulement depuis la portée dans laquelle elle a été déclarée. Tout autre affectation ou modification de la propriété résultera en une exception Error.

Exemple #5 Initialisation illégale de propriétés en lecture seule


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

$test1 = new Test1;
// Initialisation illégale en dehors de la portée privée.
$test1->prop = "foobar";
// Error: Cannot initialize readonly property Test1::$prop from global scope
?>

Note:
Spécifier une valeur par défaut explicite à une propriété en lecture seule n'est pas autorisé, car une propriété en lecture seule avec une valeur par défaut est essentiellement identique à une constante, et par conséquent pas particulièrement utile.

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

Note:
Les propriétés en lecture seule ne peuvent pas être unset() une fois qu'elles ont été initialisées. Cependant, il est possible de unset une propriété en lecture seule avant son initialisation, depuis la portée où la propriété a été déclarée.

Les modifications ne sont pas nécessairement des affectations simples, tous les exemples suivants résulteront en une exception 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);
?>

Cependant, les propriétés en lecture seule n'excluent pas la mutabilité intérieure. Les objets (ou ressources) stockés dans les propriétés en lecture seule peuvent toujours être modifiés en interne :


<?php

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

$test = new Test(new stdClass);
// Mutation interne légale.
$test->obj->foo = 1;
// Réaffectation illégale.
$test->obj = new stdClass;
?>

＋add a note

User Contributed Notes 9 notes

down

339

Anonymous ¶

10 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.

down

anca at techliminal dot com ¶

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

down

Anonymous ¶

11 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).

down

php at webflips dot net ¶

8 years ago


Heredoc IS valid as of PHP 5.3 and this is documented in the manual at http://php.net/manual/en/language.types.string.php#language.types.string.syntax.heredoc

Only heredocs containing variables are invalid because then it becomes dynamic.

down

zzzzBov ¶

12 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.

down

kchlin dot lxy at gmail dot com ¶

16 days 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) {
    }
  }
*/

down

-17

Ashley Dambra ¶

8 years ago


Updated method objectThis() to transtypage class array properties or array to stdClass.

Hope it help you.

public function objectThis($array = null) {
    if (!$array) {
        foreach ($this as $property_name => $property_values) {
            if (is_array($property_values) && !empty($property_values)) {
                $this->{$property_name} = $this->objectThis($property_values);
            } else if (is_array($property_values) && empty($property_values)) {
                $this->{$property_name} = new stdClass();
            }
        }
    } else {
        $object = new stdClass();
        foreach ($array as $index => $values) {
            if (is_array($values) && empty($values)) {
                $object->{$index} = new stdClass();
            } else if (is_array($values)) {
                $object->{$index} = $this->objectThis($values);
            } else {
                $object->{$index} = $values;
            }
        }
        return $object;
    }
}

down

-11

Markus Zeller ¶

5 years ago


Accessing a property without any value initialized will give NULL.

class foo
{
  private $bar;

  public __construct()
  {
      var_dump($this->bar); // null
  }
}

down

-25

AshleyDambra at live dot com ¶

8 years ago


Add this method to you class in order to 'transtypage' all the array properties into stdClass();

Hope it help you.

public function objectThis($object = null) {
    if (!$object) {
        foreach ($this as $property_name => $property_values) {
            if (is_array($property_values)) {
                $this->{$property_name} = $this->objectThis($property_values);
            }
        }
    } else {
        $object2 = new stdClass();
        foreach ($object as $index => $values) {
            if (is_array($values)) {
                $object2->{$index} = $this->objectThis($values);
            } else {
                $object2->{$index} = $values;
            }
        }
        return $object2;
    }
}

＋add a note