Upcoming Critical PHP Security Release

ReflectionProperty::isReadable

(PHP 8 >= 8.6.0)

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

Description

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

Vérifie si la lecture de la propriété depuis la portée scope serait autorisée. La visibilité de la propriété, ses hooks, les méthodes magiques __get() et __isset() et, si un object est fourni, l'état de la propriété sur cet objet sont pris en compte.

Note:

Une valeur de retour true ne garantit pas que la lecture de la propriété réussisse. Par exemple, un hook get ou __get() peut encore lever une exception.

Liste de paramètres

scope

Le nom de la classe depuis laquelle la propriété serait lue, 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 lue. 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 propriété n'est pas visible depuis scope, s'il s'agit d'une propriété virtuelle sans hook get, ou si elle n'est pas initialisée. Sinon, true est retourné.

Cependant, si la classe définit __get(), true est retourné pour une propriété non statique qui n'est pas visible depuis scope ou qui n'existe pas sur object. Si object est fourni et que la classe définit aussi __isset(), le résultat de l'appel à __isset() est retourné à la place.

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::isReadable()

<?php
class User
{
    public string $name;
    private string $password = 'secret';
}

$user = new User();

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

// Sans objet, seule la déclaration de la propriété est prise en compte
var_dump($nameProperty->isReadable(null));

// La propriété n'est pas encore initialisée
var_dump($nameProperty->isReadable(null, $user));

$user->name = 'Alice';
var_dump($nameProperty->isReadable(null, $user));

$passwordProperty = new ReflectionProperty(User::class, 'password');

// Les propriétés privées ne peuvent être lues que depuis l'intérieur de la classe
var_dump($passwordProperty->isReadable(null));
var_dump($passwordProperty->isReadable(User::class));

L'exemple ci-dessus va afficher :

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

Notes

Note:

Si object est un objet paresseux non initialisé, l'appel de cette méthode peut déclencher son initialisation.

Voir aussi

+add a note

User Contributed Notes

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