PHP 8.6.0 Released!

ReflectionProperty::isReadable

(PHP 8 >= 8.6.0)

ReflectionProperty::isReadable — Verifica se umaa propriedade pode ser lida a partir de um determinado escopo

Descrição

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

Verifica se a leitura da propriedade a partir do escopo definido no parâmetro scope seria permitida. A visibilidade da propriedade, seus ganchos, os métodos mágicos __get() e __isset() e, se um object for fornecido, o estado da propriedade nesse objeto é levado em consideração.

Nota:

Um valor de retorno true não garante que a leitura da propriedade seja bem-sucedida. Por exemplo, um gancho get ou __get() ainda pode lançar uma exceção.

Parâmetros

scope

O nome da classe a partir da qual a propriedade seria lida, ou null para o escopo global, ou seja, código fora de qualquer classe. Use static::class para verificar a partir do escopo do código chamador, se estiver dentro de uma classe.

object

O objeto no qual a propriedade seria lida. Se null, apenas a declaração da propriedade é considerada. Deve ser null para propriedades estáticas.

Valor Retornado

Retorna false se a propriedade não for visível a partir do scope, se for uma propriedade virtual sem um gancho get, ou se não estiver inicializada. Caso contrário, true é retornado.

No entanto, se a classe definir __get(), true é retornado para uma propriedade não estática que não seja visível a partir do scope ou que não exista em object. Se object for fornecido e a classe também definir __isset(), o resultado da chamada __isset() é retornado em seu lugar.

Erros/Exceções

Lança uma ReflectionException se object for fornecido para uma propriedade estática, ou se object não for uma instância da classe na qual a propriedade foi declarada.

Lança um Error se scope não for o nome de uma classe existente.

Exemplos

Exemplo #1 Exemplo de ReflectionProperty::isReadable()

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

$user = new User();

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

// Sem um objeto, apenas a declaração da propriedade é considerada
var_dump($nameProperty->isReadable(null));

// A propriedade ainda não está inicializada
var_dump($nameProperty->isReadable(null, $user));

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

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

// Propriedades privadas só podem ser lidas de dentro da classe
var_dump($passwordProperty->isReadable(null));
var_dump($passwordProperty->isReadable(User::class));

O exemplo acima produzirá:

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

Notas

Nota:

Se object for um objeto lento não inicializado, chamar este método pode disparar sua inicialização.

Veja também

+adicionar nota

Notas de Usuários

Não há notas de usuários para esta página.
To Top