Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FrameworkBundle] added a cache warmer to pre-compute template paths
To enable this cache warmer, you must add a "cache-warner" option
to app:templating:
<app:templating cache-warmer="true">- Loading branch information
Showing
5 changed files
with
159 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
94 changes: 94 additions & 0 deletions
94
src/Symfony/Bundle/FrameworkBundle/Templating/CacheWarmer/TemplatePathsCacheWarmer.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien.potencier@symfony-project.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Bundle\FrameworkBundle\Templating\CacheWarmer; | ||
|
|
||
| use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmer; | ||
| use Symfony\Component\HttpKernel\Kernel; | ||
| use Symfony\Component\Finder\Finder; | ||
|
|
||
| /** | ||
| * Computes the association between template names and their paths on the disk. | ||
| * | ||
| * @author Fabien Potencier <fabien.potencier@symfony-project.com> | ||
| */ | ||
| class TemplatePathsCacheWarmer extends CacheWarmer | ||
| { | ||
| protected $kernel; | ||
| protected $rootDir; | ||
|
|
||
| /** | ||
| * Constructor. | ||
| * | ||
| * @param Kernel $kernel A Kernel instance | ||
| * @param string $rootDir The directory where global templates can be stored | ||
| */ | ||
| public function __construct(Kernel $kernel, $rootDir) | ||
| { | ||
| $this->kernel = $kernel; | ||
| $this->rootDir = $rootDir; | ||
| } | ||
|
|
||
| /** | ||
| * Warms up the cache. | ||
| * | ||
| * @param string $cacheDir The cache directory | ||
| */ | ||
| public function warmUp($cacheDir) | ||
| { | ||
| $templates = $this->computeTemplatePaths(); | ||
|
|
||
| $this->writeCacheFile($cacheDir.'/templates.php', sprintf('<?php return %s;', var_export($templates, true))); | ||
| } | ||
|
|
||
| /** | ||
| * Checks whether this warmer is optional or not. | ||
| * | ||
| * @return Boolean always false | ||
| */ | ||
| public function isOptional() | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| protected function computeTemplatePaths() | ||
| { | ||
| $prefix = '/Resources/views'; | ||
| $templates = array(); | ||
| foreach ($this->kernel->getBundles() as $name => $bundle) { | ||
| if (!is_dir($dir = $bundle->getPath().$prefix)) { | ||
| continue; | ||
| } | ||
|
|
||
| $finder = new Finder(); | ||
| foreach ($finder->files()->followLinks()->name('*.twig')->in($dir) as $file) { | ||
| list($category, $template) = $this->parseTemplateName($file, $prefix.'/'); | ||
| $name = sprintf('%s:%s:%s', $bundle->getName(), $category, $template); | ||
| $resource = '@'.$bundle->getName().$prefix.'/'.$category.'/'.$template; | ||
|
|
||
| $templates[$name] = $this->kernel->locateResource($resource, $this->rootDir); | ||
| } | ||
| } | ||
|
|
||
| return $templates; | ||
| } | ||
|
|
||
| protected function parseTemplateName($file, $prefix) | ||
| { | ||
| $path = $file->getPathname(); | ||
|
|
||
| list(, $tmp) = explode($prefix, $path, 2); | ||
| $parts = explode('/', strtr($tmp, '\\', '/')); | ||
| $template = array_pop($parts); | ||
|
|
||
| return array(implode('/', $parts), $template); | ||
| } | ||
| } |
42 changes: 42 additions & 0 deletions
42
src/Symfony/Bundle/FrameworkBundle/Templating/Loader/CachedTemplateLocator.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien.potencier@symfony-project.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Bundle\FrameworkBundle\Templating\Loader; | ||
|
|
||
| /** | ||
| * | ||
| * @author Fabien Potencier <fabien.potencier@symfony-project.com> | ||
| */ | ||
| class CachedTemplateLocator implements TemplateLocatorInterface | ||
| { | ||
| protected $templates; | ||
|
|
||
| /** | ||
| * Constructor. | ||
| */ | ||
| public function __construct($cacheDir) | ||
| { | ||
| if (!file_exists($cache = $cacheDir.'/templates.php')) { | ||
| throw new \RuntimeException(sprintf('The template locator cache is not warmed up (%s).', $cache)); | ||
| } | ||
|
|
||
| $this->templates = require $cache; | ||
| } | ||
|
|
||
| public function locate($name) | ||
| { | ||
| if (!isset($this->templates[$name])) { | ||
| throw new \InvalidArgumentException(sprintf('Unable to find template "%s".', $name)); | ||
| } | ||
|
|
||
| return $this->templates[$name]; | ||
| } | ||
| } |