vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/Templating/Loader/TemplateLocator.php line 80

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