A classe ReflectionProperty

(PHP 5, PHP 7, PHP 8)

Introdução

A classe ReflectionProperty relata informações sobre as propriedades de uma classe.

Resumo da classe

class ReflectionProperty implements Reflector {
/* Constantes */
public const int IS_STATIC;
public const int IS_READONLY;
public const int IS_PUBLIC;
public const int IS_PROTECTED;
public const int IS_PRIVATE;
public const int IS_ABSTRACT;
public const int IS_PROTECTED_SET;
public const int IS_PRIVATE_SET;
public const int IS_VIRTUAL;
public const int IS_FINAL;
/* Propriedades */
public string $name;
public string $class;
/* Métodos */
public __construct(object|string $class, string $property)
private __clone(): void
public static export(mixed $class, string $name, bool $return = ?): string
public getAttributes(?string $name = null, int $flags = 0): array
public getHooks(): array
public getModifiers(): int
public getName(): string
public getRawValue(object $object): mixed
public getValue(?object $object = null): mixed
public hasHooks(): bool
public hasType(): bool
public isAbstract(): bool
public isDefault(): bool
public isDynamic(): bool
public isFinal(): bool
public isInitialized(?object $object = null): bool
public isLazy(object $object): bool
public isPrivate(): bool
public isPrivateSet(): bool
public isPromoted(): bool
public isProtected(): bool
public isPublic(): bool
public isReadOnly(): bool
public isStatic(): bool
public isVirtual(): bool
public setAccessible(bool $accessible): void
public setRawValue(object $object, mixed $value): void
public setValue(?object $object, mixed $value): void
public __toString(): string
}

Propriedades

name

Nome da propriedade. Somente leitura, lança ReflectionException ao tentar escrever.

class

Nome da classe onde a propriedade está definida. Somente leitura, lança ReflectionException ao tentar escrever.

Constantes predefinidas

Modificadores de ReflectionProperty

ReflectionProperty::IS_STATIC int

Indica propriedades estáticas. Antes do PHP 7.4.0, o valor era 1.

ReflectionProperty::IS_READONLY int

Indica propriedades somente leitura. Disponível a partir do PHP 8.1.0.

ReflectionProperty::IS_PUBLIC int

Indica propriedades públicas. Antes do PHP 7.4.0, o valor era 256.

ReflectionProperty::IS_PROTECTED int

Indica propriedades protegidas. Antes do PHP 7.4.0, o valor era 512.

ReflectionProperty::IS_PRIVATE int

Indica propriedades privadas. Antes do PHP 7.4.0, o valor era 1024.

ReflectionProperty::IS_ABSTRACT int
Indica que a propriedade é abstrata. Disponível a partir do PHP 8.4.0.
ReflectionProperty::IS_PROTECTED_SET int
Disponível a partir do PHP 8.4.0.
ReflectionProperty::IS_PRIVATE_SET int
Disponível a partir do PHP 8.4.0.
ReflectionProperty::IS_VIRTUAL int
Disponível a partir do PHP 8.4.0.
ReflectionProperty::IS_FINAL int
Indica que a propriedade é final. Disponível a partir do PHP 8.4.0.

Nota:

Os valores dessas constantes podem mudar entre as versões do PHP. É recomendável sempre usar as constantes e não depender dos valores diretamente.

Registro de Alterações

Versão Descrição
8.4.0 As constantes de classe agora são tipadas.
8.4.0 Adicionadas ReflectionProperty::IS_VIRTUAL, ReflectionProperty::IS_PRIVATE_SET, ReflectionProperty::IS_PROTECTED_SET, ReflectionProperty::IS_ABSTRACT, e ReflectionProperty::IS_FINAL.
8.0.0 ReflectionProperty::export() foi removido.

Índice

adicione uma nota

Notas Enviadas por Usuários (em inglês) 2 notes

up
7
rasmus at mindplay dot dk
14 years ago
I think a more accurate explanation is this:

The Reflection classes are designed to reflect upon the source code of an application, not on any runtime information.

I think you misunderstand the ReflectionProperty constructor in your example above. The fact that it accepts an object as argument is just a convenience feature - you are actually inspecting the class of that object, not the object itself, so it's basically equivalent to:

<?php

// works fine
$Reflection = new ReflectionProperty(get_class($a), 'a');

// throws exception
$Reflection = new ReflectionProperty(get_class($a), 'foo');

?>

Getting the class of the object you're passing in is implied, since inspecting a defined property is the purpose of this class.

In your example, $a->foo is a dynamic member - it is not defined as a member of class, so there is no defining class reference, line number, default value, etc. - which means, there is nothing to reflect upon.

Clearly this very useful library could use some real documentation...
up
0
mitgath at gmail dot com
19 days ago
There is way to get property type without reflection.
Not very clear, but there is:

<?php

function getPropType(object $object, string $propName): string
{
try {
$object->{$propName} = new class {};
} catch (
\TypeError $e) {
// @hint: question mark in type can be used to detect if property is nullable
if (preg_match('/of type \??(.*)$/', $e->getMessage(), $m)) {
return
$m[1];
}
throw
$e;
} catch (
\Error $e) {
// property doesn't exist or is not public
throw $e;
}
throw new
\TypeError(sprintf('Property %s of class %s has no type', $propName, $object::class));
// alternatively return 'mixed';
}
?>

note: in case you need access to private/protected properties its easy to change this to be embedded in any class:

<?php

trait PropertyTypeResolver
{
public function
getPropType(string $propName): string
{
try {
$this->{$propName} = new class {};
} catch (
\TypeError $e) {
// @hint: question mark in type can be used to detect if property is nullable
if (preg_match('/of type \??(.*)$/', $e->getMessage(), $m)) {
return
$m[1];
}
throw
$e;
} catch (
\Error $e) {
// property doesn't exist
throw $e;
}
throw new
\TypeError(sprintf('Property %s of class %s has no type', $propName, $this::class));
// alternatively return 'mixed';
}
}
?>
To Top