A collection of low-level tools to extend PHP reflection capabilities.
This library is installable via Composer:
composer require brick/reflection
This library requires PHP 7.1 or later. For PHP 5.6 and PHP 7.0 compatibility, use version 0.1
.
Here is a brief overview of the classes in this package.
This class is a collection of tools that build on top of PHP's reflection classes to provide additional functionality.
Just create an instance of ReflectionTools
and you can use the following methods:
getClassMethods()
returns reflections of all the non-static methods that make up one object, including private methods of parent classes.getClassProperties()
returns reflections of all the non-static properties that make up one object, including private properties of parent classes.getClassHierarchy()
returns the hierarchy of classes, starting from the first ancestor and ending with the class itself.getReflectionFunction()
returns a reflection object for any callable.getFunctionParameterTypes()
returns an associative array of the@param
types documented on function parameters.getParameterTypes()
returns the@param
types documented on a function parameter.getPropertyTypes()
returns the@var
types documented on a property.getPropertyClass()
returns the fully qualified class name type documented for the given property, if any.getFunctionName()
returns a meaningful name for the given function, including the class name if it is a method.exportFunction()
exports a function's signature.exportFunctionParameters()
exports a function's parameters.Used by exportFunction()
.
ImportResolver resolves class names to their fully qualified name, taking into account the current namespace and use
statements of the PHP file they were used in.
This is particularly useful for parsing annotations such as @param ClassName $foo
, where the FQCN of ClassName depends on the file it appears in, for example:
<?php
namespace App;
use Foo\Bar;
use Foo\Bar\Baz as Alias;
class Test {
}
You can create a resolver by passing any reflection object belonging to the PHP file as a context: a ReflectionClass
, a ReflectionProperty
, a ReflectionMethod
or a ReflectionParameter
:
use Brick\Reflection\ImportResolver;
$class = new ReflectionClass(App\Test::class);
$resolver = new ImportResolver($class);
echo $resolver->resolve('\Some\FQCN\Class'); // Some\FQCN\Class
echo $resolver->resolve('Something'); // App\Something
echo $resolver->resolve('Something\Else'); // App\Something\Else
echo $resolver->resolve('Bar'); // Foo\Bar
echo $resolver->resolve('Bar\tender'); // Foo\Bar\tender
echo $resolver->resolve('Alias'); // Foo\Bar\Baz
echo $resolver->resolve('Alias\ooka'); // Foo\Bar\Baz\ooka