*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util;
use function array_keys;
use function array_merge;
use function array_reverse;
use PHPUnit\Framework\Assert;
use PHPUnit\Framework\TestCase;
use ReflectionClass;
use ReflectionException;
use ReflectionMethod;
/**
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
*
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Reflection
{
/**
* @psalm-param class-string $className
* @psalm-param non-empty-string $methodName
*
* @psalm-return array{file: non-empty-string, line: non-negative-int}
*/
public static function sourceLocationFor(string $className, string $methodName): array
{
try {
$reflector = new ReflectionMethod($className, $methodName);
$file = $reflector->getFileName();
$line = $reflector->getStartLine();
} catch (ReflectionException) {
$file = 'unknown';
$line = 0;
}
return [
'file' => $file,
'line' => $line,
];
}
/**
* @psalm-return list
*/
public static function publicMethodsInTestClass(ReflectionClass $class): array
{
return self::filterAndSortMethods($class, ReflectionMethod::IS_PUBLIC, true);
}
/**
* @psalm-return list
*/
public static function methodsInTestClass(ReflectionClass $class): array
{
return self::filterAndSortMethods($class, null, false);
}
/**
* @psalm-return list
*/
private static function filterAndSortMethods(ReflectionClass $class, ?int $filter, bool $sortHighestToLowest): array
{
$methodsByClass = [];
foreach ($class->getMethods($filter) as $method) {
$declaringClassName = $method->getDeclaringClass()->getName();
if ($declaringClassName === TestCase::class) {
continue;
}
if ($declaringClassName === Assert::class) {
continue;
}
if (!isset($methodsByClass[$declaringClassName])) {
$methodsByClass[$declaringClassName] = [];
}
$methodsByClass[$declaringClassName][] = $method;
}
$classNames = array_keys($methodsByClass);
if ($sortHighestToLowest) {
$classNames = array_reverse($classNames);
}
$methods = [];
foreach ($classNames as $className) {
$methods = array_merge($methods, $methodsByClass[$className]);
}
return $methods;
}
}