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é
varau 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.
À 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
À 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;
?>