vendor/symfony/framework-bundle/CacheWarmer/TemplateFinder.php line 29

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Bundle\FrameworkBundle\CacheWarmer;
  14. @trigger_error('The '.TemplateFinder::class.' class is deprecated since version 4.3 and will be removed in 5.0; use Twig instead.', \E_USER_DEPRECATED);
  16. use Symfony\Component\Finder\Finder;
  17. use Symfony\Component\HttpKernel\Bundle\BundleInterface;
  18. use Symfony\Component\HttpKernel\KernelInterface;
  19. use Symfony\Component\Templating\TemplateNameParserInterface;
  20. use Symfony\Component\Templating\TemplateReferenceInterface;
  22. /**
  23.  * Finds all the templates.
  24.  *
  25.  * @author Victor Berchet <victor@suumit.com>
  26.  *
  27.  * @deprecated since version 4.3, to be removed in 5.0; use Twig instead.
  28.  */
  29. class TemplateFinder implements TemplateFinderInterface
  30. {
  31.     private $kernel;
  32.     private $parser;
  33.     private $rootDir;
  34.     private $templates;
  36.     /**
  37.      * @param string $rootDir The directory where global templates can be stored
  38.      */
  39.     public function __construct(KernelInterface $kernel, TemplateNameParserInterface $parser, string $rootDir)
  40.     {
  41.         $this->kernel = $kernel;
  42.         $this->parser = $parser;
  43.         $this->rootDir = $rootDir;
  44.     }
  46.     /**
  47.      * Find all the templates in the bundle and in the kernel Resources folder.
  48.      *
  49.      * @return TemplateReferenceInterface[]
  50.      */
  51.     public function findAllTemplates()
  52.     {
  53.         if (null !== $this->templates) {
  54.             return $this->templates;
  55.         }
  57.         $templates = [];
  59.         foreach ($this->kernel->getBundles() as $bundle) {
  60.             $templates = array_merge($templates, $this->findTemplatesInBundle($bundle));
  61.         }
  63.         $templates = array_merge($templates, $this->findTemplatesInFolder($this->rootDir.'/views'));
  65.         return $this->templates = $templates;
  66.     }
  68.     /**
  69.      * Find templates in the given directory.
  70.      *
  71.      * @return TemplateReferenceInterface[]
  72.      */
  73.     private function findTemplatesInFolder(string $dir): array
  74.     {
  75.         $templates = [];
  77.         if (is_dir($dir)) {
  78.             $finder = new Finder();
  79.             foreach ($finder->files()->followLinks()->in($dir) as $file) {
  80.                 $template = $this->parser->parse($file->getRelativePathname());
  81.                 if (false !== $template) {
  82.                     $templates[] = $template;
  83.                 }
  84.             }
  85.         }
  87.         return $templates;
  88.     }
  90.     /**
  91.      * Find templates in the given bundle.
  92.      *
  93.      * @param BundleInterface $bundle The bundle where to look for templates
  94.      *
  95.      * @return TemplateReferenceInterface[]
  96.      */
  97.     private function findTemplatesInBundle(BundleInterface $bundle): array
  98.     {
  99.         $name = $bundle->getName();
  100.         $templates = array_unique(array_merge(
  101.             $this->findTemplatesInFolder($bundle->getPath().'/Resources/views'),
  102.             $this->findTemplatesInFolder($this->rootDir.'/'.$name.'/views')
  103.         ));
  105.         foreach ($templates as $i => $template) {
  106.             $templates[$i] = $template->set('bundle', $name);
  107.         }
  109.         return $templates;
  110.     }
  111. }