vendor/friendsofphp/proxy-manager-lts/src/ProxyManager/Factory/AbstractBaseFactory.php line 107

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace ProxyManager\Factory;
  7. use OutOfBoundsException;
  8. use ProxyManager\Configuration;
  9. use ProxyManager\Generator\ClassGenerator;
  10. use ProxyManager\ProxyGenerator\ProxyGeneratorInterface;
  11. use ProxyManager\Signature\Exception\InvalidSignatureException;
  12. use ProxyManager\Signature\Exception\MissingSignatureException;
  13. use ProxyManager\Version;
  14. use ReflectionClass;
  16. use function array_key_exists;
  17. use function assert;
  18. use function class_exists;
  19. use function is_a;
  20. use function serialize;
  21. use function sha1;
  23. /**
  24. * Base factory common logic
  25. */
  26. abstract class AbstractBaseFactory
  27. {
  28. protected $configuration;
  30. /**
  31. * Cached checked class names
  32. *
  33. * @var array<string, string>
  34. * @psalm-var array<string, class-string>
  35. */
  36. private $checkedClasses = [];
  38. public function __construct(?Configuration $configuration = null)
  39. {
  40. $this->configuration = $configuration ?? new Configuration();
  41. }
  43. /**
  44. * Generate a proxy from a class name
  45. *
  46. * @param array<string, mixed> $proxyOptions
  47. * @psalm-param class-string<RealObjectType> $className
  48. *
  49. * @psalm-return class-string<RealObjectType>
  50. *
  51. * @throws InvalidSignatureException
  52. * @throws MissingSignatureException
  53. * @throws OutOfBoundsException
  54. *
  55. * @psalm-template RealObjectType of object
  56. */
  57. protected function generateProxy(string $className, array $proxyOptions = []): string
  58. {
  59. $cacheKey = $proxyOptions ? sha1(serialize([$className, $proxyOptions])) : $className;
  61. if (array_key_exists($cacheKey, $this->checkedClasses)) {
  62. $generatedClassName = $this->checkedClasses[$cacheKey];
  64. assert(is_a($generatedClassName, $className, true));
  66. return $generatedClassName;
  67. }
  69. $proxyParameters = [
  70. 'className' => $className,
  71. 'factory' => static::class,
  72. 'proxyManagerVersion' => Version::getVersion(),
  73. 'proxyOptions' => $proxyOptions,
  74. ];
  75. $proxyClassName = $this
  76. ->configuration
  77. ->getClassNameInflector()
  78. ->getProxyClassName($className, $proxyParameters);
  80. if (! class_exists($proxyClassName)) {
  81. $this->generateProxyClass(
  82. $proxyClassName,
  83. $className,
  84. $proxyParameters,
  85. $proxyOptions
  86. );
  87. }
  89. $this
  90. ->configuration
  91. ->getSignatureChecker()
  92. ->checkSignature(new ReflectionClass($proxyClassName), $proxyParameters);
  94. return $this->checkedClasses[$cacheKey] = $proxyClassName;
  95. }
  97. abstract protected function getGenerator(): ProxyGeneratorInterface;
  99. /**
  100. * Generates the provided `$proxyClassName` from the given `$className` and `$proxyParameters`
  101. *
  102. * @param array<string, mixed> $proxyParameters
  103. * @param array<string, mixed> $proxyOptions
  104. * @psalm-param class-string $proxyClassName
  105. * @psalm-param class-string $className
  106. */
  107. private function generateProxyClass(
  108. string $proxyClassName,
  109. string $className,
  110. array $proxyParameters,
  111. array $proxyOptions = []
  112. ): void {
  113. $className = $this->configuration->getClassNameInflector()->getUserClassName($className);
  114. $phpClass = new ClassGenerator($proxyClassName);
  116. /** @psalm-suppress TooManyArguments - generator interface was not updated due to BC compliance */
  117. $this->getGenerator()->generate(new ReflectionClass($className), $phpClass, $proxyOptions);
  119. $phpClass = $this->configuration->getClassSignatureGenerator()->addSignature($phpClass, $proxyParameters);
  121. /** @psalm-suppress TooManyArguments - generator interface was not updated due to BC compliance */
  122. $this->configuration->getGeneratorStrategy()->generate($phpClass, $proxyOptions);
  124. $autoloader = $this->configuration->getProxyAutoloader();
  126. $autoloader($proxyClassName);
  127. }
  128. }