Submit a Pull Request Report a Bug

ReflectionProperty 类

(PHP 5, PHP 7, PHP 8)

简介

ReflectionProperty 类报告有关类属性的信息。

类摘要

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 string $name;

public string $class;

/* 方法 */

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 getDeclaringClass(): ReflectionClass

public getDefaultValue(): mixed

public getDocComment(): string|false

public getModifiers(): int

public getName(): string

public getType(): ?ReflectionType

public getValue(?object $object = null): mixed

public hasDefaultValue(): bool

public hasType(): bool

public isDefault(): bool

public isInitialized(?object $object = null): bool

public isPrivate(): bool

public isPromoted(): bool

public isProtected(): bool

public isPublic(): bool

public isReadOnly(): bool

public isStatic(): bool

public setAccessible(bool $accessible): void

public setValue(object $object, mixed $value): void

public __toString(): string

}

属性

name: 属性名。只读，在尝试赋值的时候抛出 ReflectionException。
class: 定义的属性所在的类。只读，在尝试赋值的时候抛出 ReflectionException。

预定义常量

ReflectionProperty 修饰符

ReflectionProperty::IS_STATIC: 表示 static 属性。在 PHP 7.4.0 之前，值为 1。
ReflectionProperty::IS_READONLY: 表示 readonly 属性。自 PHP 8.1.0 起可用。
ReflectionProperty::IS_PUBLIC: 表示 public 属性。在 PHP 7.4.0 之前，值为 256。
ReflectionProperty::IS_PROTECTED: 表示 protected 属性。在 PHP 7.4.0 之前，值为 512。
ReflectionProperty::IS_PRIVATE: 表示 private 属性。在 PHP 7.4.0 之前，值为 1024。

注意:
这些常量的值可能会在不同 PHP 版本间发生更改。建议始终使用常量而不直接依赖值。

更新日志

版本	说明
8.0.0	已移除 ReflectionProperty::export()。

ReflectionProperty::__clone — Clone
ReflectionProperty::__construct — Construct a ReflectionProperty object
ReflectionProperty::export — Export
ReflectionProperty::getAttributes — Gets Attributes
ReflectionProperty::getDeclaringClass — Gets declaring class
ReflectionProperty::getDefaultValue — Returns the default value declared for a property
ReflectionProperty::getDocComment — Gets the property doc comment
ReflectionProperty::getModifiers — Gets the property modifiers
ReflectionProperty::getName — Gets property name
ReflectionProperty::getType — Gets a property's type
ReflectionProperty::getValue — Gets value
ReflectionProperty::hasDefaultValue — Checks if property has a default value declared
ReflectionProperty::hasType — Checks if property has a type
ReflectionProperty::isDefault — Checks if property is a default property
ReflectionProperty::isInitialized — Checks whether a property is initialized
ReflectionProperty::isPrivate — Checks if property is private
ReflectionProperty::isPromoted — Checks if property is promoted
ReflectionProperty::isProtected — Checks if property is protected
ReflectionProperty::isPublic — Checks if property is public
ReflectionProperty::isReadOnly — 检查属性是否为只读
ReflectionProperty::isStatic — Checks if property is static
ReflectionProperty::setAccessible — Set property accessibility
ReflectionProperty::setValue — Set property value
ReflectionProperty::__toString — To string

＋add a note

User Contributed Notes 2 notes

down

rasmus at mindplay dot dk ¶

13 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...