#Reflector

Phuture\Coherence\Reflector

class Reflector extends StaticClass

Reflection utility class for inspecting classes, methods, properties, and functions.

This class provides a convenient wrapper around PHP's built-in reflection API, making it easier to inspect classes, methods, properties, functions, and enums without dealing directly with reflection objects and exceptions.

Key features:

• Class Inspection: Check class existence, get class names, namespaces, and parent classes
• Method Inspection: Check method existence, visibility, and list all methods
• Property Inspection: Check property existence, visibility, and list all properties
• Function Inspection: Get function arity and parameter names
• Alias Management: Create class and function aliases at runtime
• Trait Inspection: List traits used by a class
• Direct Reflection: Get raw reflection objects for classes, enums, functions, methods, properties, and parameters

#Methods

#alias()

public static function alias(object|string $class, string $alias): bool

Creates an alias for an existing class.

This method registers a new name for an existing class, allowing the class to be referenced by either its original name or the alias. The alias becomes available globally and can be used for instantiation, type hints, and instanceof checks.

Example:

1use Phuture\Coherence\Reflector;
2
3Reflector::alias(\DateTime::class, 'DT');
4
5$date = new DT();
6// The DateTime class is now also accessible as DT

Returns bool — Returns true if the alias was created successfully

Throws

• \Phuture\Coherence\Exception\InvalidArgumentException — When the alias already exists or the class does not exist

#aliasFunction()

public static function aliasFunction(string $function, string $alias): bool

Creates an alias for an existing function.

This method creates a new function that forwards all arguments to the original function. The alias behaves identically to the original function for all inputs.

Example:

1use Phuture\Coherence\Reflector;
2
3Reflector::aliasFunction('strlen', 'str_len');
4
5$length = str_len('hello');
6// Returns: 5 (same as strlen)

Returns bool — Returns true if the alias was created successfully

Throws

• \Phuture\Coherence\Exception\InvalidArgumentException — When the alias already exists or the function does not exist

See also

• \Phuture\Coherence\Reflector::alias()

#arity()

public static function arity(callable $method): int

Returns the number of parameters a callable accepts.

This method inspects a callable (closure, function, method, or invokable object) and returns the total number of declared parameters, including optional ones.

Example:

1use Phuture\Coherence\Reflector;
2
3$arity = Reflector::arity(fn ($a, $b, $c = null) => $a + $b);
4// Returns: 3
5
6$arity = Reflector::arity('strlen');
7// Returns: 1

Returns int — The number of declared parameters

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the callable cannot be reflected

See also

• \Phuture\Coherence\Reflector::parameters() — For getting the names of a callable's parameters

#basename()

public static function basename(object|string $class): string

Returns the short name of a class without its namespace.

This method extracts the class name without the namespace prefix, equivalent to calling (new ReflectionClass($class))->getShortName() but with built-in validation.

Example:

1use Phuture\Coherence\Reflector;
2
3$name = Reflector::basename(\DateTimeImmutable::class);
4// Returns: 'DateTimeImmutable'
5
6$name = Reflector::basename(new \DateTime());
7// Returns: 'DateTime'

Returns string — The short class name without namespace

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the class cannot be reflected
• \Phuture\Coherence\Exception\InvalidArgumentException — When the given class is anonymous

See also

• \Phuture\Coherence\Reflector::name() — For getting the fully qualified class name
• \Phuture\Coherence\Reflector::namespace() — For getting only the namespace portion

#hasMethod()

public static function hasMethod(object|string $class, string $method): bool

Checks if a class has a specific method.

This method determines whether the given class defines or inherits a method with the specified name, regardless of its visibility.

Example:

1use Phuture\Coherence\Reflector;
2
3$hasMethod = Reflector::hasMethod(\DateTime::class, 'format');
4// Returns: true
5
6$hasMethod = Reflector::hasMethod(\DateTime::class, 'nonExistent');
7// Returns: false

Returns bool — Returns true if the method exists on the class, false otherwise

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the class cannot be reflected
• \Phuture\Coherence\Exception\InvalidArgumentException — When the given class is anonymous

See also

• \Phuture\Coherence\Reflector::methods() — For listing all methods of a class
• \Phuture\Coherence\Reflector::methodVisibility() — For getting the visibility of a method

#hasProperty()

public static function hasProperty(object|string $class, string $property): bool

Checks if a class has a specific property.

This method determines whether the given class defines or inherits a property with the specified name, regardless of its visibility.

Example:

 1use Phuture\Coherence\Reflector;
 2
 3class User {
 4    public string $name = '';
 5}
 6
 7$hasProp = Reflector::hasProperty(User::class, 'name');
 8// Returns: true
 9
10$hasProp = Reflector::hasProperty(User::class, 'email');
11// Returns: false

Returns bool — Returns true if the property exists on the class, false otherwise

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the class cannot be reflected
• \Phuture\Coherence\Exception\InvalidArgumentException — When the given class is anonymous

See also

• \Phuture\Coherence\Reflector::properties() — For listing all properties of a class
• \Phuture\Coherence\Reflector::propertyVisibility() — For getting the visibility of a property

#isClass()

public static function isClass(string $class): bool

Checks if a string refers to an existing class.

This method verifies that the given string is a valid, existing class name. It returns false for interfaces, traits, and non-existent classes.

Example:

1use Phuture\Coherence\Reflector;
2
3Reflector::isClass(\DateTime::class);
4// Returns: true
5
6Reflector::isClass('NonExistentClass');
7// Returns: false

Returns bool — Returns true if the string refers to an existing class, false otherwise

#isMethodPrivate()

public static function isMethodPrivate(object|string $class, string $method): bool

Checks if a method is private.

This method inspects the given method on a class and returns true if it is declared as private.

Example:

1use Phuture\Coherence\Reflector;
2
3class Service {
4    private function internalProcess(): void {}
5}
6
7Reflector::isMethodPrivate(Service::class, 'internalProcess');
8// Returns: true

Returns bool — Returns true if the method is private, false otherwise

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the class or method cannot be reflected
• \Phuture\Coherence\Exception\InvalidArgumentException — When the given class is anonymous

See also

• \Phuture\Coherence\Reflector::methodVisibility() — For getting the raw visibility string
• \Phuture\Coherence\Reflector::isMethodPublic() — For checking if a method is public
• \Phuture\Coherence\Reflector::isMethodProtected() — For checking if a method is protected

#isMethodProtected()

public static function isMethodProtected(object|string $class, string $method): bool

Checks if a method is protected.

This method inspects the given method on a class and returns true if it is declared as protected.

Example:

1use Phuture\Coherence\Reflector;
2
3class Repository {
4    protected function findRaw(): array { return []; }
5}
6
7Reflector::isMethodProtected(Repository::class, 'findRaw');
8// Returns: true

Returns bool — Returns true if the method is protected, false otherwise

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the class or method cannot be reflected
• \Phuture\Coherence\Exception\InvalidArgumentException — When the given class is anonymous

See also

• \Phuture\Coherence\Reflector::methodVisibility() — For getting the raw visibility string
• \Phuture\Coherence\Reflector::isMethodPublic() — For checking if a method is public
• \Phuture\Coherence\Reflector::isMethodPrivate() — For checking if a method is private

#isMethodPublic()

public static function isMethodPublic(object|string $class, string $method): bool

Checks if a method is public.

This method inspects the given method on a class and returns true if it is declared as public.

Example:

1use Phuture\Coherence\Reflector;
2
3Reflector::isMethodPublic(\DateTime::class, 'format');
4// Returns: true

Returns bool — Returns true if the method is public, false otherwise

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the class or method cannot be reflected
• \Phuture\Coherence\Exception\InvalidArgumentException — When the given class is anonymous

See also

• \Phuture\Coherence\Reflector::methodVisibility() — For getting the raw visibility string
• \Phuture\Coherence\Reflector::isMethodPrivate() — For checking if a method is private
• \Phuture\Coherence\Reflector::isMethodProtected() — For checking if a method is protected

#isPropertyPrivate()

public static function isPropertyPrivate(object|string $class, string $property): bool

Checks if a property is private.

This method inspects the given property on a class and returns true if it is declared as private.

Example:

1use Phuture\Coherence\Reflector;
2
3class User {
4    private string $password = '';
5}
6
7Reflector::isPropertyPrivate(User::class, 'password');
8// Returns: true

Returns bool — Returns true if the property is private, false otherwise

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the class or property cannot be reflected
• \Phuture\Coherence\Exception\InvalidArgumentException — When the given class is anonymous

See also

• \Phuture\Coherence\Reflector::propertyVisibility() — For getting the raw visibility string
• \Phuture\Coherence\Reflector::isPropertyPublic() — For checking if a property is public
• \Phuture\Coherence\Reflector::isPropertyProtected() — For checking if a property is protected

#isPropertyProtected()

public static function isPropertyProtected(object|string $class, string $property): bool

Checks if a property is protected.

This method inspects the given property on a class and returns true if it is declared as protected.

Example:

1use Phuture\Coherence\Reflector;
2
3class Model {
4    protected array $attributes = [];
5}
6
7Reflector::isPropertyProtected(Model::class, 'attributes');
8// Returns: true

Returns bool — Returns true if the property is protected, false otherwise

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the class or property cannot be reflected
• \Phuture\Coherence\Exception\InvalidArgumentException — When the given class is anonymous

See also

• \Phuture\Coherence\Reflector::propertyVisibility() — For getting the raw visibility string
• \Phuture\Coherence\Reflector::isPropertyPublic() — For checking if a property is public
• \Phuture\Coherence\Reflector::isPropertyPrivate() — For checking if a property is private

#isPropertyPublic()

public static function isPropertyPublic(object|string $class, string $property): bool

Checks if a property is public.

This method inspects the given property on a class and returns true if it is declared as public.

Example:

1use Phuture\Coherence\Reflector;
2
3class User {
4    public string $name = '';
5}
6
7Reflector::isPropertyPublic(User::class, 'name');
8// Returns: true

Returns bool — Returns true if the property is public, false otherwise

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the class or property cannot be reflected
• \Phuture\Coherence\Exception\InvalidArgumentException — When the given class is anonymous

See also

• \Phuture\Coherence\Reflector::propertyVisibility() — For getting the raw visibility string
• \Phuture\Coherence\Reflector::isPropertyPrivate() — For checking if a property is private
• \Phuture\Coherence\Reflector::isPropertyProtected() — For checking if a property is protected

#methods()

public static function methods(object|string $class): array

Returns all method names defined on a class.

This method returns an array of all public method names available on the given class, including inherited methods.

Example:

1use Phuture\Coherence\Reflector;
2
3$methods = Reflector::methods(\DateTime::class);
4// Returns: ['__construct', '__wakeup', '__set_state', ... , 'format', 'modify', ...]

Returns array — An array of method names available on the class

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the class cannot be reflected
• \Phuture\Coherence\Exception\InvalidArgumentException — When the given class is anonymous

See also

• \Phuture\Coherence\Reflector::hasMethod() — For checking if a specific method exists
• \Phuture\Coherence\Reflector::methodVisibility() — For getting the visibility of a method

#methodVisibility()

public static function methodVisibility(object|string $class, string $method): string

Returns the visibility level of a method as a string.

This method inspects the given method on a class and returns its visibility level as one of: 'public', 'protected', or 'private'.

Example:

 1use Phuture\Coherence\Reflector;
 2
 3class Service {
 4    public function handle(): void {}
 5    protected function validate(): void {}
 6    private function execute(): void {}
 7}
 8
 9Reflector::methodVisibility(Service::class, 'handle');
10// Returns: 'public'
11
12Reflector::methodVisibility(Service::class, 'validate');
13// Returns: 'protected'
14
15Reflector::methodVisibility(Service::class, 'execute');
16// Returns: 'private'

Returns string — The visibility as 'public', 'protected', or 'private'

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the class or method cannot be reflected
• \Phuture\Coherence\Exception\InvalidArgumentException — When the given class is anonymous

See also

• \Phuture\Coherence\Reflector::isMethodPublic() — For checking if a method is public
• \Phuture\Coherence\Reflector::isMethodProtected() — For checking if a method is protected
• \Phuture\Coherence\Reflector::isMethodPrivate() — For checking if a method is private

#name()

public static function name(object|string $class): string

Returns the fully qualified class name of an object.

This method returns the complete class name including its namespace, extracted from an object instance.

Example:

1use Phuture\Coherence\Reflector;
2
3$name = Reflector::name(new \DateTimeImmutable());
4// Returns: 'DateTimeImmutable'
5
6$name = Reflector::name(new \Phuture\Coherence\Reflector());
7// Throws InvalidArgumentException (Reflector extends StaticClass and cannot be instantiated)

Returns string — The fully qualified class name of the object

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the class cannot be reflected
• \Phuture\Coherence\Exception\InvalidArgumentException — When the given class is anonymous

See also

• \Phuture\Coherence\Reflector::basename() — For getting only the short class name
• \Phuture\Coherence\Reflector::namespace() — For getting only the namespace portion

#namespace()

public static function namespace(object|string $class): string

Returns the namespace of a class.

This method extracts only the namespace portion of a fully qualified class name, without the class name itself.

Example:

1use Phuture\Coherence\Reflector;
2
3$ns = Reflector::namespace(\Phuture\Coherence\Hash::class);
4// Returns: 'Phuture\Coherence'
5
6$ns = Reflector::namespace(\DateTime::class);
7// Returns: '' (empty string, since DateTime is in the global namespace)

Returns string — The namespace of the class, or an empty string for global namespace classes

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the class cannot be reflected
• \Phuture\Coherence\Exception\InvalidArgumentException — When the given class is anonymous

See also

• \Phuture\Coherence\Reflector::basename() — For getting only the short class name
• \Phuture\Coherence\Reflector::name() — For getting the fully qualified class name

#parameters()

public static function parameters(callable $method): array

Returns the parameter names of a callable.

This method inspects a callable and returns an array containing the names of all declared parameters, in their declaration order.

Example:

1use Phuture\Coherence\Reflector;
2
3$params = Reflector::parameters(fn ($name, $age, $active = true) => null);
4// Returns: ['name', 'age', 'active']
5
6$params = Reflector::parameters('strlen');
7// Returns: ['string']

Returns array — An array of parameter names in declaration order

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the callable cannot be reflected

See also

• \Phuture\Coherence\Reflector::arity() — For getting the number of parameters

#parent()

public static function parent(object|string $class): string

Returns the fully qualified class name of the parent class.

This method inspects the given class and returns the name of its direct parent class.

Example:

1use Phuture\Coherence\Reflector;
2
3$parent = Reflector::parent(\DateTimeImmutable::class);
4// Returns: 'DateTime'
5
6$parent = Reflector::parent(\stdClass::class);
7// Throws InvalidArgumentException (stdClass has no parent)

Returns string — The fully qualified class name of the parent class

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the class cannot be reflected
• \Phuture\Coherence\Exception\InvalidArgumentException — When the given class is anonymous or has no parent

See also

• \Phuture\Coherence\Reflector::name() — For getting the class name itself

#properties()

public static function properties(object|string $class): array

Returns all public property names with their default values for a class.

This method returns an associative array where keys are property names and values are their default values. Only public properties are included.

Example:

 1use Phuture\Coherence\Reflector;
 2
 3class User {
 4    public string $name = 'John';
 5    public int $age = 30;
 6    private string $secret = '';
 7}
 8
 9$props = Reflector::properties(User::class);
10// Returns: ['name' => 'John', 'age' => 30]

Returns array — An associative array of property names and their default values

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the class cannot be reflected
• \Phuture\Coherence\Exception\InvalidArgumentException — When the given class is anonymous

See also

• \Phuture\Coherence\Reflector::hasProperty() — For checking if a specific property exists
• \Phuture\Coherence\Reflector::propertyVisibility() — For getting the visibility of a property

#propertyVisibility()

public static function propertyVisibility(object|string $class, string $property): string

Returns the visibility level of a property as a string.

This method inspects the given property on a class and returns its visibility level as one of: 'public', 'protected', or 'private'.

Example:

 1use Phuture\Coherence\Reflector;
 2
 3class Config {
 4    public string $name = '';
 5    protected array $settings = [];
 6    private string $apiKey = '';
 7}
 8
 9Reflector::propertyVisibility(Config::class, 'name');
10// Returns: 'public'
11
12Reflector::propertyVisibility(Config::class, 'settings');
13// Returns: 'protected'
14
15Reflector::propertyVisibility(Config::class, 'apiKey');
16// Returns: 'private'

Returns string — The visibility as 'public', 'protected', or 'private'

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the class or property cannot be reflected
• \Phuture\Coherence\Exception\InvalidArgumentException — When the given class is anonymous

See also

• \Phuture\Coherence\Reflector::isPropertyPublic() — For checking if a property is public
• \Phuture\Coherence\Reflector::isPropertyProtected() — For checking if a property is protected
• \Phuture\Coherence\Reflector::isPropertyPrivate() — For checking if a property is private

#reflectClass()

public static function reflectClass(object|string $class): ReflectionClass

Creates a ReflectionClass instance for the given class.

This method returns a native PHP ReflectionClass object, providing full access to the reflection API for detailed class inspection.

Example:

1use Phuture\Coherence\Reflector;
2
3$reflection = Reflector::reflectClass(\DateTime::class);
4$methods = $reflection->getMethods();
5$properties = $reflection->getProperties();

Returns ReflectionClass — A reflection object for the given class

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the class cannot be reflected

See also

• \Phuture\Coherence\Reflector::reflectMethod() — For reflecting a specific method
• \Phuture\Coherence\Reflector::reflectProperty() — For reflecting a specific property

#reflectEnum()

public static function reflectEnum(object|string $enum): ReflectionEnum

Creates a ReflectionEnum instance for the given enum.

This method returns a native PHP ReflectionEnum object for inspecting enum types, including their cases and backing values.

Example:

1use Phuture\Coherence\Reflector;
2
3enum Color: string {
4    case Red = 'red';
5    case Blue = 'blue';
6}
7
8$reflection = Reflector::reflectEnum(Color::class);
9$cases = $reflection->getCases();

Returns ReflectionEnum — A reflection object for the given enum

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the enum cannot be reflected

See also

• \Phuture\Coherence\Reflector::reflectClass() — For reflecting a regular class

#reflectFunction()

public static function reflectFunction(callable $function): ReflectionFunction

Creates a ReflectionFunction instance for the given callable.

This method returns a native PHP ReflectionFunction object for inspecting function definitions, including parameters, return types, and body.

Example:

1use Phuture\Coherence\Reflector;
2
3$reflection = Reflector::reflectFunction('strlen');
4$params = $reflection->getParameters();
5$returnType = $reflection->getReturnType();

Returns ReflectionFunction — A reflection object for the given function

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the function cannot be reflected

See also

• \Phuture\Coherence\Reflector::reflectMethod() — For reflecting a class method
• \Phuture\Coherence\Reflector::arity() — For getting the parameter count

#reflectMethod()

public static function reflectMethod(object|string $class, string $method): ReflectionMethod

Creates a ReflectionMethod instance for a specific method on a class.

This method returns a native PHP ReflectionMethod object for inspecting method definitions, including visibility, parameters, return types, and body.

Example:

1use Phuture\Coherence\Reflector;
2
3$reflection = Reflector::reflectMethod(\DateTime::class, 'format');
4$isPublic = $reflection->isPublic();
5$params = $reflection->getParameters();

Returns ReflectionMethod — A reflection object for the given method

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the method cannot be reflected

See also

• \Phuture\Coherence\Reflector::reflectClass() — For reflecting the entire class
• \Phuture\Coherence\Reflector::methodVisibility() — For getting method visibility

#reflectParameter()

public static function reflectParameter(object|string $class, string $method, string $parameter): ReflectionParameter

Creates a ReflectionParameter instance for a specific method parameter.

This method returns a native PHP ReflectionParameter object for inspecting parameter definitions, including type, default value, and whether it is optional.

Example:

1use Phuture\Coherence\Reflector;
2
3$reflection = Reflector::reflectParameter(\DateTime::class, 'format', 'format');
4$type = $reflection->getType();
5$hasDefault = $reflection->isDefaultValueAvailable();

Returns ReflectionParameter — A reflection object for the given parameter

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the parameter cannot be reflected

See also

• \Phuture\Coherence\Reflector::reflectMethod() — For reflecting the entire method
• \Phuture\Coherence\Reflector::parameters() — For getting all parameter names

#reflectProperty()

public static function reflectProperty(object|string $class, string $property): ReflectionProperty

Creates a ReflectionProperty instance for a specific property on a class.

This method returns a native PHP ReflectionProperty object for inspecting property definitions, including visibility, type, and default value.

Example:

1use Phuture\Coherence\Reflector;
2
3class User {
4    public string $name = '';
5}
6
7$reflection = Reflector::reflectProperty(User::class, 'name');
8$type = $reflection->getType();
9$isPublic = $reflection->isPublic();

Returns ReflectionProperty — A reflection object for the given property

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the property cannot be reflected

See also

• \Phuture\Coherence\Reflector::reflectClass() — For reflecting the entire class
• \Phuture\Coherence\Reflector::propertyVisibility() — For getting property visibility

#traits()

public static function traits(object|string $class): array

Returns all traits used by a class.

This method returns an associative array of traits used by the given class, where keys are the trait names and values are the trait names. Parent class traits are not included.

Example:

 1use Phuture\Coherence\Reflector;
 2
 3trait HasTimestamps {
 4    public function touch(): void {}
 5}
 6
 7class Model {
 8    use HasTimestamps;
 9}
10
11$traits = Reflector::traits(Model::class);
12// Returns: ['HasTimestamps' => 'HasTimestamps']

Returns array — An associative array of trait names used by the class

Throws

• \Phuture\Coherence\Exception\ReflectionException — When the class cannot be reflected
• \Phuture\Coherence\Exception\InvalidArgumentException — When the given class is anonymous