vendor/symfony/framework-bundle/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 FileLocatorInterface $locator  A FileLocatorInterface instance
  35.      * @param string               $cacheDir The cache path
  36.      */
  37.     public function __construct(FileLocatorInterface $locator, string $cacheDir = null)
  38.     {
  39.         if (null !== $cacheDir && file_exists($cache = $cacheDir.'/templates.php')) {
  40.             $this->cache = require $cache;
  41.         }
  43.         $this->locator = $locator;
  44.     }
  46.     /**
  47.      * Returns a full path for a given file.
  48.      *
  49.      * @return string The full path for the file
  50.      */
  51.     protected function getCacheKey($template)
  52.     {
  53.         return $template->getLogicalName();
  54.     }
  56.     /**
  57.      * Returns a full path for a given file.
  58.      *
  59.      * @param TemplateReferenceInterface $template    A template
  60.      * @param string                     $currentPath Unused
  61.      * @param bool                       $first       Unused
  62.      *
  63.      * @return string The full path for the file
  64.      *
  65.      * @throws \InvalidArgumentException When the template is not an instance of TemplateReferenceInterface
  66.      * @throws \InvalidArgumentException When the template file can not be found
  67.      */
  68.     public function locate($template, $currentPath = null, $first = true)
  69.     {
  70.         if (!$template instanceof TemplateReferenceInterface) {
  71.             throw new \InvalidArgumentException('The template must be an instance of TemplateReferenceInterface.');
  72.         }
  74.         $key = $this->getCacheKey($template);
  76.         if (isset($this->cacheHits[$key])) {
  77.             return $this->cacheHits[$key];
  78.         }
  79.         if (isset($this->cache[$key])) {
  80.             return $this->cacheHits[$key] = realpath($this->cache[$key]) ?: $this->cache[$key];
  81.         }
  83.         try {
  84.             return $this->cacheHits[$key] = $this->locator->locate($template->getPath(), $currentPath);
  85.         } catch (\InvalidArgumentException $e) {
  86.             throw new \InvalidArgumentException(sprintf('Unable to find template "%s" : "%s".', $template, $e->getMessage()), 0, $e);
  87.         }
  88.     }
  89. }