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

  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(private readonly KernelInterface $kernel, private readonly Connection $connection, private readonly AppSnippetFileLoader $appSnippetFileLoader, private readonly ActiveAppsLoader $activeAppsLoader)
  25.     {
  26.     }
  28.     public function loadSnippetFilesIntoCollection(SnippetFileCollection $snippetFileCollection): void
  29.     {
  30.         $this->loadPluginSnippets($snippetFileCollection);
  32.         $this->loadAppSnippets($snippetFileCollection);
  33.     }
  35.     private function loadPluginSnippets(SnippetFileCollection $snippetFileCollection): void
  36.     {
  37.         foreach ($this->kernel->getBundles() as $bundle) {
  38.             if (!$bundle instanceof Bundle) {
  39.                 continue;
  40.             }
  42.             $snippetDir = $bundle->getPath() . '/Resources/snippet';
  44.             if (!is_dir($snippetDir)) {
  45.                 continue;
  46.             }
  48.             foreach ($this->loadSnippetFilesInDir($snippetDir, $bundle) as $snippetFile) {
  49.                 if ($snippetFileCollection->hasFileForPath($snippetFile->getPath())) {
  50.                     continue;
  51.                 }
  53.                 $snippetFileCollection->add($snippetFile);
  54.             }
  55.         }
  56.     }
  58.     private function loadAppSnippets(SnippetFileCollection $snippetFileCollection): void
  59.     {
  60.         foreach ($this->activeAppsLoader->getActiveApps() as $app) {
  61.             $snippetFiles = $this->appSnippetFileLoader->loadSnippetFilesFromApp($app['author'] ?? '', $app['path']);
  62.             foreach ($snippetFiles as $snippetFile) {
  63.                 $snippetFile->setTechnicalName($app['name']);
  64.                 $snippetFileCollection->add($snippetFile);
  65.             }
  66.         }
  67.     }
  69.     /**
  70.      * @return AbstractSnippetFile[]
  71.      */
  72.     private function loadSnippetFilesInDir(string $snippetDir, Bundle $bundle): array
  73.     {
  74.         $finder = new Finder();
  75.         $finder->in($snippetDir)
  76.             ->files()
  77.             ->name('*.json');
  79.         $snippetFiles = [];
  81.         foreach ($finder->getIterator() as $fileInfo) {
  82.             $nameParts = explode('.', $fileInfo->getFilenameWithoutExtension());
  84.             $snippetFile = null;
  85.             switch (\count($nameParts)) {
  86.                 case 2:
  87.                     $snippetFile = new GenericSnippetFile(
  88.                         implode('.', $nameParts),
  89.                         $fileInfo->getPathname(),
  90.                         $nameParts[1],
  91.                         $this->getAuthorFromBundle($bundle),
  92.                         false,
  93.                         $bundle->getName()
  94.                     );
  96.                     break;
  97.                 case 3:
  98.                     $snippetFile = new GenericSnippetFile(
  99.                         implode('.', [$nameParts[0], $nameParts[1]]),
  100.                         $fileInfo->getPathname(),
  101.                         $nameParts[1],
  102.                         $this->getAuthorFromBundle($bundle),
  103.                         $nameParts[2] === 'base',
  104.                         $bundle->getName()
  105.                     );
  107.                     break;
  108.             }
  110.             if ($snippetFile) {
  111.                 $snippetFiles[] = $snippetFile;
  112.             }
  113.         }
  115.         return $snippetFiles;
  116.     }
  118.     private function getAuthorFromBundle(Bundle $bundle): string
  119.     {
  120.         if (!$bundle instanceof Plugin) {
  121.             return 'Shopware';
  122.         }
  124.         return $this->getPluginAuthors()[$bundle::class] ?? '';
  125.     }
  127.     /**
  128.      * @return array<string, string>
  129.      */
  130.     private function getPluginAuthors(): array
  131.     {
  132.         if (!$this->pluginAuthors) {
  133.             /** @var array<string, string> $authors */
  134.             $authors = $this->connection->fetchAllKeyValue('
  135.                 SELECT `base_class` AS `baseClass`, `author`
  136.                 FROM `plugin`
  137.             ');
  139.             $this->pluginAuthors = $authors;
  140.         }
  142.         return $this->pluginAuthors;
  143.     }
  144. }