The ReflectionClass class

(PHP 5, PHP 7, PHP 8)

Introduction

The ReflectionClass class reports information about a class.

Class synopsis

class ReflectionClass implements Reflector {

/* Constants */

public const int IS_IMPLICIT_ABSTRACT;

public const int IS_EXPLICIT_ABSTRACT;

public const int IS_FINAL;

public const int IS_READONLY;

public const int SKIP_INITIALIZATION_ON_SERIALIZE;

public const int SKIP_DESTRUCTOR;

/* Properties */

public string $name;

/* Methods */

public function __construct(object|string $objectOrClass)

public static function export(mixed $argument, bool $return = false): string

public function getAttributes(?string $name = null, int $flags = 0): array

public function getConstant(string $name): mixed

public function getConstants(?int $filter = null): array

public function getConstructor(): ?ReflectionMethod

public function getDefaultProperties(): array

public function getDocComment(): string|false

public function getEndLine(): int|false

public function getExtension(): ?ReflectionExtension

public function getExtensionName(): string|false

public function getFileName(): string|false

public function getInterfaceNames(): array

public function getInterfaces(): array

public function getLazyInitializer(object $object): ?callable

public function getMethod(string $name): ReflectionMethod

public function getMethods(?int $filter = null): array

public function getModifiers(): int

public function getName(): string

public function getNamespaceName(): string

public function getParentClass(): ReflectionClass|false

public function getProperties(?int $filter = null): array

public function getProperty(string $name): ReflectionProperty

public function getReflectionConstant(string $name): ReflectionClassConstant|false

public function getReflectionConstants(?int $filter = null): array

public function getShortName(): string

public function getStartLine(): int|false

public function getStaticProperties(): array

public function getStaticPropertyValue(string $name, mixed &$default = ?): mixed

public function getTraitAliases(): array

public function getTraitNames(): array

public function getTraits(): array

public function hasConstant(string $name): bool

public function hasMethod(string $name): bool

public function hasProperty(string $name): bool

public function implementsInterface(ReflectionClass|string $interface): bool

public function initializeLazyObject(object $object): object

public function inNamespace(): bool

public function isAbstract(): bool

public function isAnonymous(): bool

public function isCloneable(): bool

public function isEnum(): bool

public function isFinal(): bool

public function isInstance(object $object): bool

public function isInstantiable(): bool

public function isInterface(): bool

public function isInternal(): bool

public function isIterable(): bool

public function isReadOnly(): bool

public function isSubclassOf(ReflectionClass|string $class): bool

public function isTrait(): bool

public function isUninitializedLazyObject(object $object): bool

public function isUserDefined(): bool

public function markLazyObjectAsInitialized(object $object): object

public function newInstance(mixed ...$args): object

public function newInstanceArgs(array $args = []): ?object

public function newInstanceWithoutConstructor(): object

public function newLazyGhost(callable $initializer, int $options = 0): object

public function newLazyProxy(callable $factory, int $options = 0): object

public function resetAsLazyGhost(object $object, callable $initializer, int $options = 0): void

public function resetAsLazyProxy(object $object, callable $factory, int $options = 0): void

public function setStaticPropertyValue(string $name, mixed $value): void

public function __toString(): string

}

Properties

name: Name of the class. Read-only, throws ReflectionException in attempt to write.

Predefined Constants

ReflectionClass Modifiers

ReflectionClass::IS_IMPLICIT_ABSTRACT int: Indicates the class is abstract because it has some abstract methods.
ReflectionClass::IS_EXPLICIT_ABSTRACT int: Indicates the class is abstract because of its definition.
ReflectionClass::IS_FINAL int: Indicates the class is final.
ReflectionClass::IS_READONLY int: Indicates the class is readonly.
ReflectionClass::SKIP_INITIALIZATION_ON_SERIALIZE int: Indicates that serialize() should not trigger initialization of a lazy object.
ReflectionClass::SKIP_DESTRUCTOR int: Indicates an object destructor should not be called when resetting it as lazy.

Changelog

Version	Description
8.4.0	The class constants are now typed.
8.0.0	ReflectionClass::export() was removed.

ReflectionClass::__construct — Constructs a ReflectionClass
ReflectionClass::export — Exports a class
ReflectionClass::getAttributes — Gets Attributes
ReflectionClass::getConstant — Gets defined constant
ReflectionClass::getConstants — Gets constants
ReflectionClass::getConstructor — Gets the constructor of the class
ReflectionClass::getDefaultProperties — Gets default properties
ReflectionClass::getDocComment — Gets doc comments
ReflectionClass::getEndLine — Gets end line
ReflectionClass::getExtension — Gets a ReflectionExtension object for the extension which defined the class
ReflectionClass::getExtensionName — Gets the name of the extension which defined the class
ReflectionClass::getFileName — Gets the filename of the file in which the class has been defined
ReflectionClass::getInterfaceNames — Gets the interface names
ReflectionClass::getInterfaces — Gets the interfaces
ReflectionClass::getLazyInitializer — Gets lazy initializer
ReflectionClass::getMethod — Gets a ReflectionMethod for a class method
ReflectionClass::getMethods — Gets an array of methods
ReflectionClass::getModifiers — Gets the class modifiers
ReflectionClass::getName — Gets class name
ReflectionClass::getNamespaceName — Gets namespace name
ReflectionClass::getParentClass — Gets parent class
ReflectionClass::getProperties — Gets properties
ReflectionClass::getProperty — Gets a ReflectionProperty for a class's property
ReflectionClass::getReflectionConstant — Gets a ReflectionClassConstant for a class's constant
ReflectionClass::getReflectionConstants — Gets class constants
ReflectionClass::getShortName — Gets short name
ReflectionClass::getStartLine — Gets starting line number
ReflectionClass::getStaticProperties — Gets static properties
ReflectionClass::getStaticPropertyValue — Gets static property value
ReflectionClass::getTraitAliases — Returns an array of trait aliases
ReflectionClass::getTraitNames — Returns an array of names of traits used by this class
ReflectionClass::getTraits — Returns an array of traits used by this class
ReflectionClass::hasConstant — Checks if constant is defined
ReflectionClass::hasMethod — Checks if method is defined
ReflectionClass::hasProperty — Checks if property is defined
ReflectionClass::implementsInterface — Implements interface
ReflectionClass::initializeLazyObject — Forces initialization of a lazy object
ReflectionClass::inNamespace — Checks if in namespace
ReflectionClass::isAbstract — Checks if class is abstract
ReflectionClass::isAnonymous — Checks if class is anonymous
ReflectionClass::isCloneable — Returns whether this class is cloneable
ReflectionClass::isEnum — Returns whether this is an enum
ReflectionClass::isFinal — Checks if class is final
ReflectionClass::isInstance — Checks class for instance
ReflectionClass::isInstantiable — Checks if the class is instantiable
ReflectionClass::isInterface — Checks if the class is an interface
ReflectionClass::isInternal — Checks if class is defined internally by an extension, or the core
ReflectionClass::isIterable — Check whether this class is iterable
ReflectionClass::isIterateable — Alias of ReflectionClass::isIterable
ReflectionClass::isReadOnly — Checks if class is readonly
ReflectionClass::isSubclassOf — Checks if a subclass
ReflectionClass::isTrait — Returns whether this is a trait
ReflectionClass::isUninitializedLazyObject — Checks if an object is lazy and uninitialized
ReflectionClass::isUserDefined — Checks if user defined
ReflectionClass::markLazyObjectAsInitialized — Marks a lazy object as initialized without calling the initializer or factory
ReflectionClass::newInstance — Creates a new class instance from given arguments
ReflectionClass::newInstanceArgs — Creates a new class instance from given arguments
ReflectionClass::newInstanceWithoutConstructor — Creates a new class instance without invoking the constructor
ReflectionClass::newLazyGhost — Creates a new lazy ghost instance
ReflectionClass::newLazyProxy — Creates a new lazy proxy instance
ReflectionClass::resetAsLazyGhost — Resets an object and marks it as lazy
ReflectionClass::resetAsLazyProxy — Resets an object and marks it as lazy
ReflectionClass::setStaticPropertyValue — Sets static property value
ReflectionClass::__toString — Returns the string representation of the ReflectionClass object