vendor/symfony/twig-bundle/Loader/FilesystemLoader.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\TwigBundle\Loader;
  14. @trigger_error('The '.FilesystemLoader::class.' class is deprecated since version 4.3 and will be removed in 5.0; use Twig notation for templates instead.', E_USER_DEPRECATED);
  16. use Symfony\Component\Config\FileLocatorInterface;
  17. use Symfony\Component\Templating\TemplateNameParserInterface;
  18. use Symfony\Component\Templating\TemplateReferenceInterface;
  19. use Twig\Error\LoaderError;
  20. use Twig\Loader\FilesystemLoader as BaseFilesystemLoader;
  22. /**
  23.  * FilesystemLoader extends the default Twig filesystem loader
  24.  * to work with the Symfony paths and template references.
  25.  *
  26.  * @author Fabien Potencier <fabien@symfony.com>
  27.  *
  28.  * @deprecated since version 4.3, to be removed in 5.0; use Twig notation for templates instead.
  29.  */
  30. class FilesystemLoader extends BaseFilesystemLoader
  31. {
  32.     protected $locator;
  33.     protected $parser;
  35.     /**
  36.      * @param string|null $rootPath The root path common to all relative paths (null for getcwd())
  37.      */
  38.     public function __construct(FileLocatorInterface $locator, TemplateNameParserInterface $parser, string $rootPath = null)
  39.     {
  40.         parent::__construct([], $rootPath);
  42.         $this->locator = $locator;
  43.         $this->parser = $parser;
  44.     }
  46.     /**
  47.      * {@inheritdoc}
  48.      *
  49.      * The name parameter might also be a TemplateReferenceInterface.
  50.      *
  51.      * @return bool
  52.      */
  53.     public function exists($name)
  54.     {
  55.         return parent::exists((string) $name);
  56.     }
  58.     /**
  59.      * Returns the path to the template file.
  60.      *
  61.      * The file locator is used to locate the template when the naming convention
  62.      * is the symfony one (i.e. the name can be parsed).
  63.      * Otherwise the template is located using the locator from the twig library.
  64.      *
  65.      * @param string|TemplateReferenceInterface $template The template
  66.      * @param bool                              $throw    When true, a LoaderError exception will be thrown if a template could not be found
  67.      *
  68.      * @return string The path to the template file
  69.      *
  70.      * @throws LoaderError if the template could not be found
  71.      */
  72.     protected function findTemplate($template, $throw = true)
  73.     {
  74.         $logicalName = (string) $template;
  76.         if (isset($this->cache[$logicalName])) {
  77.             return $this->cache[$logicalName];
  78.         }
  80.         $file = null;
  81.         try {
  82.             $file = parent::findTemplate($logicalName);
  83.         } catch (LoaderError $e) {
  84.             $twigLoaderException = $e;
  86.             // for BC
  87.             try {
  88.                 $template = $this->parser->parse($template);
  89.                 $file = $this->locator->locate($template);
  90.             } catch (\Exception $e) {
  91.             }
  92.         }
  94.         if (false === $file || null === $file) {
  95.             if ($throw) {
  96.                 throw $twigLoaderException;
  97.             }
  99.             return null;
  100.         }
  102.         return $this->cache[$logicalName] = $file;
  103.     }
  104. }