Viewing file:  Registry.php (2.6 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php declare(strict_types=1);
/*
* This file is part of PHPUnit.
*
* (c) Sebastian Bergmann <sebastian@phpunit.de>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Util\Annotation;
use function array_key_exists;
use PHPUnit\Util\Exception;
use ReflectionClass;
use ReflectionException;
use ReflectionMethod;
/**
* Reflection information, and therefore DocBlock information, is static within
* a single PHP process. It is therefore okay to use a Singleton registry here.
*
* @internal This class is not covered by the backward compatibility promise for PHPUnit
*/
final class Registry
{
/** @var null|self */
private static $instance;
/** @var array<string, DocBlock> indexed by class name */
private $classDocBlocks = [];
/** @var array<string, array<string, DocBlock>> indexed by class name and method name */
private $methodDocBlocks = [];
public static function getInstance(): self
{
return self::$instance ?? self::$instance = new self;
}
private function __construct()
{
}
/**
* @throws Exception
*
* @psalm-param class-string $class
*/
public function forClassName(string $class): DocBlock
{
if (array_key_exists($class, $this->classDocBlocks)) {
return $this->classDocBlocks[$class];
}
try {
$reflection = new ReflectionClass($class);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e,
);
}
// @codeCoverageIgnoreEnd
return $this->classDocBlocks[$class] = DocBlock::ofClass($reflection);
}
/**
* @throws Exception
*
* @psalm-param class-string $classInHierarchy
*/
public function forMethod(string $classInHierarchy, string $method): DocBlock
{
if (isset($this->methodDocBlocks[$classInHierarchy][$method])) {
return $this->methodDocBlocks[$classInHierarchy][$method];
}
try {
$reflection = new ReflectionMethod($classInHierarchy, $method);
// @codeCoverageIgnoreStart
} catch (ReflectionException $e) {
throw new Exception(
$e->getMessage(),
$e->getCode(),
$e,
);
}
// @codeCoverageIgnoreEnd
return $this->methodDocBlocks[$classInHierarchy][$method] = DocBlock::ofMethod($reflection, $classInHierarchy);
}
}
|