The ReflectionProperty class

(PHP 5, PHP 7, PHP 8)

Вступ

The ReflectionProperty class reports information about class properties.

Короткий огляд класу

class ReflectionProperty implements Reflector {
/* Константи */
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;
/* Властивості */
public string $name;
public string $class;
/* Методи */
public function __construct(object|string $class, string $property)
private function __clone(): void
public static function export(mixed $class, string $name, bool $return = ?): string
public function getAttributes(?string $name = null, int $flags = 0): array
public function getDefaultValue(): mixed
public function getDocComment(): string|false
public function getHooks(): array
public function getMangledName(): string
public function getModifiers(): int
public function getName(): string
public function getRawValue(object $object): mixed
public function getSettableType(): ?ReflectionType
public function getType(): ?ReflectionType
public function getValue(?object $object = null): mixed
public function hasDefaultValue(): bool
public function hasHook(PropertyHookType $type): bool
public function hasHooks(): bool
public function hasType(): bool
public function isAbstract(): bool
public function isDefault(): bool
public function isDynamic(): bool
public function isFinal(): bool
public function isInitialized(?object $object = null): bool
public function isLazy(object $object): bool
public function isPrivate(): bool
public function isPrivateSet(): bool
public function isPromoted(): bool
public function isProtected(): bool
public function isProtectedSet(): bool
public function isPublic(): bool
public function isReadOnly(): bool
public function isStatic(): bool
public function isVirtual(): bool
#[\Deprecated]
public function setAccessible(bool $accessible): void
public function setRawValue(object $object, mixed $value): void
public function setRawValueWithoutLazyInitialization(object $object, mixed $value): void
public function setValue(?object $object, mixed $value): void
public function skipLazyInitialization(object $object): void
public function __toString(): string
}

Властивості

name

Name of the property. Read-only, throws ReflectionException in attempt to write.

class

Name of the class where the property is defined. Read-only, throws ReflectionException in attempt to write.

Попередньо визначені константи

ReflectionProperty Modifiers

ReflectionProperty::IS_STATIC int

Indicates static properties. Prior to PHP 7.4.0, the value was 1.

ReflectionProperty::IS_READONLY int

Indicates readonly properties. Available as of PHP 8.1.0.

ReflectionProperty::IS_PUBLIC int

Indicates public properties. Prior to PHP 7.4.0, the value was 256.

ReflectionProperty::IS_PROTECTED int

Indicates protected properties. Prior to PHP 7.4.0, the value was 512.

ReflectionProperty::IS_PRIVATE int

Indicates private properties. Prior to PHP 7.4.0, the value was 1024.

ReflectionProperty::IS_ABSTRACT int
Indicates the property is abstract. Available as of PHP 8.4.0.
ReflectionProperty::IS_PROTECTED_SET int
Available as of PHP 8.4.0.
ReflectionProperty::IS_PRIVATE_SET int
Available as of PHP 8.4.0.
ReflectionProperty::IS_VIRTUAL int
Available as of PHP 8.4.0.
ReflectionProperty::IS_FINAL int
Indicates the property is final. Available as of PHP 8.4.0.

Зауваження:

The values of these constants may change between PHP versions. It is recommended to always use the constants and not rely on the values directly.

Журнал змін

Версія Опис
8.4.0 The class constants are now typed.
8.4.0 Added ReflectionProperty::IS_VIRTUAL, ReflectionProperty::IS_PRIVATE_SET, ReflectionProperty::IS_PROTECTED_SET, ReflectionProperty::IS_ABSTRACT, and ReflectionProperty::IS_FINAL.
8.0.0 ReflectionProperty::export() was removed.

Зміст

add a note

User Contributed Notes 1 note

up
7
rasmus at mindplay dot dk
15 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...
To Top