Transformers.php 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  1. <?php
  2. declare(strict_types=1);
  3. /*
  4. * This file is part of PHP CS Fixer.
  5. *
  6. * (c) Fabien Potencier <fabien@symfony.com>
  7. * Dariusz Rumiński <dariusz.ruminski@gmail.com>
  8. *
  9. * This source file is subject to the MIT license that is bundled
  10. * with this source code in the file LICENSE.
  11. */
  12. namespace PhpCsFixer\Tokenizer;
  13. use Symfony\Component\Finder\Finder;
  14. use Symfony\Component\Finder\SplFileInfo;
  15. /**
  16. * Collection of Transformer classes.
  17. *
  18. * @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
  19. *
  20. * @internal
  21. */
  22. final class Transformers
  23. {
  24. /**
  25. * The registered transformers.
  26. *
  27. * @var list<TransformerInterface>
  28. */
  29. private array $items = [];
  30. /**
  31. * Register built in Transformers.
  32. */
  33. private function __construct()
  34. {
  35. $this->registerBuiltInTransformers();
  36. usort($this->items, static fn (TransformerInterface $a, TransformerInterface $b): int => $b->getPriority() <=> $a->getPriority());
  37. }
  38. public static function createSingleton(): self
  39. {
  40. static $instance = null;
  41. if (!$instance) {
  42. $instance = new self();
  43. }
  44. return $instance;
  45. }
  46. /**
  47. * Transform given Tokens collection through all Transformer classes.
  48. *
  49. * @param Tokens $tokens Tokens collection
  50. */
  51. public function transform(Tokens $tokens): void
  52. {
  53. foreach ($this->items as $transformer) {
  54. foreach ($tokens as $index => $token) {
  55. $transformer->process($tokens, $token, $index);
  56. }
  57. }
  58. }
  59. /**
  60. * @param TransformerInterface $transformer Transformer
  61. */
  62. private function registerTransformer(TransformerInterface $transformer): void
  63. {
  64. if (\PHP_VERSION_ID >= $transformer->getRequiredPhpVersionId()) {
  65. $this->items[] = $transformer;
  66. }
  67. }
  68. private function registerBuiltInTransformers(): void
  69. {
  70. static $registered = false;
  71. if ($registered) {
  72. return;
  73. }
  74. $registered = true;
  75. foreach ($this->findBuiltInTransformers() as $transformer) {
  76. $this->registerTransformer($transformer);
  77. }
  78. }
  79. /**
  80. * @return \Generator<TransformerInterface>
  81. */
  82. private function findBuiltInTransformers(): iterable
  83. {
  84. /** @var SplFileInfo $file */
  85. foreach (Finder::create()->files()->in(__DIR__.'/Transformer') as $file) {
  86. $relativeNamespace = $file->getRelativePath();
  87. $class = __NAMESPACE__.'\Transformer\\'.('' !== $relativeNamespace ? $relativeNamespace.'\\' : '').$file->getBasename('.php');
  88. yield new $class();
  89. }
  90. }
  91. }