vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/Templating/Loader/TemplateLocator.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\Templating\Loader;
  14. @trigger_error('The '.TemplateLocator::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\Config\FileLocatorInterface;
  17. use Symfony\Component\Templating\TemplateReferenceInterface;
  19. /**
  20.  * TemplateLocator locates templates in bundles.
  21.  *
  22.  * @author Fabien Potencier <fabien@symfony.com>
  23.  *
  24.  * @deprecated since version 4.3, to be removed in 5.0; use Twig instead.
  25.  */
  26. class TemplateLocator implements FileLocatorInterface
  27. {
  28.     protected $locator;
  29.     protected $cache;
  31.     private $cacheHits = [];
  33.     /**
  34.      * @param string $cacheDir The cache path
  35.      */
  36.     public function __construct(FileLocatorInterface $locator, string $cacheDir = null)
  37.     {
  38.         if (null !== $cacheDir && file_exists($cache = $cacheDir.'/templates.php')) {
  39.             $this->cache = require $cache;
  40.         }
  42.         $this->locator = $locator;
  43.     }
  45.     /**
  46.      * Returns a full path for a given file.
  47.      *
  48.      * @return string The full path for the file
  49.      */
  50.     protected function getCacheKey($template)
  51.     {
  52.         return $template->getLogicalName();
  53.     }
  55.     /**
  56.      * Returns a full path for a given file.
  57.      *
  58.      * @param TemplateReferenceInterface $template    A template
  59.      * @param string                     $currentPath Unused
  60.      * @param bool                       $first       Unused
  61.      *
  62.      * @return string The full path for the file
  63.      *
  64.      * @throws \InvalidArgumentException When the template is not an instance of TemplateReferenceInterface
  65.      * @throws \InvalidArgumentException When the template file can not be found
  66.      */
  67.     public function locate($template, $currentPath = null, $first = true)
  68.     {
  69.         if (!$template instanceof TemplateReferenceInterface) {
  70.             throw new \InvalidArgumentException('The template must be an instance of TemplateReferenceInterface.');
  71.         }
  73.         $key = $this->getCacheKey($template);
  75.         if (isset($this->cacheHits[$key])) {
  76.             return $this->cacheHits[$key];
  77.         }
  78.         if (isset($this->cache[$key])) {
  79.             return $this->cacheHits[$key] = realpath($this->cache[$key]) ?: $this->cache[$key];
  80.         }
  82.         try {
  83.             return $this->cacheHits[$key] = $this->locator->locate($template->getPath(), $currentPath);
  84.         } catch (\InvalidArgumentException $e) {
  85.             throw new \InvalidArgumentException(sprintf('Unable to find template "%s": ', $template).$e->getMessage(), 0, $e);
  86.         }
  87.     }
  88. }