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

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 KernelInterface             $kernel  A KernelInterface instance
  38.      * @param TemplateNameParserInterface $parser  A TemplateNameParserInterface instance
  39.      * @param string                      $rootDir The directory where global templates can be stored
  40.      */
  41.     public function __construct(KernelInterface $kernel, TemplateNameParserInterface $parser, string $rootDir)
  42.     {
  43.         $this->kernel = $kernel;
  44.         $this->parser = $parser;
  45.         $this->rootDir = $rootDir;
  46.     }
  48.     /**
  49.      * Find all the templates in the bundle and in the kernel Resources folder.
  50.      *
  51.      * @return TemplateReferenceInterface[]
  52.      */
  53.     public function findAllTemplates()
  54.     {
  55.         if (null !== $this->templates) {
  56.             return $this->templates;
  57.         }
  59.         $templates = [];
  61.         foreach ($this->kernel->getBundles() as $bundle) {
  62.             $templates = array_merge($templates, $this->findTemplatesInBundle($bundle));
  63.         }
  65.         $templates = array_merge($templates, $this->findTemplatesInFolder($this->rootDir.'/views'));
  67.         return $this->templates = $templates;
  68.     }
  70.     /**
  71.      * Find templates in the given directory.
  72.      *
  73.      * @param string $dir The folder where to look for templates
  74.      *
  75.      * @return TemplateReferenceInterface[]
  76.      */
  77.     private function findTemplatesInFolder($dir)
  78.     {
  79.         $templates = [];
  81.         if (is_dir($dir)) {
  82.             $finder = new Finder();
  83.             foreach ($finder->files()->followLinks()->in($dir) as $file) {
  84.                 $template = $this->parser->parse($file->getRelativePathname());
  85.                 if (false !== $template) {
  86.                     $templates[] = $template;
  87.                 }
  88.             }
  89.         }
  91.         return $templates;
  92.     }
  94.     /**
  95.      * Find templates in the given bundle.
  96.      *
  97.      * @param BundleInterface $bundle The bundle where to look for templates
  98.      *
  99.      * @return TemplateReferenceInterface[]
  100.      */
  101.     private function findTemplatesInBundle(BundleInterface $bundle)
  102.     {
  103.         $name = $bundle->getName();
  104.         $templates = array_unique(array_merge(
  105.             $this->findTemplatesInFolder($bundle->getPath().'/Resources/views'),
  106.             $this->findTemplatesInFolder($this->rootDir.'/'.$name.'/views')
  107.         ));
  109.         foreach ($templates as $i => $template) {
  110.             $templates[$i] = $template->set('bundle', $name);
  111.         }
  113.         return $templates;
  114.     }
  115. }