vendor/shopware/core/System/Snippet/Files/SnippetFileLoader.php line 34

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\System\Snippet\Files;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Framework\App\ActiveAppsLoader;
  7. use Shopware\Core\Framework\Bundle;
  8. use Shopware\Core\Framework\Log\Package;
  9. use Shopware\Core\Framework\Plugin;
  10. use Symfony\Component\Finder\Finder;
  11. use Symfony\Component\HttpKernel\KernelInterface;
  13. #[Package('system-settings')]
  14. class SnippetFileLoader implements SnippetFileLoaderInterface
  15. {
  16.     /**
  17.      * @var array<string, string>
  18.      */
  19.     private array $pluginAuthors = [];
  21.     /**
  22.      * @internal
  23.      */
  24.     public function __construct(
  25.         private readonly KernelInterface $kernel,
  26.         private readonly Connection $connection,
  27.         private readonly AppSnippetFileLoader $appSnippetFileLoader,
  28.         private readonly ActiveAppsLoader $activeAppsLoader
  29.     ) {
  30.     }
  32.     public function loadSnippetFilesIntoCollection(SnippetFileCollection $snippetFileCollection): void
  33.     {
  34.         $this->loadPluginSnippets($snippetFileCollection);
  36.         $this->loadAppSnippets($snippetFileCollection);
  37.     }
  39.     private function loadPluginSnippets(SnippetFileCollection $snippetFileCollection): void
  40.     {
  41.         foreach ($this->kernel->getBundles() as $bundle) {
  42.             if (!$bundle instanceof Bundle) {
  43.                 continue;
  44.             }
  46.             $snippetDir = $bundle->getPath() . '/Resources/snippet';
  48.             if (!is_dir($snippetDir)) {
  49.                 continue;
  50.             }
  52.             foreach ($this->loadSnippetFilesInDir($snippetDir, $bundle) as $snippetFile) {
  53.                 if ($snippetFileCollection->hasFileForPath($snippetFile->getPath())) {
  54.                     continue;
  55.                 }
  57.                 $snippetFileCollection->add($snippetFile);
  58.             }
  59.         }
  60.     }
  62.     private function loadAppSnippets(SnippetFileCollection $snippetFileCollection): void
  63.     {
  64.         foreach ($this->activeAppsLoader->getActiveApps() as $app) {
  65.             $snippetFiles = $this->appSnippetFileLoader->loadSnippetFilesFromApp($app['author'] ?? '', $app['path']);
  66.             foreach ($snippetFiles as $snippetFile) {
  67.                 $snippetFile->setTechnicalName($app['name']);
  68.                 $snippetFileCollection->add($snippetFile);
  69.             }
  70.         }
  71.     }
  73.     /**
  74.      * @return AbstractSnippetFile[]
  75.      */
  76.     private function loadSnippetFilesInDir(string $snippetDir, Bundle $bundle): array
  77.     {
  78.         $finder = new Finder();
  79.         $finder->in($snippetDir)
  80.             ->files()
  81.             ->name('*.json');
  83.         $snippetFiles = [];
  85.         foreach ($finder->getIterator() as $fileInfo) {
  86.             $nameParts = explode('.', $fileInfo->getFilenameWithoutExtension());
  88.             $snippetFile = null;
  89.             switch (\count($nameParts)) {
  90.                 case 2:
  91.                     $snippetFile = new GenericSnippetFile(
  92.                         implode('.', $nameParts),
  93.                         $fileInfo->getPathname(),
  94.                         $nameParts[1],
  95.                         $this->getAuthorFromBundle($bundle),
  96.                         false,
  97.                         $bundle->getName()
  98.                     );
  100.                     break;
  101.                 case 3:
  102.                     $snippetFile = new GenericSnippetFile(
  103.                         implode('.', [$nameParts[0], $nameParts[1]]),
  104.                         $fileInfo->getPathname(),
  105.                         $nameParts[1],
  106.                         $this->getAuthorFromBundle($bundle),
  107.                         $nameParts[2] === 'base',
  108.                         $bundle->getName()
  109.                     );
  111.                     break;
  112.             }
  114.             if ($snippetFile) {
  115.                 $snippetFiles[] = $snippetFile;
  116.             }
  117.         }
  119.         return $snippetFiles;
  120.     }
  122.     private function getAuthorFromBundle(Bundle $bundle): string
  123.     {
  124.         if (!$bundle instanceof Plugin) {
  125.             return 'Shopware';
  126.         }
  128.         return $this->getPluginAuthors()[$bundle::class] ?? '';
  129.     }
  131.     /**
  132.      * @return array<string, string>
  133.      */
  134.     private function getPluginAuthors(): array
  135.     {
  136.         if (!$this->pluginAuthors) {
  137.             /** @var array<string, string> $authors */
  138.             $authors = $this->connection->fetchAllKeyValue('
  139.                 SELECT `base_class` AS `baseClass`, `author`
  140.                 FROM `plugin`
  141.             ');
  143.             $this->pluginAuthors = $authors;
  144.         }
  146.         return $this->pluginAuthors;
  147.     }
  148. }