vendor/symfony/webpack-encore-bundle/src/Asset/EntrypointLookup.php line 36

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Symfony WebpackEncoreBundle package.
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. * For the full copyright and license information, please view the LICENSE
  7. * file that was distributed with this source code.
  8. */
  10. namespace Symfony\WebpackEncoreBundle\Asset;
  12. use Psr\Cache\CacheItemPoolInterface;
  13. use Symfony\WebpackEncoreBundle\Exception\EntrypointNotFoundException;
  15. /**
  16. * Returns the CSS or JavaScript files needed for a Webpack entry.
  17. *
  18. * This reads a JSON file with the format of Webpack Encore's entrypoints.json file.
  19. *
  20. * @final
  21. */
  22. class EntrypointLookup implements EntrypointLookupInterface, IntegrityDataProviderInterface
  23. {
  24. private $entrypointJsonPath;
  26. private $entriesData;
  28. private $returnedFiles = [];
  30. private $cache;
  32. private $cacheKey;
  34. private $strictMode;
  36. public function __construct(string $entrypointJsonPath, CacheItemPoolInterface $cache = null, string $cacheKey = null, bool $strictMode = true)
  37. {
  38. $this->entrypointJsonPath = $entrypointJsonPath;
  39. $this->cache = $cache;
  40. $this->cacheKey = $cacheKey;
  41. $this->strictMode = $strictMode;
  42. }
  44. public function getJavaScriptFiles(string $entryName): array
  45. {
  46. return $this->getEntryFiles($entryName, 'js');
  47. }
  49. public function getCssFiles(string $entryName): array
  50. {
  51. return $this->getEntryFiles($entryName, 'css');
  52. }
  54. public function getIntegrityData(): array
  55. {
  56. $entriesData = $this->getEntriesData();
  58. if (!\array_key_exists('integrity', $entriesData)) {
  59. return [];
  60. }
  62. return $entriesData['integrity'];
  63. }
  65. /**
  66. * Resets the state of this service.
  67. */
  68. public function reset()
  69. {
  70. $this->returnedFiles = [];
  71. }
  73. private function getEntryFiles(string $entryName, string $key): array
  74. {
  75. $this->validateEntryName($entryName);
  76. $entriesData = $this->getEntriesData();
  77. $entryData = $entriesData['entrypoints'][$entryName] ?? [];
  79. if (!isset($entryData[$key])) {
  80. // If we don't find the file type then just send back nothing.
  81. return [];
  82. }
  84. // make sure to not return the same file multiple times
  85. $entryFiles = $entryData[$key];
  86. $newFiles = array_values(array_diff($entryFiles, $this->returnedFiles));
  87. $this->returnedFiles = array_merge($this->returnedFiles, $newFiles);
  89. return $newFiles;
  90. }
  92. private function validateEntryName(string $entryName)
  93. {
  94. $entriesData = $this->getEntriesData();
  95. if (!isset($entriesData['entrypoints'][$entryName]) && $this->strictMode) {
  96. $withoutExtension = substr($entryName, 0, strrpos($entryName, '.'));
  98. if (isset($entriesData['entrypoints'][$withoutExtension])) {
  99. throw new EntrypointNotFoundException(sprintf('Could not find the entry "%s". Try "%s" instead (without the extension).', $entryName, $withoutExtension));
  100. }
  102. throw new EntrypointNotFoundException(sprintf('Could not find the entry "%s" in "%s". Found: %s.', $entryName, $this->entrypointJsonPath, implode(', ', array_keys($entriesData))));
  103. }
  104. }
  106. private function getEntriesData(): array
  107. {
  108. if (null !== $this->entriesData) {
  109. return $this->entriesData;
  110. }
  112. if ($this->cache) {
  113. $cached = $this->cache->getItem($this->cacheKey);
  115. if ($cached->isHit()) {
  116. return $this->entriesData = $cached->get();
  117. }
  118. }
  120. if (!file_exists($this->entrypointJsonPath)) {
  121. if (!$this->strictMode) {
  122. return [];
  123. }
  124. throw new \InvalidArgumentException(sprintf('Could not find the entrypoints file from Webpack: the file "%s" does not exist.', $this->entrypointJsonPath));
  125. }
  127. $this->entriesData = json_decode(file_get_contents($this->entrypointJsonPath), true);
  129. if (null === $this->entriesData) {
  130. throw new \InvalidArgumentException(sprintf('There was a problem JSON decoding the "%s" file', $this->entrypointJsonPath));
  131. }
  133. if (!isset($this->entriesData['entrypoints'])) {
  134. throw new \InvalidArgumentException(sprintf('Could not find an "entrypoints" key in the "%s" file', $this->entrypointJsonPath));
  135. }
  137. if ($this->cache) {
  138. $this->cache->save($cached->set($this->entriesData));
  139. }
  141. return $this->entriesData;
  142. }
  143. }