PHP 8.5.13 Released!

ReflectionProperty::isWritable

(PHP 8 >= 8.6.0)

ReflectionProperty::isWritable — Vérifie si une propriété peut être modifiée depuis une portée donnée

Description

public function ReflectionProperty::isWritable(?string $scope, ?object $object = null): bool

Vérifie si l'écriture de la propriété depuis la portée scope serait autorisée. La visibilité de la propriété, y compris sa visibilité asymétrique, ses hooks, la méthode magique __set() et, si un object est fourni, l'état d'une propriété en lecture seule sur cet objet sont pris en compte.

Note:

Une valeur de retour true ne garantit pas que l'écriture de la propriété réussisse. Par exemple, un hook set ou __set() peut encore lever une exception, et le type de la valeur assignée n'est pas pris en compte.

Liste de paramètres

scope

Le nom de la classe depuis laquelle la propriété serait écrite, ou null pour la portée globale, c'est-à-dire le code situé en dehors de toute classe. Utilisez static::class pour vérifier depuis la portée du code appelant, s'il se trouve dans une classe.

object

L'objet sur lequel la propriété serait écrite. Si null, seule la déclaration de la propriété est prise en compte. Doit être null pour les propriétés statiques.

Valeurs de retour

Retourne false si la visibilité ou la visibilité en écriture de la propriété n'autorise pas l'écriture depuis scope, s'il s'agit d'une propriété virtuelle sans hook set, ou si object est fourni et que la propriété en lecture seule est déjà initialisée sur celui-ci. Sinon, true est retourné.

Cependant, si la classe définit __set(), true est retourné pour une propriété non statique qui n'est pas visible depuis scope.

Erreurs / Exceptions

Lève une exception ReflectionException si object est fourni pour une propriété statique, ou si object n'est pas une instance de la classe dans laquelle la propriété a été déclarée.

Lève une Error si scope n'est pas le nom d'une classe existante.

Exemples

Exemple #1 Exemple de ReflectionProperty::isWritable()

<?php
class User
{
    public readonly string $name;

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

$reflectionProperty = new ReflectionProperty(User::class, 'name');
$user = new User();

// Les propriétés en lecture seule ne peuvent être écrites que depuis l'intérieur de la classe
var_dump($reflectionProperty->isWritable(null, $user));

// La propriété n'est pas encore initialisée
var_dump($reflectionProperty->isWritable(User::class, $user));

$user->setName('Alice');
var_dump($reflectionProperty->isWritable(User::class, $user));

// Sans objet, seule la déclaration de la propriété est prise en compte
var_dump($reflectionProperty->isWritable(User::class));

L'exemple ci-dessus va afficher :

bool(false)
bool(true)
bool(false)
bool(true)

Notes

Note:

Si object est un objet paresseux non initialisé, l'appel de cette méthode sur une propriété en lecture seule peut déclencher son initialisation.

Voir aussi

+add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top